Module ntpath
[hide private]
[frames] | no frames]

Module ntpath

Common pathname manipulations, WindowsNT/95 version.

Instead of importing this module directly, import os and refer to this module as os.path.

Functions [hide private]
 
normcase(s)
Normalize case of pathname.
 
isabs(s)
Test whether a path is absolute
 
join(a, *p)
Join two or more pathname components, inserting "\" as needed
 
splitdrive(p)
Split a pathname into drive and path specifiers.
 
splitunc(p)
Split a pathname into UNC mount point and relative path specifiers.
 
split(p)
Split a pathname.
 
splitext(p)
Split the extension from a pathname.
 
basename(p)
Returns the final component of a pathname
 
dirname(p)
Returns the directory component of a pathname
 
commonprefix(m)
Given a list of pathnames, returns the longest common leading component
 
getsize(filename)
Return the size of a file, reported by os.stat()
 
getmtime(filename)
Return the last modification time of a file, reported by os.stat()
 
getatime(filename)
Return the last access time of a file, reported by os.stat()
 
getctime(filename)
Return the creation time of a file, reported by os.stat().
 
islink(path)
Test for symbolic link.
 
exists(path)
Test whether a path exists
 
lexists(path)
Test whether a path exists
 
isdir(path)
Test whether a path is a directory
 
isfile(path)
Test whether a path is a regular file
 
ismount(path)
Test whether a path is a mount point (defined as root of drive)
 
walk(top, func, arg)
Directory tree walk with callback function.
 
expanduser(path)
Expand ~ and ~user constructs.
 
expandvars(path)
Expand shell variables of form $var and ${var}.
 
normpath(path)
Normalize path, eliminating double slashes, etc.
 
abspath(path)
Return the absolute version of a path.
 
realpath(path)
Return the absolute version of a path.
Variables [hide private]
  curdir = '.'
  pardir = '..'
  extsep = '.'
  sep = '\\'
  pathsep = ';'
  defpath = '.;C:\\bin'
  altsep = '/'
  devnull = 'nul'
  supports_unicode_filenames = False

Imports: os, stat, sys, _getfullpathname


Function Details [hide private]

normcase(s)

 

Normalize case of pathname.

Makes all characters lowercase and all slashes into backslashes.

splitdrive(p)

 

Split a pathname into drive and path specifiers. Returns a 2-tuple "(drive,path)"; either part may be empty

splitunc(p)

 

Split a pathname into UNC mount point and relative path specifiers.

Return a 2-tuple (unc, rest); either part may be empty. If unc is not empty, it has the form '//host/mount' (or similar using backslashes). unc+rest is always the input path. Paths containing drive letters never have an UNC part.

split(p)

 

Split a pathname.

Return tuple (head, tail) where tail is everything after the final slash. Either part may be empty.

splitext(p)

 

Split the extension from a pathname.

Extension is everything from the last dot to the end. Return (root, ext), either part may be empty.

islink(path)

 

Test for symbolic link. On WindowsNT/95 always returns false

walk(top, func, arg)

 

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.

expanduser(path)

 

Expand ~ and ~user constructs.

If user or $HOME is unknown, do nothing.

expandvars(path)

 

Expand shell variables of form $var and ${var}.

Unknown variables are left unchanged.