Skip to content

Breakout Requests Functionality to New Adapter Module #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 19, 2018
Merged

Breakout Requests Functionality to New Adapter Module #223

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
81c6fe1
Include class constructors with autodoc modules
Jul 16, 2018
2e36e8a
add breaking changes section
Jul 16, 2018
8bc0c97
Add adapters and utils modules
Jul 16, 2018
203fc10
Move client class to use adapters.Request
Jul 16, 2018
3fffbe1
Merge remote-tracking branch 'upstream/master' into adapter_pattern
Jul 16, 2018
3df8412
Expand raise_for_error docstring
Jul 16, 2018
1e57318
Clarify purpose of newly added sphinx conf skip() method
Jul 16, 2018
2dd7117
Fewer line breaks
Jul 16, 2018
7d289a6
Clarify language
Jul 16, 2018
e4c49cf
Add initial guide/documentation around new adapter module
Jul 18, 2018
04116de
Migrate last requests call out of Client class and into aws_utils
Jul 18, 2018
3a92e78
Update put call in recently added read_lease method
Jul 18, 2018
4828420
versionadded notes and link to requests module
Jul 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add initial guide/documentation around new adapter module
  • Loading branch information
Jeffrey Hogan committed Jul 18, 2018
commit e4c49cfee2523c222d609b17082ae01cdf34e540
7 changes: 7 additions & 0 deletions docs/advanced_usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Advanced Usage
==============

Custom Requests / HTTP Adapter
------------------------------

In hvac version 0.6.3, calls to the requests module (which provides the methods hvac utilizes to send HTTP/HTTPS request to Vault instances) were extracted from the :class:`Client <hvac.v1.Client>` class and moved to a newly added :meth:`hvac.adapters` module. The :class:`Client <hvac.v1.Client>` class itself defaults to an instance of the :class:`Request <hvac.adapters.Request>` class for its :attr:`_adapter <hvac.v1.Client._adapter>` private attribute attribute if no adapter argument is provided to its :meth:`constructor <hvac.v1.Client.__init__>`. This attribute provides an avenue for modifying the manner in which hvac completes request. To enable this type of customization, implement a class of type :meth:`hvac.adapters.Adapter`, override its abstract methods, and pass an instance of this custom class to the adapter argument of the :meth:`Client constructor <hvac.v1.Client.__init__>`
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Source code repository hosted at `github.com/ianunruh/hvac`_.

Readme <readme>
Examples <examples/examples>
advanced_usage
source/hvac
contributing
changelog
Expand Down