Module posixpath

Common operations on Posix pathnames.

Instead of importing this module directly, import os and refer to this module as os.path. The "os.path" name is an alias for this module on Posix systems; on other systems (e.g. Mac, Windows), os.path provides the same operations in a manner specific to that platform, and is an alias to another module (e.g. macpath, ntpath).

Some of this can actually be useful on non-Posix systems too, e.g. for manipulation of the pathname component of URLs.

Functions

[hide private]

_resolve_link(path)
Internal helper function.

source code

abspath(path)
Return an absolute path.

source code

basename(p)
Returns the final component of a pathname

source code

commonprefix(m)
Given a list of pathnames, returns the longest common leading component

source code

dirname(p)
Returns the directory component of a pathname

source code

exists(path)
Test whether a path exists.

source code

expanduser(path)
Expand ~ and ~user constructions.

source code

expandvars(path)
Expand shell variables of form $var and ${var}.

source code

getatime(filename)
Return the last access time of a file, reported by os.stat().

source code

getctime(filename)
Return the metadata change time of a file, reported by os.stat().

source code

getmtime(filename)
Return the last modification time of a file, reported by os.stat().

source code

getsize(filename)
Return the size of a file, reported by os.stat().

source code

isabs(s)
Test whether a path is absolute

source code

isdir(path)
Test whether a path is a directory

source code

isfile(path)
Test whether a path is a regular file

source code

islink(path)
Test whether a path is a symbolic link

source code

ismount(path)
Test whether a path is a mount point

source code

join(a, *p)
Join two or more pathname components, inserting '/' as needed

source code

lexists(path)
Test whether a path exists.

source code

normcase(s)
Normalize case of pathname.

source code

normpath(path)
Normalize path, eliminating double slashes, etc.

source code

realpath(filename)
Return the canonical path of the specified filename, eliminating any symbolic links encountered in the path.

source code

samefile(f1, f2)
Test whether two pathnames reference the same actual file

source code

sameopenfile(fp1, fp2)
Test whether two open file objects reference the same file

source code

samestat(s1, s2)
Test whether two stat buffers reference the same file

source code

split(p)
Split a pathname.

source code

splitdrive(p)
Split a pathname into drive and path.

source code

splitext(p)
Split the extension from a pathname.

source code

walk(top, func, arg)
Directory tree walk with callback function.

source code

Variables

[hide private]

_varprog = None

altsep = None

curdir = '.'

defpath = ':/bin:/usr/bin'

devnull = '/dev/null'

extsep = '.'

pardir = '..'

pathsep = ':'

sep = '/'

supports_unicode_filenames = False

Function Details

[hide private]

_resolve_link(path)

source code

Internal helper function. Takes a path and follows symlinks until we either arrive at something that isn't a symlink, or encounter a path we've seen before (meaning that there's a loop).

exists(path)

source code

Test whether a path exists. Returns False for broken symbolic links

expanduser(path)

source code

Expand ~ and ~user constructions. If user or $HOME is unknown, do nothing.

expandvars(path)

source code

Expand shell variables of form $var and ${var}. Unknown variables are left unchanged.

lexists(path)

source code

Test whether a path exists. Returns True for broken symbolic links

normcase(s)

source code

Normalize case of pathname. Has no effect under Posix

split(p)

source code

Split a pathname. Returns tuple "(head, tail)" where "tail" is everything after the final slash. Either part may be empty.

splitdrive(p)

source code

Split a pathname into drive and path. On Posix, drive is always empty.

splitext(p)

source code

Split the extension from a pathname. Extension is everything from the last dot to the end. Returns "(root, ext)", either part may be empty.

walk(top, func, arg)

source code

Directory tree walk with callback function.

For each directory in the directory tree rooted at top (including top itself, but excluding '.' and '..'), call func(arg, dirname, fnames). dirname is the name of the directory, and fnames a list of the names of the files and subdirectories in dirname (excluding '.' and '..'). func may modify the fnames list in-place (e.g. via del or slice assignment), and walk will only recurse into the subdirectories whose names remain in fnames; this can be used to implement a filter, or to impose a specific order of visiting. No semantics are defined for, or required of, arg, beyond that arg is always passed to func. It can be used, e.g., to pass a filename pattern, or a mutable object designed to accumulate statistics. Passing None for arg is common.