|
Size: 3072
Comment:
|
← Revision 8 as of 2023-10-11 19:40:58 ⇥
Size: 10541
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
'''`pathlib`''' is a module providing a consistent and powerful interface for path-like objects. The `pathlib.Path` object should be acceptable wherever a path-like object can be used. |
|
| Line 11: | Line 13: |
| The core functionality of the `pathlib` module is the '''`pathlib.Path`''' class. | |
| Line 13: | Line 16: |
| === Path === | |
| Line 15: | Line 17: |
| The `Path` class is instantiated like: | === Example === |
| Line 19: | Line 21: |
| p = Path('.') | # instantiate a relative path p = Path('.') # '.' # append to the path p.joinpath('temp') # './temp' # replace the extension of a file old = Path('archive.tar.gz') new = old.with_suffix('.txt') # 'archive.txt' |
| Line 21: | Line 32: |
=== Methods === ||'''Method''' ||'''Meaning''' || ||`absolute()` || || ||`anchor()` || || ||`as_posix()` || || ||`as_uri()` || || ||`chmod()` || || ||`drive()` || || ||`exists()` ||test if the file/directory represented by the path exists || ||`expanduser()` || || ||`glob()` || || ||`group()` || || ||`hardlink_to()` || || ||`is_absolute()` ||test if the path is absolute || ||`is_block_device()`|| || ||`is_char_device()` || || ||`is_dir()` || || ||`is_fifo()` || || ||`is_file()` || || ||`is_mount()` || || ||`is_relative_to()` ||test if the path is relative to another path || ||`is_reserved()` ||on Windows only, test if the path is reserved || ||`is_socket()` || || ||`is_symlink()` || || ||`iterdir()` || || ||`joinpath()` ||append path-like objects || ||`match()` ||test if the path matches a glob pattern || ||`mkdir()` ||create the directory represented by the path; can raise `FileNotFoundError` or `FileExistsError` || ||`name()` || || ||`open()` || || ||`owner()` || || ||`parent()` || || ||`parents()` || || ||`parts()` || || ||`read_bytes()` || || ||`read_text()` || || ||`readlink()` || || ||`relative_to()` ||return a new `pathlib.Path` object representing the path relative to another path || ||`rename()` || || ||`replace()` || || ||`resolve()` || || ||`rglob()` || || ||`rmdir()` || || ||`root()` || || ||`samefile()` || || ||`stat()` ||return a [[Python/Os#Stat_Result|os.stat_result]] for the file represented by the path || ||`stem()` || || ||`suffix()` || || ||`suffixes()` || || ||`symlink_to()` || || ||`touch()` || || ||`unlink()` || || ||`with_name()` ||return a new `pathlib.Path` object representing the path with the final component replaced with another filename || ||`with_stem()` ||return a new `pathlib.Path` object representing the path with the final component's basename replaced with another basename || ||`with_segments()` || || ||`with_suffix()` ||return a new `pathlib.Path` object representing the path with the final component's extension replaced with another extension|| ||`write_bytes()` || || ||`write_text()` || || === Class Methods === There are also two class methods for instantiating commonly-used paths. ||'''Method''' ||'''Value''' || ||`Path.cwd()` ||current working directory|| ||`Path.home()`||home directory || |
|
| Line 26: | Line 109: |
| ==== Absolute ==== | == Classes == |
| Line 28: | Line 111: |
| ---- | Apart from `pathlib.Path`, there are several classes exposed for alternative and niche functionality. |
| Line 30: | Line 113: |
==== Anchor ==== ---- ==== As_Posix ==== ---- ==== As_Uri ==== ---- ==== ChMod ==== ---- ==== Drive ==== ---- ==== Exists ==== ---- ==== ExpandUser ==== ---- ==== Glob ==== ---- ==== Group ==== ---- ==== HardLink_To ==== ---- ==== Is_Absolute ==== ---- ==== Is_Block_Device ==== ---- ==== Is_Char_Device ==== ---- ==== Is_Dir ==== ---- ==== Is_Fifo ==== ---- ==== Is_File ==== ---- ==== Is_Mount ==== ---- ==== Is_Relative_To ==== ---- ==== Is_Reserved ==== ---- ==== Is_Socket ==== ---- ==== Is_SymLink ==== ---- ==== IterDir ==== ---- ==== JoinPath ==== Takes one or more strings or `Path` objects. {{{ from pathlib import Path p = Path('.') t = p.joinpath('temp') }}} ---- ==== Match ==== ---- ==== MkDir ==== {{{ from pathlib import Path p = Path('.') t = p.joinpath('temp') t.mkdir(parents=False, exist_ok=True) }}} If a parent directory does not exist, `FileNotFoundError` is raised. If the `parents` option is set to `True` though, the missing parents are recursively `mkdir`ed instead. If the directory already exists, `FileExistsError` is raised. If the `exist_ok` option is set to `True` though, this error is suppressed. If a file already exists at the named location, `FileExistsError` is raised regardless of the `exist_ok` option. ---- ==== Name ==== ---- ==== Open ==== ---- ==== Owner ==== ---- ==== Parent ==== ---- ==== Parents ==== ---- ==== Parts ==== ---- ==== Read_Bytes ==== ---- ==== Read_Text ==== ---- ==== ReadLink ==== ---- ==== Relative_To ==== ---- ==== Rename ==== ---- ==== Replace ==== ---- ==== Resolve ==== ---- ==== RGlob ==== ---- ==== RmDir ==== ---- ==== Root ==== ---- ==== SameFile ==== ---- ==== Stat ==== ---- ==== Stem ==== ---- ==== Suffix ==== ---- ==== Suffixes ==== ---- ==== SymLink_To ==== ---- ==== Touch ==== ---- ==== Unlink ==== ---- ==== With_Name ==== ---- ==== With_Stem ==== ---- ==== With_Suffix ==== ---- ==== Write_Bytes ==== ---- ==== Write_Text ==== ---- === Cwd === A `Path` class method. {{{ from pathlib import Path c = Path.cwd() }}} ---- === Home === A `Path` class method. {{{ from pathlib import Path h = Path.home() }}} |
||'''Class''' ||'''Meaning''' || ||`pathlib.PosixPath` ||POSIX-only class || ||`pathlib.PurePath` ||base class that does not interact with the actual filesystem || ||`pathlib.PurePosixPath` ||base POSIX class that does not interact with the actual filesystem || ||`pathlib.PureWindowsPath`||base Windows class that does not interact with the actual filesystem|| ||`pathlib.WindowsPath` ||Windows-only class || |
| Line 407: | Line 128: |
| [[https://pymotw.com/3/pathlib/|Python Module of the Day article for pathlib]] |
Python Pathlib
pathlib is a module providing a consistent and powerful interface for path-like objects. The pathlib.Path object should be acceptable wherever a path-like object can be used.
Usage
The core functionality of the pathlib module is the pathlib.Path class.
Example
from pathlib import Path
# instantiate a relative path
p = Path('.') # '.'
# append to the path
p.joinpath('temp') # './temp'
# replace the extension of a file
old = Path('archive.tar.gz')
new = old.with_suffix('.txt') # 'archive.txt'
Methods
Method |
Meaning |
absolute() |
|
anchor() |
|
as_posix() |
|
as_uri() |
|
chmod() |
|
drive() |
|
exists() |
test if the file/directory represented by the path exists |
expanduser() |
|
glob() |
|
group() |
|
hardlink_to() |
|
is_absolute() |
test if the path is absolute |
is_block_device() |
|
is_char_device() |
|
is_dir() |
|
is_fifo() |
|
is_file() |
|
is_mount() |
|
is_relative_to() |
test if the path is relative to another path |
is_reserved() |
on Windows only, test if the path is reserved |
is_socket() |
|
is_symlink() |
|
iterdir() |
|
joinpath() |
append path-like objects |
match() |
test if the path matches a glob pattern |
mkdir() |
create the directory represented by the path; can raise FileNotFoundError or FileExistsError |
name() |
|
open() |
|
owner() |
|
parent() |
|
parents() |
|
parts() |
|
read_bytes() |
|
read_text() |
|
readlink() |
|
relative_to() |
return a new pathlib.Path object representing the path relative to another path |
rename() |
|
replace() |
|
resolve() |
|
rglob() |
|
rmdir() |
|
root() |
|
samefile() |
|
stat() |
return a os.stat_result for the file represented by the path |
stem() |
|
suffix() |
|
suffixes() |
|
symlink_to() |
|
touch() |
|
unlink() |
|
with_name() |
return a new pathlib.Path object representing the path with the final component replaced with another filename |
with_stem() |
return a new pathlib.Path object representing the path with the final component's basename replaced with another basename |
with_segments() |
|
with_suffix() |
return a new pathlib.Path object representing the path with the final component's extension replaced with another extension |
write_bytes() |
|
write_text() |
|
Class Methods
There are also two class methods for instantiating commonly-used paths.
Method |
Value |
Path.cwd() |
current working directory |
Path.home() |
home directory |
Classes
Apart from pathlib.Path, there are several classes exposed for alternative and niche functionality.
Class |
Meaning |
pathlib.PosixPath |
POSIX-only class |
pathlib.PurePath |
base class that does not interact with the actual filesystem |
pathlib.PurePosixPath |
base POSIX class that does not interact with the actual filesystem |
pathlib.PureWindowsPath |
base Windows class that does not interact with the actual filesystem |
pathlib.WindowsPath |
Windows-only class |
See also
Python pathlib module documentation
Python Module of the Day article for pathlib