universal-pathlib

What's Changed

• build(deps-dev): bump the pip-dependencies group with 2 updates by @dependabot[bot] in #501
• DOC: describe UPath/s3fs behavior with is_dir() by @lagamura in #503
• Do not hardcode Python executable name by @avalentino in #504
• tests: remove two unused helper functions introduced in #492 by @ap-- in #505
• Fix iterdir behaviour when raising NotADirectory for all UPath subclasses by @ap-- in #506
• Fix error behavior for the hardlink_to backport and symlink_to for upath.extensions by @ap-- in #508
• Fix GitHub tests without a network connection by @QuLogic in #509
• tests: split base test cases into joinable/readable/writable tests by @ap-- in #507
• upath.extensions: fix is_relative_to for extensions by @ap-- in #510
• Add missing pathlib abc tests by @ap-- in #511
• Split test suite according to abcs by @ap-- in #513
• Fix upath core touch by @ap-- in #515
• Handover fs instance in UPath.with_segments() if possible by @ap-- in #516
• Fix DataPath error handling for unsupported methods by @ap-- in #517
• Fix HTTPPath error handling for unsupported methods by @ap-- in #518
• upath.implementations.tar: fix error handling for write methods by @ap-- in #519
• upath.implementations.zip: disable write mode in universal-pathlib by @ap-- in #520
• upath.implementations.cloud: fix error handling on HfPath by @ap-- in #521
• upath.implementations.github: adjust GitHubPath error reporting by @ap-- in #522
• Refactor and cleanup test suite by @ap-- in #514
• tests: xfail on name resolution error in github suite by @ap-- in #523
• Fix behaviour of UPath.parent and UPath.parents by @ap-- in #529
• Adjust behavior of UPath.copy and UPath.copy_into with str and Path targets by @ap-- in #530
• Fix S3Path copy to Local: name collision of file / dir by @ap-- in #533
• cut release 0.3.8 by @ap-- in #534

New Contributors

• @lagamura made their first contribution in #503
• @avalentino made their first contribution in #504
• @QuLogic made their first contribution in #509

Full Changelog: v0.3.7...v0.3.8

What's Changed

• Fix typing example in README by @mmwinther in #484
• add FTPPath implementation by @ap-- in #485
• upath: fix maintainer display on pypi by @ap-- in #486
• Catch and assert warnings in tests by @ap-- in #487
• Fix trailing slash behavior by @ap-- in #488
• Tests without network connection by @ap-- in #492
• Require .cwd() for relative paths in .rename() by @ap-- in #493
• Fix MemoryPath root by @ap-- in #495
• upath.core: deprecate keyword arguments for UPath.rename() by @ap-- in #496

New Contributors

• @mmwinther made their first contribution in #484

Full Changelog: v0.3.6...v0.3.7

What's Changed

Added

