-
-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* bump to release version * add botocore update readme
- Loading branch information
Showing
3 changed files
with
43 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
botocore | ||
======== | ||
|
||
|
||
Background and Implementation | ||
------------- | ||
aiobotocore adds async functionality to botocore by replacing certain critical | ||
methods in botocore classes with async versions. The best way to see how this | ||
works is by working backwards from `AioEndpoint._request`. Because of this tight | ||
integration aiobotocore is typically version locked to a particular release of | ||
botocore. | ||
|
||
How to upgrade botocore | ||
------------- | ||
aiobotocore's file names try to match the botocore files they functionally match. | ||
For the most part botocore classes are sub-classed with the majority of the | ||
botocore calls eventually called...however certain methods like | ||
`PageIterator.next_page` had to be re-implemented so watch for changes in those | ||
types of methods. | ||
|
||
The best way I've seen to upgrade botocore support is by downloading the sources | ||
of the release of botocore you're trying to upgrade to, and the version | ||
of botocore that aiobotocore is currently locked to and do a folder based file | ||
comparison (tools like DiffMerge are nice). You can then manually apply the | ||
relevant changes to their aiobotocore equivalent(s). | ||
|
||
Notable changes we've seen in the past: | ||
|
||
* new parameters added | ||
* classes being moved to new files | ||
* bodies of methods being updated | ||
|
||
basically your typical code refactoring :) | ||
|
||
The Future | ||
------------- | ||
The long term goal is that botocore will implement async functionality directly. | ||
See botocore issue: https://github.com/boto/botocore/issues/458 for details, | ||
tracked in aiobotocore here: https://github.com/aio-libs/aiobotocore/issues/36 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
from .session import get_session, AioSession | ||
|
||
__version__ = '0.2.0a0' | ||
__version__ = '0.2.0' | ||
(get_session, AioSession) # make pyflakes happy |