Skip to content

Commit

Permalink
Doc: Summary table for pathlib
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nodd
Nodd committed Nov 3, 2024
1 parent bd4be5e commit c917163
Showing 1 changed file with 122 additions and 0 deletions.
122 changes: 122 additions & 0 deletions Doc/library/pathlib.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,128 @@ Opening a file::
'#!/bin/bash\n'


Summary
-------

====================================================================================================== ==================
**Exceptions**
--------------------------------------------------------------------------------------------------------------------------
:exc:`UnsupportedOperation` Raised when an unsupported operation is called on a path object

**Pure paths**
--------------------------------------------------------------------------------------------------------------------------
:class:`PurePath(*pathsegments) <PurePath>` Represents the system's path flavour
:class:`PurePosixPath(*pathsegments) <PurePosixPath>` Represents non-Windows filesystem paths
:class:`PureWindowsPath(*pathsegments) <PureWindowsPath>` Represents Windows filesystem paths

**Pure path attributes**
--------------------------------------------------------------------------------------------------------------------------
:attr:`PurePath.parts` Tuple of the path's various components
:attr:`PurePath.parser` Implementation of the :mod:`os.path` module used for low-level path operations
:attr:`PurePath.drive` Drive letter or name
:attr:`PurePath.root` Root part
:attr:`PurePath.anchor` Concatenation of the drive and root
:attr:`PurePath.parents` Logical ancestors of the path
:attr:`PurePath.parent` Logical parent of the path
:attr:`PurePath.name` Final path component
:attr:`PurePath.suffix` Last dot-separated portion of the final component
:attr:`PurePath.suffixes` List of the path's suffixes
:attr:`PurePath.stem` Final path component without its suffix

**Pure path methods**
--------------------------------------------------------------------------------------------------------------------------
:meth:`PurePath.as_posix` String representation of the path with forward slashes (``/``)
:meth:`PurePath.is_absolute` Whether the path is absolute or not
:meth:`PurePath.is_relative_to(other) <PurePath.is_relative_to>` Whether the path is relative to the *other* path
:meth:`PurePath.is_reserved` Whether the path is considered reserved under Windows (deprecated)
:meth:`PurePath.joinpath(*pathsegments) <PurePath.joinpath>` Combine the path with each of the given *pathsegments*
:meth:`PurePath.full_match(pattern, case_sensitive) <PurePath.full_match>` Match against the provided glob-style pattern
:meth:`PurePath.match(pattern, case_sensitive) <PurePath.match>` Match against the provided non-recursive glob-style pattern
:meth:`PurePath.relative_to(other, walk_up) <PurePath.relative_to>` Version of this path relative to the *other* path
:meth:`PurePath.with_name(name) <PurePath.with_name>` New path with the :attr:`Path.name` changed
:meth:`PurePath.with_stem(stem) <PurePath.with_stem>` New path with the :attr:`Path.stem` changed

Check warning on line 135 in Doc/library/pathlib.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:attr reference target not found: Path.name [ref.attr]
:meth:`PurePath.with_suffix(suffix) <PurePath.with_suffix>` New path with the :attr:`Path.suffix` changed

Check warning on line 136 in Doc/library/pathlib.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:attr reference target not found: Path.stem [ref.attr]
:meth:`PurePath.with_segments(*pathsegments) <PurePath.with_segments>` New path by combining the given *pathsegments*

Check warning on line 137 in Doc/library/pathlib.rst

View workflow job for this annotation

GitHub Actions / Docs / Docs 

py:attr reference target not found: Path.suffix [ref.attr]

**Concrete paths**
--------------------------------------------------------------------------------------------------------------------------
:class:`Path(*pathsegments) <Path>` Represents concrete paths of the system's path flavour
:class:`PosixPath(*pathsegments) <PosixPath>` Represents concrete non-Windows filesystem paths
:class:`WindowsPath(*pathsegments) <WindowsPath>` Represents concrete Windows filesystem paths

**Parsing and generating URIs**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.from_uri(uri) <Path.from_uri>` New path from parsing a 'file' URI
:meth:`Path.as_uri` Represent the path as a 'file' URI

**Expanding and resolving paths**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.home` New path representing the user's home directory
:meth:`Path.expanduser` New path with expanded ``~`` and ``~user`` constructs
:meth:`Path.cwd` New path representing the current directory
:meth:`Path.absolute` Make the path absolute, without normalization or resolving symlinks
:meth:`Path.resolve(strict) <Path.resolve>` Make the path absolute, resolving any symlinks
:meth:`Path.readlink` Path to which the symbolic link points

