Navigation
index modules| next | previous | Python » 3.5.3 Documentation » The Python Standard Library » 11. File andDirectory Access »11.2. os.path — Common pathname manipulations
Source code: Lib/posixpath.py (for POSIX), Lib/ntpath.py (for Windows NT), and Lib/macpath.py (forMacintosh)--------------------------------------------------------------------------------This module implements some useful functions on pathnames. To reador write files see open(), and for accessing the filesystem see the os module. The path parameters can be passed as either strings, or bytes. Applications are encouraged to represent file names as (Unicode) character strings. Unfortunately, some file names may not be representable as strings on Unix, so applications that need to support arbitrary file names on Unix should use bytes objects to represent path names. Vice versa, using bytes objects cannot represent all file names on Windows (inthe standard mbcs encoding), hence Windows applications should use string objects to access all files.
Unlike a unix shell, Python doesnot do any automatic path expansions. Functions such as expanduser() and expandvars() can be invoked explicitly when an application desires shell-like path expansion. (See also the glob module.)
See also
The pathlib module offers high-level path objects.
Note
All of these functions accept either only bytesor only string objects as their parameters. The result is an object of the same type, if a path or file name isreturned.
Note
Since different operating systems have different path name conventions, there are several versions of this modulein the standard library. The os.path module is always the path module suitable for the operating system Python is running on, and therefore usable for local paths. However, you can also import and use the individual modules if you want to manipulate a path that is always inone of the different formats. They all have the same interface:
posixpathfor UNIX-style paths
ntpathforWindows paths
macpathfor old-style MacOS paths
os.path.abspath(path)
Return a normalized absolutized version of the pathname path. On most platforms, thisisequivalent to calling the function normpath() as follows: normpath(join(os.getcwd(), path)).
os.path.basename(path)
Return the base name of pathname path. Thisis the second element of the pair returned by passing path to the function split(). Note that the result of this function is different from the Unix basename program; where basename for '/foo/bar/' returns 'bar', the basename() function returns an empty string ('').
os.path.commonpath(paths)
Return the longest common sub-path of each pathname in the sequence paths. Raise ValueError if paths contains both absolute and relative pathnames, or if paths isempty. Unlike commonprefix(), this returns a valid path.
Availability: Unix, Windows
Newin version 3.5.
os.path.commonprefix(list)
Return the longest path prefix (taken character-by-character) that is a prefix of all paths in list. If list is empty, return the empty string ('').
Note
This function mayreturninvalid paths because it works a character at a time. To obtain a valid path, see commonpath().>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])'/usr/l'
>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])'/usr'os.path.dirname(path)
Return the directory name of pathname path. Thisisthe first element of the pair returned by passing path to the function split().
os.path.exists(path)
Return Trueif path refers to an existing path or an open file descriptor. Returns False for broken symbolic links. On some platforms, this function may return False if permission is not granted to execute os.stat() on the requested file, even ifthe path physically exists.
Changedin version 3.3: path can now be an integer: True is returned if it isan open file descriptor, False otherwise.
os.path.lexists(path)
Return Trueif path refers to an existing path. Returns True forbroken symbolic links. Equivalent to exists() on platforms lacking os.lstat().
os.path.expanduser(path)
On Unixand Windows, return the argument with an initial component of ~ or ~user replaced by that user‘s home directory.
On Unix, an initial~ is replaced by the environment variable HOME if it is set; otherwise the current user’s home directory is looked up in the password directory through the built-in module pwd. An initial ~user is looked up directly inthe password directory.
On Windows, HOMEand USERPROFILE will be used if set, otherwise a combination of HOMEPATH and HOMEDRIVE will be used. An initial ~user is handled by stripping the last directory component fromthe created user path derived above.
If the expansion failsor if the path does not begin with a tilde, the path isreturned unchanged.
os.path.expandvars(path)
Return the argument with environment variables expanded. Substrings of the form $nameor ${name} are replaced by the value of environment variable name. Malformed variable names and references to non-existing variables are left unchanged.
On Windows,%name% expansions are supported in addition to $name and${name}.
os.path.getatime(path)
Return the time of last access of path. Thereturn value is a number giving the number of seconds since the epoch (see the time module). Raise OSError if the file does not exist or isinaccessible.
If os.stat_float_times() returns True, the resultisa floating point number.
os.path.getmtime(path)
Return the time of last modification of path. Thereturn value is a number giving the number of seconds since the epoch (see the time module). Raise OSError if the file does not exist or isinaccessible.
If os.stat_float_times() returns True, the resultisa floating point number.
os.path.getctime(path)
Return the system’s ctime which, on some systems (like Unix)is the time of the last metadata change, and, on others (like Windows), is the creation time for path. The return value is a number giving the number of seconds since the epoch (see the time module). Raise OSError if the file does not exist or isinaccessible.
os.path.getsize(path)
Return the size,in bytes, of path. Raise OSError if the file does not exist or isinaccessible.
os.path.isabs(path)
Return Trueif path isan absolute pathname. On Unix, that means it begins with a slash, on Windows that it begins with a (back)slash after chopping off a potential drive letter.
os.path.isfile(path)
Return Trueif path is an existing regular file. This follows symbolic links, so both islink() and isfile() can be true forthe same path.
os.path.isdir(path)
Return Trueif path is an existing directory. This follows symbolic links, so both islink() and isdir() can be true forthe same path.
os.path.islink(path)
Return Trueif path refers to a directory entry that is a symbolic link. Always False if symbolic links are notsupported by the Python runtime.
os.path.ismount(path)
Return Trueif pathname path is a mount point: a point in a file system where a different file system has been mounted. On POSIX, the function checks whether path‘s parent, path/.., is on a different device than path, or whether path/.. and path point to the same i-node on the same device — this should detect mount points for all Unix and POSIX variants. On Windows, a drive letter root and a share UNC are always mount points, and for any other path GetVolumePathName is called to see if it is different fromthe input path.
Newin version 3.4: Support for detecting non-root mount points on Windows.
os.path.join(path,*paths)
Join oneor more path components intelligently. The return value is the concatenation of path and any members of *paths with exactly one directory separator (os.sep) following each non-empty part except the last, meaning that the result will only end in a separator if the last part is empty. If a component is an absolute path, all previous components are thrown away and joining continues fromthe absolute path component.
On Windows, the drive letteris not reset when an absolute path component (e.g., r'\foo') is encountered. If a component contains a drive letter, all previous components are thrown away and the drive letter is reset. Note that since there is a current directory for each drive, os.path.join("c:", "foo") represents a path relative to the current directory on drive C: (c:foo), notc:\foo.
os.path.normcase(path)
Normalize the case of a pathname. On Unixand Mac OS X, this returns the path unchanged; on case-insensitive filesystems, it converts the path to lowercase. On Windows, it also converts forward slashes to backward slashes. Raise a TypeError if the type of path is not str orbytes.
os.path.normpath(path)
Normalize a pathname by collapsing redundant separatorsand up-level references so that A//B, A/B/, A/./B and A/foo/../B all become A/B. This string manipulation may change the meaning of a path that contains symbolic links. On Windows, it converts forward slashes to backward slashes. To normalize case, use normcase().
os.path.realpath(path)
Return the canonical path of the specified filename, eliminating any symbolic links encounteredin the path (ifthey are supported by the operating system).
os.path.relpath(path, start=os.curdir)
Return a relative filepath to path eitherfrom the current directory or from an optional start directory. This is a path computation: the filesystem is not accessed to confirm the existence or nature of path orstart.
start defaults to os.curdir.
Availability: Unix, Windows.
os.path.samefile(path1, path2)
Return Trueif both pathname arguments refer to the same file or directory. This is determined by the device number and i-node number and raises an exception ifan os.stat() call on either pathname fails.
Availability: Unix, Windows.
Changedin version 3.2: Added Windows support.
Changedin version 3.4: Windows now uses the same implementation as all other platforms.
os.path.sameopenfile(fp1, fp2)
Return Trueif the file descriptors fp1 andfp2 refer to the same file.
Availability: Unix, Windows.
Changedin version 3.2: Added Windows support.
os.path.samestat(stat1, stat2)
Return Trueif the stat tuples stat1 and stat2 refer to the same file. These structures may have been returned by os.fstat(), os.lstat(), or os.stat(). This function implements the underlying comparison used by samefile() andsameopenfile().
Availability: Unix, Windows.
Changedin version 3.4: Added Windows support.
os.path.split(path)
Split the pathname path into a pair, (head, tail) where tailis the last pathname component and head is everything leading up to that. The tail part will never contain a slash; if path ends in a slash, tail will be empty. If there is no slash in path, head will be empty. If path is empty, both head and tail are empty. Trailing slashes are stripped from head unless it is the root (one or more slashes only). In all cases, join(head, tail) returns a path to the same location as path (but the strings may differ). Also see the functions dirname() andbasename().
os.path.splitdrive(path)
Split the pathname path into a pair (drive, tail) where driveis either a mount point or the empty string. On systems which do not use drive specifications, drive will always be the empty string. In all cases, drive +tail will be the same as path.
On Windows, splits a pathname into drive/UNC sharepoint andrelative path.
If the path contains a drive letter, drive will contain everything up toand including the colon. e.g. splitdrive("c:/dir") returns ("c:", "/dir")
If the path contains a UNC path, drive will contain the host nameand share, up to but not including the fourth separator. e.g. splitdrive("//host/computer/dir") returns ("//host/computer", "/dir")
os.path.splitext(path)
Split the pathname path into a pair (root, ext) such that root+ ext == path, and ext is empty or begins with a period and contains at most one period. Leading periods on the basename are ignored; splitext('.cshrc') returns ('.cshrc', '').
os.path.splitunc(path)
Deprecated since version3.1: Use splitdrive instead.
Split the pathname path into a pair (unc, rest) so that uncis the UNC mount point (such as r'\\host\mount'), if present, and rest the rest of the path (such as r'\path\file.ext'). For paths containing drive letters, unc will always be the empty string.
Availability: Windows.
os.path.supports_unicode_filenames
Trueifarbitrary Unicode strings can be used as file names (within limitations imposed by the file system).
Navigation
index modules| next | previous | Python » 3.5.3 Documentation » The Python Standard Library » 11. File andDirectory Access »
© Copyright2001-2017, Python Software Foundation.
The Python Software Foundationis a non-profit corporation. Please donate.
Last updated on Jan16, 2017. Found a bug?
Created using Sphinx1.3.1.
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
