- API change: Make
stat
on base class method instead of property to followpathlib
(Issue #234, PR #250) - Fixed "S3Path.exists() returns True on partial matches." (Issue #208, PR #244)
- Make
AnyPath
subclass ofAnyPath
(Issue #246, PR #251) - Skip docstrings if not present to avoid failing under
-00
(Issue #238, PR #249) - Add
py.typed
file so mypy runs (Issue #243, PR #248)
- Added
absolute
toCloudPath
(does nothing asCloudPath
is always absolute) (PR #230) - Added
resolve
toCloudPath
(does nothing asCloudPath
is resolved in advance) (Issue #151, PR #230) - Added
relative_to
toCloudPath
which returns aPurePosixPath
(Issue #149, PR #230) - Added
is_relative_to
toCloudPath
(Issue #149, PR #230) - Added
is_absolute
toCloudPath
(always true asCloudPath
is always absolute) (PR #230) - Accept and delegate
read_text
parameters to cached file (PR #230) - Added
exist_ok
parameter totouch
(PR #230) - Added
missing_ok
parameter tounlink
, which defaults to True. This diverges from pathlib to maintain backward compatibility (PR #230) - Fixed missing root object entries in documentation's Intersphinx inventory (Issue #211, PR #237)
- Fixed pickling of
CloudPath
objects not working. (Issue #223, PR #224) - Added functionality to [push the MIME (media) type to the content type property on cloud providers by default. (Issue #222, PR #226)
- Fixed inadvertent inclusion of tests module in package. (Issue #173, PR #219)
- Fixed
glob
andrglob
functions by using pathlib's globbing logic rather than fnmatch. (Issue #154) - Fixed
iterdir
to not include self. (Issue #15) - Fixed error when calling
suffix
andsuffixes
on a cloud path with no suffix. (Issue #120) - Changed
parents
return type from list to tuple, to better match pathlib's tuple-like_PathParents
return type. - Remove support for Python 3.6. Issue #186
- Fixed error when "directories" created on AWS S3 were reported as files. (Issue #148, PR #190)
- Fixed bug where GCE machines can instantiate default client, but we don't attempt it. (Issue #191
- Support
AWS_ENDPOINT_URL
environment variable to set theendpoint_url
forS3Client
. (PR #193)
- Fixed error where
BlobProperties
type hint causes import error if Azure dependencies not installed.
- Fixed error when using
rmtree
on nested directories for Google Cloud Storage and Azure Blob Storage. (Issue #184, PR #185) - Fixed broken builds due mypy errors in azure dependency (PR #177)
- Fixed dev tools for building and serving documentation locally (PR #178)
- Fixed error when importing
cloudpathlib
for missingbotocore
dependency when not installed with S3 dependencies. (PR #168)
- Fixed absolute documentation URLs to point to the new versioned documentation pages.
- Fixed bug where
no_sign_request
couldn't be used to download files since our code required list permissions to the bucket to do so. (Issue #169, PR #168).
- Added
no_sign_request
parameter toS3Client
instantiation for anonymous requests for public resources on S3. See documentation for more details. (#164)
- Added
boto3_transfer_config
parameter toS3Client
instantiation, which allows passing aboto3.s3.transfer.TransferConfig
object and is useful for controlling multipart and thread use in uploads and downloads. See documentation for more details. (#150)
- Added support for custom S3-compatible object stores. This functionality is available via the
endpoint_url
keyword argument when instantiating anS3Client
instance. See documentation for more details. (#138 thanks to @YevheniiSemendiak) - Added
CloudPath.upload_from
which uploads the passed path to this CloudPath (issuse #58) - Added support for common file transfer functions based on
shutil
. Issue #108. PR #142.CloudPath.copy
copy a file from one location to another. Can be cloud -> local or cloud -> cloud. Ifclient
is not the same, the file transits through the local machine.CloudPath.copytree
reucrsively copy a directory from one location to another. Can be cloud -> local or cloud -> cloud. UsesCloudPath.copy
so ifclient
is not the same, the file transits through the local machine.
- Added rich comparison operator support to cloud paths, which means you can now use them with
sorted
. (#129) - Added polymorphic class
AnyPath
which creates a cloud path orpathlib.Path
instance appropriately for an input filepath. See new documentation for details and example usage. (#130) - Added integration with Pydantic. See new documentation for details and example usage. (#130)
- Exceptions: (#131)
- Changed all custom
cloudpathlib
exceptions to be located in newcloudpathlib.exceptions
module. - Changed all custom
cloudpathlib
exceptions to subclass from new baseCloudPathException
. This allows for easy catching of any custom exception fromcloudpathlib
. - Changed all custom exceptions names to end with
Error
as recommended by PEP 8. - Changed various functions to throw new
CloudPathFileExistsError
,CloudPathIsADirectoryError
orCloudPathNotADirectoryError
exceptions instead of a genericValueError
. - Removed exception exports from the root
cloudpathlib
package namespace. Import fromcloudpathlib.exceptions
instead if needed.
- Changed all custom
- Fixed
download_to
method to handle case when source is a file and destination is a directory. (#121 thanks to @genziano) - Fixed bug where
hash(...)
of a cloud path was not consistent with the equality operator. (#129) - Fixed
AzureBlobClient
instantiation to throw new errorMissingCredentialsError
when no credentials are provided, instead ofAttributeError
.LocalAzureBlobClient
has also been changed to accordingly error under those conditions. (#131) - Fixed
GSClient
to instantiate as anonymous with public access only when instantiated with no credentials, instead of erroring. (#131)
- Added a new module
cloudpathlib.local
with utilities for mocking cloud paths in tests. The module has "Local" substitute classes that use the local filesystem in place of cloud storage. See the new documentation article "Testing code that uses cloudpathlib" to learn more about how to use them. (#107)
- Fixed bug where a
NameError
was raised if the Google Cloud Storage dependencies were not installed (even if using a different storage provider).
- Added support for Google Cloud Storage. Instantiate with URIs prefixed by
gs://
or explicitly using theGSPath
class. (#113 thanks to @wolfgangwazzlestrauss) - Changed backend logic to reduce number of network calls to cloud. This should result in faster cloud path operations, especially when dealing with many small files. (#110, #111)
- Fixed
CloudPath
instantiation so that reinstantiating with an existingCloudPath
instance will reuse the same client, if a new client is not explicitly passed. This addresses the edge case of non-idempotency when reinstantiating aCloudPath
instance with a non-default client. (#104)
- Fixed a character-encoding bug when building from source on Windows. (#98)
- Initial release of cloudpathlib with support for Amazon S3 and Azure Blob Storage! 🎉