Skip to content

Commit

Permalink
add doc changes for glob
Browse files Browse the repository at this point in the history
  • Loading branch information
liormizr committed Nov 9, 2024
1 parent 7c46c19 commit c1768d9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/advance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ To enable the old (pathlib common) Algorithm you can configure it like this:
>>> path = PureS3Path('/')
>>> register_configuration_parameter(path, glob_new_algorithm=False)
**Note: from version 0.6.0 glob implementation will work only with the new algorithm, there for the glob_new_algorithm arg is in depreciation cycle**

.. _pathlib : https://docs.python.org/3/library/pathlib.html
.. _boto3 : https://github.com/boto/boto3
Expand Down
11 changes: 9 additions & 2 deletions docs/interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,8 @@ In other words, it enables recursive globbing:
S3Path('/pypi-proxy/boto3/index.html'),
S3Path('/pypi-proxy/botocore/index.html')]
New in version 0.4.0:
In version 0.4.0:
New Algorithm that better suited to s3 API.
Especially for recursive searches.

Expand All @@ -169,6 +170,9 @@ To enable the old (pathlib common) Algorithm you can configure it like this:
register_configuration_parameter(path, glob_new_algorithm=False)
New version 0.6.0:
glob implementation will work only with the new algorithm, there for the glob_new_algorithm arg is in depreciation cycle

For more configuration details please see this `Advanced S3Path configuration`_

**NOTE:** Using the "**" pattern in large Buckets may consume an inordinate amount of time in the old algorithm.
Expand Down Expand Up @@ -325,10 +329,13 @@ This is like calling S3Path.glob_ with ``"**/"`` added in front of the given rel
S3Path('/pypi-proxy/index.html'),
S3Path('/pypi-proxy/botocore/index.html')]
New in version 0.4.0:
Version 0.4.0:
New Algorithm that better suited to s3 API.
Especially for recursive searches.

New version 0.6.0:
glob implementation will work only with the new algorithm, there for the glob_new_algorithm arg is in depreciation cycle

S3Path.rmdir()
^^^^^^^^^^^^^^

Expand Down
2 changes: 1 addition & 1 deletion s3path/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from pathlib import Path
from . import accessor

__version__ = '0.5.8'
__version__ = '0.6.0'
__all__ = (
'Path',
'register_configuration_parameter',
Expand Down

0 comments on commit c1768d9

Please sign in to comment.