Back to module index

Go to module by name

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. Windows),
os.path provides the same operations in a manner specific to that
platform, and is an alias to another module (e.g. ntpath).

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

Functions

abspath

abspath(path)

  Return an absolute path.

basename

basename(p)

  Returns the final component of a pathname

commonpath

commonpath(paths)

  Given a sequence of path names, returns the longest common sub-path.

commonprefix

commonprefix(m)

  Given a list of pathnames, returns the longest common leading component

dirname

dirname(p)

  Returns the directory component of a pathname

exists

exists(path)

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

expanduser

expanduser(path)

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

expandvars

expandvars(path)

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

getatime

getatime(filename)

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

getctime

getctime(filename)

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

getmtime

getmtime(filename)

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

getsize

getsize(filename)

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

isabs

isabs(s)

  Test whether a path is absolute

isdir

isdir(s)

  Return true if the pathname refers to an existing directory.

isfile

isfile(path)

  Test whether a path is a regular file

islink

islink(path)

  Test whether a path is a symbolic link

ismount

ismount(path)

  Test whether a path is a mount point

join

join(a, *p)

  Join two or more pathname components, inserting '/' as needed.
      If any component is an absolute path, all previous path components
      will be discarded.  An empty last part will result in a path that
      ends with a separator.

lexists

lexists(path)

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

normcase

normcase(s)

  Normalize case of pathname.  Has no effect under Posix

normpath

normpath(path)

  Normalize path, eliminating double slashes, etc.

realpath

realpath(filename, *, strict=False)

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

relpath

relpath(path, start=None)

  Return a relative version of a path

samefile

samefile(f1, f2)

  Test whether two pathnames reference the same actual file or directory

      This is determined by the device number and i-node number and
      raises an exception if an os.stat() call on either pathname fails.
    

sameopenfile

sameopenfile(fp1, fp2)

  Test whether two open file objects reference the same file

samestat

samestat(s1, s2)

  Test whether two stat buffers reference the same file

split

split(p)

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

splitdrive

splitdrive(p)

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

splitext

splitext(p)

  Split the extension from a pathname.

      Extension is everything from the last dot to the end, ignoring
      leading dots.  Returns "(root, ext)"; ext may be empty.

Other members

altsep = None
curdir = '.'
defpath = '/bin:/usr/bin'
devnull = '/dev/null'
extsep = '.'
pardir = '..'
pathsep = ':'
sep = '/'
supports_unicode_filenames = False

Modules

genericpath

os

stat

sys