**Querying file type and status**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.stat(follow_symlinks) <Path.stat>` :class:`os.stat_result` object containing information about this path
:meth:`Path.lstat` Like :meth:`Path.stat`, but return the symbolic link's information rather than its target's
:meth:`Path.exists(follow_symlinks) <Path.exists>` Whether the path points to an existing file or directory
:meth:`Path.is_file(follow_symlinks) <Path.is_file>` Whether the path points to a regular file
:meth:`Path.is_dir(follow_symlinks) <Path.is_dir>` Whether the path points to a directory
:meth:`Path.is_symlink` Whether the path points to a symbolic link
:meth:`Path.is_junction` Whether the path points to a junction
:meth:`Path.is_mount` Whether the path is a mount point
:meth:`Path.is_socket` Whether the path points to a Unix socket
:meth:`Path.is_fifo` Whether the path points to a FIFO
:meth:`Path.is_block_device` Whether the path points to a block device
:meth:`Path.is_char_device` Whether the path points to a character device
:meth:`Path.samefile(other_path) <Path.samefile>` Whether this path points to the same file as *other_path*

**Reading and writing files**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.open(mode, buffering, encoding, errors, newline) <Path.open>` Open the file pointed to by the path
:meth:`Path.read_text(encoding, errors, newline) <Path.read_text>` Decoded contents of the file as a string
:meth:`Path.read_bytes` Binary contents of the file as a bytes object
:meth:`Path.write_text(data, encoding, errors, newline) <Path.write_text>` Write *data* to the file pointed to in text mode
:meth:`Path.write_bytes(data) <Path.write_bytes>` Write *data* to the file pointed to in bytes mode

**Reading directories**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.iterdir` Yield path objects of the directory contents
:meth:`Path.scandir` Iterator of :class:`os.DirEntry` objects corresponding to entries in the directory
:meth:`Path.glob(pattern, case_sensitive, recurse_symlinks) <Path.glob>` Glob the given relative *pattern* in the directory represented by this path, yielding all matching files
:meth:`Path.rglob(pattern, case_sensitive, recurse_symlinks) <Path.rglob>` Glob the given relative *pattern* recursively
:meth:`Path.walk(top_down, on_error, follow_symlinks) <Path.walk>` Generate the file names by walking the directory tree, yielding 3-tuples of ``(dirpath, dirnames, filenames)``

**Creating files and directories**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.touch(mode, exist_ok) <Path.touch>` Create a file at this given path
:meth:`Path.mkdir(mode, parents, exist_ok) <Path.mkdir>` Create a new directory at this given path
:meth:`Path.symlink_to(target, target_is_directory) <Path.symlink_to>` Make this path a symbolic link pointing to *target*
:meth:`Path.hardlink_to(target) <Path.hardlink_to>` Make this path a hard link to the same file as *target*

**Copying, moving and deleting**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.copy(target, follow_symlinks, dirs_exist_ok, preserve_metadata) <Path.copy>` Copy this file or directory tree to the given *target*
:meth:`Path.copy_into(target_dir, follow_symlinks, dirs_exist_ok, preserve_metadata) <Path.copy_into>` Copy this file or directory tree into the given *target_dir*
:meth:`Path.rename(target) <Path.rename>` Rename this file or directory to the given *target*
:meth:`Path.replace(target) <Path.replace>` Rename this file or directory to the given *target*, unconditionally replacing an existing file or empty directory
:meth:`Path.move(target) <Path.move>` Move this file or directory tree to the given *target*
:meth:`Path.move_into(target_dir) <Path.move_into>` Move this file or directory tree into the given *target_dir*
:meth:`Path.unlink(missing_ok) <Path.unlink>` Remove this file or symbolic link
:meth:`Path.rmdir` Remove this empty directory

**Permissions and ownership**
--------------------------------------------------------------------------------------------------------------------------
:meth:`Path.owner(follow_symlinks) <Path.owner>` Return the name of the user owning the file
:meth:`Path.group(follow_symlinks) <Path.group>` Return the name of the group owning the file
:meth:`Path.chmod(mode, follow_symlinks) <Path.chmod>` Change the file mode and permissions
:meth:`Path.lchmod(mode) <Path.lchmod>` Change the file mode and permissions, but the symbolic link's mode is changed rather than its target's

====================================================================================================== ==================

Exceptions
----------

Expand Down

0 comments on commit c917163

Please sign in to comment.