pathlib-abc

Base classes for pathlib.Path-ish objects. Requires Python 3.8+.

This package is a preview of pathlib functionality planned for a future release of Python; specifically, it provides two ABCs that can be used to implement path classes for non-local filesystems, such as archive files and storage servers:

PurePathBase

Abstract base class for paths that do not perform I/O.

PathBase

Abstract base class for paths that perform I/O.

These base classes are under active development. Once the base classes reach maturity, they will be made part of the Python standard library, and this package will continue to provide a backport for older Python releases.

Contributing

Changes to pathlib_abc.py and test_pathlib_abc.py must be made in the upstream CPython project, and undergo their usual CLA + code review process. Once a change lands in CPython, it can be back-ported here.

Other changes (such as CI improvements) can be made as pull requests to this project.

Contents

• Examples
  • TarPath
• API Reference
  • Exceptions
    • UnsupportedOperation
  • Base classes
    • ParserBase
    • PurePathBase
    • PathBase
  • Controlling path syntax
    • PurePathBase.parser
    • ParserBase.sep
    • ParserBase.join()
    • ParserBase.split()
    • ParserBase.splitdrive()
    • ParserBase.normcase()
    • ParserBase.isabs()
  • Parsing and generating URIs
    • PathBase.from_uri()
    • PathBase.as_uri()
  • Querying status and type
    • PathBase.stat()
    • PathBase.lstat()
    • PathBase.samefile()
    • PathBase.exists()
    • PathBase.is_dir()
    • PathBase.is_file()
    • PathBase.is_mount()
    • PathBase.is_symlink()
    • PathBase.is_socket()
    • PathBase.is_fifo()
    • PathBase.is_block_device()
    • PathBase.is_char_device()
    • PathBase.is_junction()
  • Reading and writing files
    • PathBase.open()
    • PathBase.read_bytes()
    • PathBase.read_text()
    • PathBase.write_bytes()
    • PathBase.write_text()
  • Iterating over directories
    • PathBase.iterdir()
    • PathBase.glob()
    • PathBase.rglob()
    • PathBase.walk()
  • Making paths absolute
    • PathBase.absolute()
    • PathBase.cwd()
  • Expanding home directories
    • PathBase.expanduser()
    • PathBase.home()
  • Resolving symlinks
    • PathBase.readlink()
    • PathBase.resolve()
  • Permissions
    • PathBase.chmod()
    • PathBase.lchmod()
  • Ownership
    • PathBase.owner()
    • PathBase.group()
  • Other methods
    • PathBase.symlink_to()
    • PathBase.hardlink_to()
    • PathBase.touch()
    • PathBase.mkdir()
    • PathBase.rename()
    • PathBase.replace()
    • PathBase.unlink()
    • PathBase.rmdir()
• Version History
  • Unreleased
  • v0.2.0
  • v0.1.1
  • v0.1.0
• License
  • PSF LICENSE AGREEMENT