• upath: add UnsupportedOperation exception for better pathlib compatibility (#474)
• upath: backport pathlib 3.10-3.14 method signatures (follow_symlinks, newline, case_sensitive, recurse_symlinks, walk_up, etc.) (#476)
• docs: add ProxyUPath usage example (#475)
• tests: add comprehensive pathlib backport signature tests (#474, #476, #477)

Fixed

• upath.types: correct st_birthtime and st_birthtime_ns availability (Windows 3.12+, macOS, FreeBSD only) (#476, #477)
• upath: fix stat() return type to use StatResultType protocol (#476)
• upath: fix equality checks for extensions and local paths (#477)
• upath.implementations.local: fix _copy_from method (#477)
• upath.core: remove unneeded lines in _fs_factory (#478)

Changed

• upath.core: raise TypeError when creating UPath with incompatible protocols (#477)

Full Changelog: v0.3.5...v0.3.6

What's Changed

• Add upath.implementations.cloud.HfPath by @lhoestq in #457
• Fix relative_to for simplecache, smb, sftp and extensions by @ap-- in #458
• documentation on Read the docs by @ap-- in #468
• readme: add docs badge by @ap-- in #469
• Nox and ci updates by @ap-- in #466
• update flavours by @dependabot[bot] in #467

New Contributors

• @lhoestq made their first contribution in #457

Full Changelog: v0.3.4...v0.3.5

What's Changed

• Add full simplecache protocol support by @ap-- in #453
• support JSON schema generation by @pmeier in #451
• build(deps): bump pathlib-abc from 0.5.1 to >=0.5.1,<0.6.0 by @dependabot[bot] in #450
• upath.core: deprecate _protocol_dispatch=False by @ap-- in #454

Full Changelog: v0.3.3...v0.3.4

What's Changed

• Add upath.implementations.zip.ZipPath by @ap-- in #442
• Add upath.implementations.tar.TarPath by @ap-- in #443
• Support chaining for zip and tar paths by @ap-- in #440
• upath.core: remove chain_parser from overloads for upath class narrowing by @ap-- in #436
• Cut release 0.3.3 by @ap-- in #447

Full Changelog: v0.3.2...v0.3.3

What's Changed

Added

• upath.types: add storage_options submodule with TypedDict classes for all filesystem implementations (#432)
• upath.implementations: add storage_options type annotations to all UPath subclass constructors (#432)
• upath: add type overloads to narrow UPath type based on protocol parameter (#431)
• upath.registry: add overloads to get_upath_class() to return correct subclass type based on protocol (#429)
• typesafety: add comprehensive tests for storage_options type checking (#432)
• typesafety: add tests for protocol-based type narrowing (#429, #431)

Fixed

• upath: fix chained paths .path property to return correct normalized paths (#426)
• upath.implementations: correct .path normalization for cloud and http paths (#426)
• upath._protocol: raise error when explicitly requesting empty protocol but another protocol is found (#430)
• upath.core: adjust Pydantic v2 schema to support None protocol (#430)
• tests: add xfail when hitting GitHub rate limit (#429)

Full Changelog: v0.3.1...v0.3.2

What's Changed

• UPath implement .info by @ap-- in #416
• Stricter upath types and remove Compat* protocol by @ap-- in #417
• Fix type annotations for upath.core, upath.extensions and upath.implementations by @ap-- in #420
• Backport types and methods to local by @ap-- in #421
• typesafety: add thorough typechecks to UPath interface by @ap-- in #414
• Upath add move into by @ap-- in #422
• Upath add from_uri by @ap-- in #423
• Chore license and ci permissions by @ap-- in #424
• Cut release 0.3.1 by @ap-- in #425

Full Changelog: v0.3.0...v0.3.1

What's Changed

Fixed

• upath: support relative paths (#405)
• upath: implement chain functionality (#346)
• upath: fix upath suffixes (#407)
• upath: update flavours (#350, #351, #400, #403, #411)
• upath: fix GH test skipping (#361)
• ci: update ubuntu runners (#359)
• ci: address skip_existing deprecation (#369)
• tests: split protocol mismatch test (#365)
• tests: ensure non-local upaths raise with builtin open (#368)
• tests: add an xfail test for // behaviour on s3 (#370)
• tests: fix xfail call args (#409)
• tests: add a os.PathLike test (#410)

Added

• upath: api extensions via upath.extensions.ProxyUPath (#372)
• upath: add upath.types in preparation for deriving from pathlib-abc (#364)
• upath: add optional support for pydantic (#395) thanks @pmeier 🙏 ❤️
• upath: list late registered protocols (#358)
• repo: add a security policy (#327)
• ci: start running against 3.14 (#363)

Changed

• upath: inherit from pathlib_abc.ReadablePath and pathlib_abc.WritablePath (#366, #402, #404)
• upath: drop Python 3.8 (#360)
• upath: remove deprecated accessor support (#362)

New Contributors

• @pmeier made their first contribution in https://github.com/fsspec/universal_pathlib/pull/395

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.6...v0.3.0

What's Changed

• Fix: ensure typing_extension is dependency for earlier python versions by @mgxd in https://github.com/fsspec/universal_pathlib/pull/290
• Fix sftp join issue for non-root prefixed paths by @ap-- in https://github.com/fsspec/universal_pathlib/pull/294
• Fix: Add support for abfss protocol by @jslorrma in https://github.com/fsspec/universal_pathlib/pull/311
• Added: expanduser no-op by @ollie-bell in https://github.com/fsspec/universal_pathlib/pull/293
• tests: minor fixes for tests by @ap-- in https://github.com/fsspec/universal_pathlib/pull/312
• tests: allow configuring smb port via env var by @ap-- in https://github.com/fsspec/universal_pathlib/pull/314
• tests: reenable py3.13 tests on windows by @ap-- in https://github.com/fsspec/universal_pathlib/pull/295
• ci: switch to trusted publishing by @ap-- in https://github.com/fsspec/universal_pathlib/pull/320
• Update flavours by @ap-- in https://github.com/fsspec/universal_pathlib/pull/285, https://github.com/fsspec/universal_pathlib/pull/299, https://github.com/fsspec/universal_pathlib/pull/313, https://github.com/fsspec/universal_pathlib/pull/319

New Contributors

• @mgxd made their first contribution in https://github.com/fsspec/universal_pathlib/pull/290
• @ollie-bell made their first contribution in https://github.com/fsspec/universal_pathlib/pull/293
• @jslorrma made their first contribution in https://github.com/fsspec/universal_pathlib/pull/311

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.5...v0.2.6

What's Changed

• Bump dvc from 3.55.1 to 3.55.2 by @dependabot in https://github.com/fsspec/universal_pathlib/pull/273
• upath.implementations.cloud: move empty bucket checks to subclasses by @ap-- in https://github.com/fsspec/universal_pathlib/pull/277
• Enable windows local tests by @ap-- in https://github.com/fsspec/universal_pathlib/pull/278
• Support python 3.13 by @ap-- in https://github.com/fsspec/universal_pathlib/pull/275

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.4...v0.2.5

What's Changed

Added

• Add SFTPPath implementation by @ap-- in https://github.com/fsspec/universal_pathlib/pull/265

Fixed

• Fix UPath.rename type signature by @ap-- in https://github.com/fsspec/universal_pathlib/pull/258
• Prevent SMBPath.rename warnings when using defaults by @ap-- in https://github.com/fsspec/universal_pathlib/pull/259
• Update moto[s3,server] remove upper version bound by @dependabot in https://github.com/fsspec/universal_pathlib/pull/248
• Implement UPath.samefile by @ap-- in https://github.com/fsspec/universal_pathlib/pull/261
• Fix touch exists_ok if file exists by @ap-- in https://github.com/fsspec/universal_pathlib/pull/262
• tests: add test for mkdir with existing gcs bucket by @ap-- in https://github.com/fsspec/universal_pathlib/pull/263
• UPath.joinpath raise error on protocol mismatch by @ap-- in https://github.com/fsspec/universal_pathlib/pull/264
• tests: fix xpass test in http tests by @ap-- in https://github.com/fsspec/universal_pathlib/pull/266
• Silence various warnings in tests by @ap-- in https://github.com/fsspec/universal_pathlib/pull/267

Changed

• Move from setup.cfg to pyproject.toml by @ap-- in https://github.com/fsspec/universal_pathlib/pull/260
• allow upath lstat by @ap-- in https://github.com/fsspec/universal_pathlib/pull/271
• upath: update flavours by @ap-- in https://github.com/fsspec/universal_pathlib/pull/272

New Contributors

• @dependabot made their first contribution in https://github.com/fsspec/universal_pathlib/pull/248

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.3...v0.2.4

What's Changed

Added

• Add st_birthtime as standard field by @tehunter in https://github.com/fsspec/universal_pathlib/pull/254
• implement SMBPath and tests by @tharwan in https://github.com/fsspec/universal_pathlib/pull/219
• Add typesafety checks by @ap-- in https://github.com/fsspec/universal_pathlib/pull/212

Fixed

• upath._flavour_sources: update flavours by @ap-- in https://github.com/fsspec/universal_pathlib/pull/224
• README: fix link to filesystem spec extra optionnal dependencies by @petrus-v in https://github.com/fsspec/universal_pathlib/pull/232
• upath._flavour: fix path parsing for HttpPath on Python3.12 by @ap-- in https://github.com/fsspec/universal_pathlib/pull/236
• Fix UPath.rename for absolute paths by @Koncopd in https://github.com/fsspec/universal_pathlib/pull/225
• upath: fix is_absolute on <3.12 by @ap-- in https://github.com/fsspec/universal_pathlib/pull/256

New Contributors

• @tharwan made their first contribution in https://github.com/fsspec/universal_pathlib/pull/219
• @petrus-v made their first contribution in https://github.com/fsspec/universal_pathlib/pull/232
• @Koncopd made their first contribution in https://github.com/fsspec/universal_pathlib/pull/225
• @tehunter made their first contribution in https://github.com/fsspec/universal_pathlib/pull/254

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.2...v0.2.3

What's Changed

Fixed

• upath: imports of filesystem classes are now lazy by @ap-- in https://github.com/fsspec/universal_pathlib/pull/200
• docs: fixed entrypoint examples for UPath subclass registration by @joouha in https://github.com/fsspec/universal_pathlib/pull/196
• upath: fixed comparison __eq__ with pathlib.Path on py<3.12 by @ap-- in https://github.com/fsspec/universal_pathlib/pull/203
• upath: open() now passes fsspec options through to fsspec by @ap-- in https://github.com/fsspec/universal_pathlib/pull/204
• upath: fixed regression for args that implement __fspath__ different from __str__ by @ap-- in https://github.com/fsspec/universal_pathlib/pull/200

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.1...v0.2.2

What's Changed

Added

• Implement UPath.joinuri by @ap-- in https://github.com/fsspec/universal_pathlib/pull/189

Fixed

• Fix UPath.__hash__ by @ap-- in https://github.com/fsspec/universal_pathlib/pull/188
• upath.implementations.local: remove dependency on packaging by @ap-- in https://github.com/fsspec/universal_pathlib/pull/187
• Added missing classifiers by @ap-- in https://github.com/fsspec/universal_pathlib/pull/192

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.2.0...v0.2.1

What's Changed

Added

• upath: support Python 3.12 by @ap-- (#152)
• upath: improved subclass customization options by @ap-- (#173)
• upath: support local uri scheme by @glesperance (#150)
• upath: added GitHubPath by @juftin (#155)
• upath: added DataPath for data uris by @joouha (#169)

Changed

• tests: xfail tests if optional dependency is missing by @ap-- (#160)

Fixed

• fixed netloc handling of memory://netloc/a/b style uris by @ap-- (#162)
• fixed broken mkdir for cloud filesystems by @ap-- (#177)
• fixed UPath().stat() now returns a os.stat_result-like object by @ap-- (#179)

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.1.4...v0.2.0

[0.1.4]

Changed

• upath: require fsspec>=2022.1.0 (#148).

Fixed

• upath.implementation.local: fixes _kwargs in local sub paths (#158).
• upath: fix iterdir trailing slash (#149).
• upath: consistent glob behaviour for "**" patterns (#143).

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.1.3...v0.1.4

[0.1.3]

Fixed

• upath: restore compatibility with fsspec<2022.03.0 in line with setup.cfg (#139).

Added

• upath.registry: provide available_implementations() and register_implementation() #134
• upath: add UPath.storage_options and UPath.protocol #135

Fixed

• upath: fix UPath.as_uri() #133

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.1.1...v0.1.2

Fixed

• restore ._kwargs and ._url on PosixUPath and WindowsUPath subclasses (#131).
• tests: fixed and refactored core tests (#130).

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.1.0...v0.1.1 Manually Curated Changelog: https://github.com/fsspec/universal_pathlib/blob/main/CHANGELOG.md

Changed

• changed UPath.__new__ behavior to return UPath subclasses for local paths (#125).
• updated past changelog entries.

Fixed

• improved azure test separation (#123).

Added

• tests to confirm pydantic BaseSettings behavior (#127).

Full Changelog: https://github.com/fsspec/universal_pathlib/compare/v0.0.24...v0.1.0 Manually Curated Changelog: https://github.com/fsspec/universal_pathlib/blob/main/CHANGELOG.md

[0.0.24] - 2023-06-19

Added

• started a changelog to keep track of significant changes (#118).
• add support for abfss protocol (#113).
• add cpython pathlib tests (#104).
• implemented .rename (#96).

Fixed

• various webdav test fixes (#103, #107, #109).
• fixed issue with ._url parsing (#102).
• improved error messages (#96).
• fixed .rglob() method (#96).

Changed

• modernized package dev tools (#105).
• updated ipynb example notebook (#96).

• Implements UPath.resolve with a special redirect-following implementation for HTTPPath. Fixes issues with double and trailing slashes as well as normalizes . and .. parts in URI paths. #86

Thanks to @joouha!

• Respect exist_ok in mkdir when creating parent directories #83

Thanks to @rahuliyer95!

• Changed the UPath implementation registry to lazily import implementations #78
• Fixed S3 paths with a + #76
• Refactored class methods #77

Thanks to @ap--!

• Python 3.11 compatibility
• Fix .parents
• Fix .with_* methods
• Use NotADirectoryError instead of custom error

Thanks to @ap-- and @jorenretel

Adds support for Azure cloud storage via AzurePath

• Fixed subclassing behavior of UPath #56
• Added copy-constructor #52
• Added default implementations for is_* methods #53

Added support for Python 3.10 #43. Thanks @ap--!

Adds ability for UPath to be serialized with pickle.

• Consolodates UniversalPath and UPath #32
• Adds GCSPath implimentation #40

fixes subclassing and isinstance issues. see issues #25, #26, #28

fixes issue with S3Path.joinpath

fixes errors with last version