mrv.path

Epydoc: mrv.path

path.py - An object representing a path to a file or directory.

Example:

>>> from path import path
>>> d = path('/home/guido/bin')
>>> for f in d.files('*.py'):
>>>             f.chmod(0755)

This module requires Python 2.4 or later.

TODO

• Tree-walking functions don’t avoid symlink loops. Matt Harrison sent me a patch for this.

• Tree-walking functions can’t ignore errors. Matt Harrison asked for this.

• Two people asked for path.chdir(). This just seems wrong to me,

  I dunno. chdir() is moderately evil anyway.

• Bug in write_text(). It doesn’t support Universal newline mode.

• Better error message in listdir() when self isn’t a

  directory. (On Windows, the error message really sucks.)

• Make sure everything has a good docstringc.

• Add methods for regex find and replace.

• guess_content_type() method?

• Could add split() and join() methods that generate warnings.

Functions

mrv.path._to_os_path(path)

Returns:string being an os compatible path

mrv.path.make_path(path)

Returns:A path instance of the correct type Note:use this constructor if you use the Path.set_separator method at runtime to assure you will always create instances of the actual type, and not only of the type you imported last

Classes

Epydoc: mrv.path.Path

class mrv.path.Path

Bases: str, mrv.interface.iDagItem

Represents a filesystem path.

For documentation on individual methods, consult their counterparts in os.path.

abspath()

access(mode)

Return true if current user has access to this path.

mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

atime()

basename(p)

Returns the final component of a pathname

bytes()

Open this file, read all bytes, return them as a string.

capitalize

S.capitalize() -> string

Return a copy of the string S with only its first character capitalized.

center

S.center(width[, fillchar]) -> string

Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

children(predicate=<function <lambda> at 0x7f41dd7c72a8>, pattern=None)

Returns:

child paths as retrieved by queryiing the file system.

Note:

files cannot have children, and willl return an empty array accordingly

Parameters:

• predicate – return p if predicate( p ) returns True
• pattern – list only elements that match the given simple pattern i.e. .

childrenDeep(order=1, predicate=<function <lambda> at 0x7f41dd7c5050>)

Returns:

list of all children of path, [ child1 , child2 ]

Parameters:

• order – order enumeration
• predicate – returns true if x may be returned

Note:

the child objects returned are supposed to be valid paths, not just relative paths

chmod(mode)

Change file mode

Returns:self

chown(uid, gid)

Change file ownership

Returns:self

chroot()

Change the root directory path

Returns:self

containsvars()

Returns:True if this path contains environment variables

convert_separators()

Returns:Version of self with all separators set to be ‘sep’. The difference

to normpath is that it does not cut trailing separators

copy(dest)

Copy data and source bits to dest

Returns:Path to dest

copy2(dest)

Shutil.copy2 self to dest

Returns:Path to dest

copyfile(dest)

Copy self to dest

Returns:Path to dest

copymode(dest)

Copy our mode to dest

Returns:Path to dest

copystat(dest)

Copy our stats to dest

Returns:Path to dest

copytree(dest, **kwargs)

Deep copy this file or directory to destination

Parameter:kwargs – passed to shutil.copytree Returns:Path to dest

count

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ctime()

decode

S.decode([encoding[,errors]]) -> object

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

digest(hashobject)

Calculate the hash for this file using the given hashobject. It must support the ‘update’ and ‘digest’ methods.

Note:This reads through the entire file.

dirname()

dirs(pattern=None)

D.dirs() -> List of this directory’s subdirectories.

The elements of the list are path objects. This does not walk recursively into subdirectories (but see path.walkdirs).

With the optional pattern argument, this only lists directories whose names match the given pattern. For example, d.dirs(“build-*”).

drive()

The drive specifier, for example ‘C:’. This is always empty on systems that don’t use drive specifiers.

encode

S.encode([encoding[,errors]]) -> object

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

endswith

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()

expand()

Clean up a filename by calling expandvars() and expanduser()

This is commonly everything needed to clean up a filename read from a configuration file, for example.

If you are not interested in trailing slashes, you should call normpath() on the resulting Path as well.

expand_or_raise()

Returns:Copy of self with all variables expanded ( using expand )

non-recursively !

Raises ValueError:  If we could not expand all environment variables as their values where missing in the environment

expandtabs

S.expandtabs([tabsize]) -> string

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

expanduser()

expandvars()

expandvars_deep()

Expands all environment variables recursively

expandvars_deep_or_raise()

Expands all environment variables recursively, and raises ValueError if the path still contains variables afterwards

ext()

The file extension, for example ‘.py’.

files(pattern=None)

D.files() -> List of the files in this directory.

The elements of the list are path objects. This does not walk into subdirectories (see path.walkfiles).

With the optional pattern argument, this only lists files whose names match the given pattern. For example, d.files(“*.pyc”).

find

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

fnmatch(pattern)

Return True if self.basename() matches the given pattern.

pattern - A filename pattern with wildcards,

for example “*.py”.

format

S.format(*args, **kwargs) -> unicode

fullChildName(childname)

Add the given name to the string version of our instance :return: string with childname added like name _sep childname

classmethod getcwd()

Returns:the current working directory as a path object.

glob(pattern)

Return a list of path objects that match the pattern.

pattern - a path relative to this directory, with wildcards.

For example, path(‘/users’).glob(‘/bin/‘) returns a list of all the files users have in their bin directories.

index

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)

Returns:True if self is a part of other, and thus can be found in other Note:operates on strings only

isRoot()

Returns:True if this path is the root of the DAG

isRootOf(other)

Returns:True other starts with self Note:operates on strings Note:we assume other has the same type as self, thus the same separator

isWritable()

Returns:true if the file can be written to

isabs(s)

Test whether a path is absolute

isalnum

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdigit

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isdir()

isfile()

islink()

islower

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ismount()

isspace

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)

Returns:generator retrieving all parents up to the root Parameter:predicate – returns True for all x that you want to be returned

join

S.join(iterable) -> string

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

joinpath(*args)

Join two or more path components, adding a separator character (os.sep) if needed. Returns a new path object.

lexists()

lines(encoding=None, errors='strict', retain=True)

Open this file, read all lines, return them in a list.

Optional arguments:

• encoding: The Unicode encoding (or character set) of

  the file. The default is None, meaning the content of the file is read as 8-bit characters and returned as a list of (non-Unicode) str objects.

• errors: How to handle Unicode errors; see help(str.decode)

  for the options. Default is ‘strict’

• retain: If true, retain newline characters; but all newline

  character combinations (“r”, “n”, “rn”) are translated to “n”. If false, newline characters are stripped off. Default is True.

This uses “U” mode in Python 2.3 and later.

link(newpath)

Create a hard link at ‘newpath’, pointing to this file.

Returns:Path to newpath

listdir(pattern=None)

return list of items in this directory.

Use D.files() or D.dirs() instead if you want a listing of just files or just subdirectories.

The elements of the list are path objects.

With the optional ‘pattern’ argument, this only lists items whose names match the given pattern.

ljust

S.ljust(width[, fillchar]) -> string

Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

lower

S.lower() -> string

Return a copy of the string S converted to lowercase.

lstat()

Like path.stat(), but do not follow symbolic links.

lstrip

S.lstrip([chars]) -> string or unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

makedirs(mode=511)

Smarter makedir, see os.makedirs

Returns:self

mkdir(mode=511)

Make this directory, fail if it already exists

Returns:self

move(dest)

Move self to dest

Returns:Path to dest

mtime()

namebase()

The same as path.basename(), but with one file extension stripped off.

For example, path(‘/home/guido/python.tar.gz’).name == ‘python.tar.gz’, but path(‘/home/guido/python.tar.gz’).namebase == ‘python.tar’

normcase()

normpath()

open(*args, **kwargs)

Open this file. Return a file object.

owner()

Return the name of the owner of this file or directory.

This follows symbolic links.

On Windows, this returns a name of the form ur’DOMAINUser Name’. On Windows, a group can own a file or directory.

parent()

Returns:the parent directory of this Path or None if this is the root

parentDeep()

Returns:all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

pathconf(name)

see os.pathconf

readlink()

Return the path to which this symbolic link points.

The result may be an absolute or a relative path.

readlinkabs()

Return the path to which this symbolic link points.

The result is always an absolute path.

realpath()

relpath()

Return this path as a relative path, originating from the current working directory.

relpathfrom(dest)

Return a relative path from dest to self

relpathto(dest)

Return a relative path from self to dest.

If there is no relative path from self to dest, for example if they reside on different drives in Windows, then this returns dest.abspath().

remove()

Remove this file

Returns:self

removedirs()

see os.removedirs

Returns:self

rename(new)

os.rename

Returns:Path to new file

renames(new)

os.renames, super rename

Returns:Path to new file

replace

S.replace (old, new[, count]) -> string

Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust

S.rjust(width[, fillchar]) -> string

Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

rmdir()

Remove this empty directory

Returns:self

rmtree(**kwargs)

Remove self recursively

Parameter:kwargs – passed to shutil.rmtree Returns:self

root()

Returns:the root of the DAG - it has no further parents

rpartition

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

rstrip

S.rstrip([chars]) -> string or unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

samefile(other)

classmethod set_separator(sep)

Set this type to support the given separator as general path separator

setutime(times)

Set the access and modified times of this file.

Returns:self

size()

split

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitall()

Return a list of the path components in this path.

The first item in the list will be a path. Its value will be either os.curdir, os.pardir, empty, or the root directory of this path (for example, ‘/’ or ‘C:’). The other items in the list will be strings.

path.path.joinpath(*result) can possibly yield the original path, depending on the input.

splitdrive()

p.splitdrive() -> Return (p.drive, <the rest of p>).

Split the drive specifier from this path. If there is no drive specifier, p.drive is empty, so the return value is simply (path(‘’), p). This is always the case on Unix.

splitext()

p.splitext() -> Return (p.stripext(), p.ext).

Split the filename extension from this path and return the two parts. Either part may be empty.

The extension is everything from ‘.’ to the end of the last path segment. This has the property that if (a, b) == p.splitext(), then a + b == p.

splitlines

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

splitpath()

p.splitpath() -> Return (p.parent(), p.basename()).

startswith

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

stat()

Perform a stat() system call on this path.

statvfs()

Perform a statvfs() system call on this path.

strip

S.strip([chars]) -> string or unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

stripext()

p.stripext() -> Remove one file extension from the path.

For example, path(‘/home/guido/python.tar.gz’).stripext() returns path(‘/home/guido/python.tar’).

supports(interface_type)

Returns:True if this instance supports the interface of the given type Parameter:interface_type – Type of the interface you require this instance to support Note:Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase

S.swapcase() -> string

Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

symlink(newlink)

Create a symbolic link at ‘newlink’, pointing here.

Returns:Path to newlink

text(encoding=None, errors='strict')

Open this file, read it in, return the content as a string.

This uses “U” mode in Python 2.3 and later, so “rn” and “r” are automatically translated to ‘n’.

Optional arguments:

• encoding - The Unicode encoding (or character set) of the file. If present, the content of the file is decoded and returned as a unicode object; otherwise it is returned as an 8-bit str.
• errors - How to handle Unicode errors; see help(str.decode) for the options. Default is ‘strict’.

title

S.title() -> string

Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

tolinuxpath()

Returns:A path using only slashes as path separator

tonative()

Convert the path separator to the type required by the current operating system - on windows / becomes and on linux becomes /

Returns:native version of self

touch(flags=65, mode=438)

Set the access/modified times of this file to the current time. Create the file if it does not exist.

Returns:self

translate

S.translate(table [,deletechars]) -> string

Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.

unlink()

unlink this file

Returns:self

upper

S.upper() -> string

Return a copy of the string S converted to uppercase.

walk(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca320>)

create iterator over files and subdirs, recursively.

The iterator yields path objects naming each child item of this directory and its descendants.

It performs a depth-first traversal of the directory tree. Each directory is returned just before all its children.

Parameters:

• pattern – fnmatch compatible pattern or None
• errors – controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via log.warn(), and ‘ignore’.
• predicate – returns True for each Path p to be yielded by iterator

walkdirs(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca410>)

D.walkdirs() -> iterator over subdirs, recursively. see walk for a parameter description

walkfiles(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca500>)

D.walkfiles() -> iterator over files in D, recursively. see walk for a parameter description

write_bytes(bytes, append=False)

Open this file and write the given bytes to it.

Default behavior is to overwrite any existing file. Call p.write_bytes(bytes, append=True) to append instead. :return: self

write_lines(lines, encoding=None, errors='strict', linesep='n', append=False)

Write the given lines of text to this file.

By default this overwrites any existing file at this path.

This puts a platform-specific newline sequence on every line. See ‘linesep’ below.

lines - A list of strings.

encoding - A Unicode encoding to use. This applies only if

‘lines’ contains any Unicode strings.

errors - How to handle errors in Unicode encoding. This

also applies only to Unicode strings.

linesep - The desired line-ending. This line-ending is

applied to every line. If a line already has any standard line ending, that will be stripped off and this will be used instead. The default is os.linesep, which is platform-dependent (‘rn’ on Windows, ‘n’ on Unix, etc.) Specify None to write the lines as-is, like file.writelines().

Use the keyword argument append=True to append lines to the file. The default is to overwrite the file. Warning: When you use this with Unicode data, if the encoding of the existing data in the file is different from the encoding you specify with the encoding= parameter, the result is mixed-encoding data, which can really confuse someone trying to read the file later.

Returns:self

write_text(text, encoding=None, errors='strict', linesep='n', append=False)

Write the given text to this file.

The default behavior is to overwrite any existing file; to append instead, use the ‘append=True’ keyword argument.

There are two differences between path.write_text() and path.write_bytes(): newline handling and Unicode handling. See below.

Parameters:

• text - str/unicode - The text to be written.

• encoding - str - The Unicode encoding that will be used.

  This is ignored if ‘text’ isn’t a Unicode string.

• errors - str - How to handle Unicode encoding errors.

  Default is ‘strict’. See help(unicode.encode) for the options. This is ignored if ‘text’ isn’t a Unicode string.

• linesep - keyword argument - str/unicode - The sequence of

  characters to be used to mark end-of-line. The default is os.linesep. You can also specify None; this means to leave all newlines as they are in ‘text’.

• append - keyword argument - bool - Specifies what to do if

  the file already exists (True: append to the end of it; False: overwrite it.) The default is False.

Newline handling:

• write_text() converts all standard end-of-line sequences

  (“n”, “r”, and “rn”) to your platforms default end-of-line sequence (see os.linesep; on Windows, for example, the end-of-line marker is “rn”).

• If you don’t like your platform’s default, you can override it

  using the “linesep=” keyword argument. If you specifically want write_text() to preserve the newlines as-is, use “linesep=None”.

• This applies to Unicode text the same as to 8-bit text, except

  there are additional standard Unicode end-of-line sequences, check the code to see them.

• (This is slightly different from when you open a file for

  writing with fopen(filename, “w”) in C or file(filename, “w”) in Python.)

Unicode:

If “text” isn’t Unicode, then apart from newline handling, the bytes are written verbatim to the file. The “encoding” and ‘errors’ arguments are not used and must be omitted.

If ‘text’ is Unicode, it is first converted to bytes using the specified ‘encoding’ (or the default encoding if ‘encoding’ isn’t specified). The ‘errors’ argument applies only to this conversion.

Returns:self

zfill

S.zfill(width) -> string

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.path.ConversionPath

class mrv.path.ConversionPath

Bases: mrv.path.Path

On windows, python represents paths with backslashes, within maya though, these are slashes We want to keep the original representation, but allow the methods to work nonetheless.

abspath()

access(mode)

Return true if current user has access to this path.

mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

atime()

basename()

bytes()

Open this file, read all bytes, return them as a string.

capitalize

S.capitalize() -> string

Return a copy of the string S with only its first character capitalized.

center

S.center(width[, fillchar]) -> string

Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

children(predicate=<function <lambda> at 0x7f41dd7c72a8>, pattern=None)

Returns:

child paths as retrieved by queryiing the file system.

Note:

files cannot have children, and willl return an empty array accordingly

Parameters:

• predicate – return p if predicate( p ) returns True
• pattern – list only elements that match the given simple pattern i.e. .

childrenDeep(order=1, predicate=<function <lambda> at 0x7f41dd7c5050>)

Returns:

list of all children of path, [ child1 , child2 ]

Parameters:

• order – order enumeration
• predicate – returns true if x may be returned

Note:

the child objects returned are supposed to be valid paths, not just relative paths

chmod(mode)

Change file mode

Returns:self

chown(uid, gid)

Change file ownership

Returns:self

chroot()

Change the root directory path

Returns:self

containsvars()

Returns:True if this path contains environment variables

convert_separators()

Returns:Version of self with all separators set to be ‘sep’. The difference

to normpath is that it does not cut trailing separators

copy(dest)

Copy data and source bits to dest

Returns:Path to dest

copy2(dest)

Shutil.copy2 self to dest

Returns:Path to dest

copyfile(dest)

Copy self to dest

Returns:Path to dest

copymode(dest)

Copy our mode to dest

Returns:Path to dest

copystat(dest)

Copy our stats to dest

Returns:Path to dest

copytree(dest, **kwargs)

Deep copy this file or directory to destination

Parameter:kwargs – passed to shutil.copytree Returns:Path to dest

count

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ctime()

decode

S.decode([encoding[,errors]]) -> object

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

digest(hashobject)

Calculate the hash for this file using the given hashobject. It must support the ‘update’ and ‘digest’ methods.

Note:This reads through the entire file.

dirname()

dirs(pattern=None)

D.dirs() -> List of this directory’s subdirectories.

The elements of the list are path objects. This does not walk recursively into subdirectories (but see path.walkdirs).

With the optional pattern argument, this only lists directories whose names match the given pattern. For example, d.dirs(“build-*”).

drive()

The drive specifier, for example ‘C:’. This is always empty on systems that don’t use drive specifiers.

encode

S.encode([encoding[,errors]]) -> object

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

endswith

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()

expand()

Clean up a filename by calling expandvars() and expanduser()

This is commonly everything needed to clean up a filename read from a configuration file, for example.

If you are not interested in trailing slashes, you should call normpath() on the resulting Path as well.

expand_or_raise()

Returns:Copy of self with all variables expanded ( using expand )

non-recursively !

Raises ValueError:  If we could not expand all environment variables as their values where missing in the environment

expandtabs

S.expandtabs([tabsize]) -> string

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

expanduser()

expandvars()

expandvars_deep()

Expands all environment variables recursively

expandvars_deep_or_raise()

Expands all environment variables recursively, and raises ValueError if the path still contains variables afterwards

ext()

The file extension, for example ‘.py’.

files(pattern=None)

D.files() -> List of the files in this directory.

The elements of the list are path objects. This does not walk into subdirectories (see path.walkfiles).

With the optional pattern argument, this only lists files whose names match the given pattern. For example, d.files(“*.pyc”).

find

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

fnmatch(pattern)

Return True if self.basename() matches the given pattern.

pattern - A filename pattern with wildcards,

for example “*.py”.

format

S.format(*args, **kwargs) -> unicode

fullChildName(childname)

Add the given name to the string version of our instance :return: string with childname added like name _sep childname

classmethod getcwd()

Returns:the current working directory as a path object.

glob(pattern)

Return a list of path objects that match the pattern.

pattern - a path relative to this directory, with wildcards.

For example, path(‘/users’).glob(‘/bin/‘) returns a list of all the files users have in their bin directories.

index

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)

Returns:True if self is a part of other, and thus can be found in other Note:operates on strings only

isRoot()

Returns:True if this path is the root of the DAG

isRootOf(other)

Returns:True other starts with self Note:operates on strings Note:we assume other has the same type as self, thus the same separator

isWritable()

Returns:true if the file can be written to

isabs(s)

Test whether a path is absolute

isalnum

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdigit

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isdir()

isfile()

islink()

islower

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ismount()

isspace

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)

Returns:generator retrieving all parents up to the root Parameter:predicate – returns True for all x that you want to be returned

join

S.join(iterable) -> string

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

joinpath(*args)

lexists()

lines(encoding=None, errors='strict', retain=True)

Open this file, read all lines, return them in a list.

Optional arguments:

• encoding: The Unicode encoding (or character set) of

  the file. The default is None, meaning the content of the file is read as 8-bit characters and returned as a list of (non-Unicode) str objects.

• errors: How to handle Unicode errors; see help(str.decode)

  for the options. Default is ‘strict’

• retain: If true, retain newline characters; but all newline

  character combinations (“r”, “n”, “rn”) are translated to “n”. If false, newline characters are stripped off. Default is True.

This uses “U” mode in Python 2.3 and later.

link(newpath)

Create a hard link at ‘newpath’, pointing to this file.

Returns:Path to newpath

listdir(pattern=None)

return list of items in this directory.

Use D.files() or D.dirs() instead if you want a listing of just files or just subdirectories.

The elements of the list are path objects.

With the optional ‘pattern’ argument, this only lists items whose names match the given pattern.

ljust

S.ljust(width[, fillchar]) -> string

Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

lower

S.lower() -> string

Return a copy of the string S converted to lowercase.

lstat()

Like path.stat(), but do not follow symbolic links.

lstrip

S.lstrip([chars]) -> string or unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

makedirs(mode=511)

Smarter makedir, see os.makedirs

Returns:self

mkdir(mode=511)

Make this directory, fail if it already exists

Returns:self

move(dest)

Move self to dest

Returns:Path to dest

mtime()

namebase()

The same as path.basename(), but with one file extension stripped off.

For example, path(‘/home/guido/python.tar.gz’).name == ‘python.tar.gz’, but path(‘/home/guido/python.tar.gz’).namebase == ‘python.tar’

normcase()

normpath()

open(*args, **kwargs)

Open this file. Return a file object.

owner()

Return the name of the owner of this file or directory.

This follows symbolic links.

On Windows, this returns a name of the form ur’DOMAINUser Name’. On Windows, a group can own a file or directory.

parent()

Returns:the parent directory of this Path or None if this is the root

parentDeep()

Returns:all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

pathconf(name)

see os.pathconf

readlink()

Return the path to which this symbolic link points.

The result may be an absolute or a relative path.

readlinkabs()

Return the path to which this symbolic link points.

The result is always an absolute path.

realpath()

relpath()

Return this path as a relative path, originating from the current working directory.

relpathfrom(dest)

Return a relative path from dest to self

relpathto(dest)

remove()

Remove this file

Returns:self

removedirs()

see os.removedirs

Returns:self

rename(new)

os.rename

Returns:Path to new file

renames(new)

os.renames, super rename

Returns:Path to new file

replace

S.replace (old, new[, count]) -> string

Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust

S.rjust(width[, fillchar]) -> string

Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

rmdir()

Remove this empty directory

Returns:self

rmtree(**kwargs)

Remove self recursively

Parameter:kwargs – passed to shutil.rmtree Returns:self

root()

Returns:the root of the DAG - it has no further parents

rpartition

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

rstrip

S.rstrip([chars]) -> string or unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

samefile(other)

classmethod set_separator(sep)

Set this type to support the given separator as general path separator

setutime(times)

Set the access and modified times of this file.

Returns:self

size()

split

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitall()

Return a list of the path components in this path.

The first item in the list will be a path. Its value will be either os.curdir, os.pardir, empty, or the root directory of this path (for example, ‘/’ or ‘C:’). The other items in the list will be strings.

path.path.joinpath(*result) can possibly yield the original path, depending on the input.

splitdrive()

p.splitdrive() -> Return (p.drive, <the rest of p>).

Split the drive specifier from this path. If there is no drive specifier, p.drive is empty, so the return value is simply (path(‘’), p). This is always the case on Unix.

splitext()

p.splitext() -> Return (p.stripext(), p.ext).

Split the filename extension from this path and return the two parts. Either part may be empty.

The extension is everything from ‘.’ to the end of the last path segment. This has the property that if (a, b) == p.splitext(), then a + b == p.

splitlines

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

splitpath()

startswith

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

stat()

Perform a stat() system call on this path.

statvfs()

Perform a statvfs() system call on this path.

strip

S.strip([chars]) -> string or unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

stripext()

p.stripext() -> Remove one file extension from the path.

For example, path(‘/home/guido/python.tar.gz’).stripext() returns path(‘/home/guido/python.tar’).

supports(interface_type)

Returns:True if this instance supports the interface of the given type Parameter:interface_type – Type of the interface you require this instance to support Note:Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase

S.swapcase() -> string

Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

symlink(newlink)

Create a symbolic link at ‘newlink’, pointing here.

Returns:Path to newlink

text(encoding=None, errors='strict')

Open this file, read it in, return the content as a string.

This uses “U” mode in Python 2.3 and later, so “rn” and “r” are automatically translated to ‘n’.

Optional arguments:

• encoding - The Unicode encoding (or character set) of the file. If present, the content of the file is decoded and returned as a unicode object; otherwise it is returned as an 8-bit str.
• errors - How to handle Unicode errors; see help(str.decode) for the options. Default is ‘strict’.

title

S.title() -> string

Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

tolinuxpath()

Returns:A path using only slashes as path separator

tonative()

Convert the path separator to the type required by the current operating system - on windows / becomes and on linux becomes /

Returns:native version of self

touch(flags=65, mode=438)

Set the access/modified times of this file to the current time. Create the file if it does not exist.

Returns:self

translate

S.translate(table [,deletechars]) -> string

Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.

unlink()

unlink this file

Returns:self

upper

S.upper() -> string

Return a copy of the string S converted to uppercase.

walk(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca320>)

create iterator over files and subdirs, recursively.

The iterator yields path objects naming each child item of this directory and its descendants.

It performs a depth-first traversal of the directory tree. Each directory is returned just before all its children.

Parameters:

• pattern – fnmatch compatible pattern or None
• errors – controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via log.warn(), and ‘ignore’.
• predicate – returns True for each Path p to be yielded by iterator

walkdirs(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca410>)

D.walkdirs() -> iterator over subdirs, recursively. see walk for a parameter description

walkfiles(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca500>)

D.walkfiles() -> iterator over files in D, recursively. see walk for a parameter description

write_bytes(bytes, append=False)

Open this file and write the given bytes to it.

Default behavior is to overwrite any existing file. Call p.write_bytes(bytes, append=True) to append instead. :return: self

write_lines(lines, encoding=None, errors='strict', linesep='n', append=False)

Write the given lines of text to this file.

By default this overwrites any existing file at this path.

This puts a platform-specific newline sequence on every line. See ‘linesep’ below.

lines - A list of strings.

encoding - A Unicode encoding to use. This applies only if

‘lines’ contains any Unicode strings.

errors - How to handle errors in Unicode encoding. This

also applies only to Unicode strings.

linesep - The desired line-ending. This line-ending is

applied to every line. If a line already has any standard line ending, that will be stripped off and this will be used instead. The default is os.linesep, which is platform-dependent (‘rn’ on Windows, ‘n’ on Unix, etc.) Specify None to write the lines as-is, like file.writelines().

Use the keyword argument append=True to append lines to the file. The default is to overwrite the file. Warning: When you use this with Unicode data, if the encoding of the existing data in the file is different from the encoding you specify with the encoding= parameter, the result is mixed-encoding data, which can really confuse someone trying to read the file later.

Returns:self

write_text(text, encoding=None, errors='strict', linesep='n', append=False)

Write the given text to this file.

The default behavior is to overwrite any existing file; to append instead, use the ‘append=True’ keyword argument.

There are two differences between path.write_text() and path.write_bytes(): newline handling and Unicode handling. See below.

Parameters:

• text - str/unicode - The text to be written.

• encoding - str - The Unicode encoding that will be used.

  This is ignored if ‘text’ isn’t a Unicode string.

• errors - str - How to handle Unicode encoding errors.

  Default is ‘strict’. See help(unicode.encode) for the options. This is ignored if ‘text’ isn’t a Unicode string.

• linesep - keyword argument - str/unicode - The sequence of

  characters to be used to mark end-of-line. The default is os.linesep. You can also specify None; this means to leave all newlines as they are in ‘text’.

• append - keyword argument - bool - Specifies what to do if

  the file already exists (True: append to the end of it; False: overwrite it.) The default is False.

Newline handling:

• write_text() converts all standard end-of-line sequences

  (“n”, “r”, and “rn”) to your platforms default end-of-line sequence (see os.linesep; on Windows, for example, the end-of-line marker is “rn”).

• If you don’t like your platform’s default, you can override it

  using the “linesep=” keyword argument. If you specifically want write_text() to preserve the newlines as-is, use “linesep=None”.

• This applies to Unicode text the same as to 8-bit text, except

  there are additional standard Unicode end-of-line sequences, check the code to see them.

• (This is slightly different from when you open a file for

  writing with fopen(filename, “w”) in C or file(filename, “w”) in Python.)

Unicode:

If “text” isn’t Unicode, then apart from newline handling, the bytes are written verbatim to the file. The “encoding” and ‘errors’ arguments are not used and must be omitted.

If ‘text’ is Unicode, it is first converted to bytes using the specified ‘encoding’ (or the default encoding if ‘encoding’ isn’t specified). The ‘errors’ argument applies only to this conversion.

Returns:self

zfill

S.zfill(width) -> string

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.path.Path

class mrv.path.Path

Bases: str, mrv.interface.iDagItem

Represents a filesystem path.

For documentation on individual methods, consult their counterparts in os.path.

abspath()

access(mode)

Return true if current user has access to this path.

mode - One of the constants os.F_OK, os.R_OK, os.W_OK, os.X_OK

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

atime()

basename(p)

Returns the final component of a pathname

bytes()

Open this file, read all bytes, return them as a string.

capitalize

S.capitalize() -> string

Return a copy of the string S with only its first character capitalized.

center

S.center(width[, fillchar]) -> string

Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

children(predicate=<function <lambda> at 0x7f41dd7c72a8>, pattern=None)

Returns:

child paths as retrieved by queryiing the file system.

Note:

files cannot have children, and willl return an empty array accordingly

Parameters:

• predicate – return p if predicate( p ) returns True
• pattern – list only elements that match the given simple pattern i.e. .

childrenDeep(order=1, predicate=<function <lambda> at 0x7f41dd7c5050>)

Returns:

list of all children of path, [ child1 , child2 ]

Parameters:

• order – order enumeration
• predicate – returns true if x may be returned

Note:

the child objects returned are supposed to be valid paths, not just relative paths

chmod(mode)

Change file mode

Returns:self

chown(uid, gid)

Change file ownership

Returns:self

chroot()

Change the root directory path

Returns:self

containsvars()

Returns:True if this path contains environment variables

convert_separators()

Returns:Version of self with all separators set to be ‘sep’. The difference

to normpath is that it does not cut trailing separators

copy(dest)

Copy data and source bits to dest

Returns:Path to dest

copy2(dest)

Shutil.copy2 self to dest

Returns:Path to dest

copyfile(dest)

Copy self to dest

Returns:Path to dest

copymode(dest)

Copy our mode to dest

Returns:Path to dest

copystat(dest)

Copy our stats to dest

Returns:Path to dest

copytree(dest, **kwargs)

Deep copy this file or directory to destination

Parameter:kwargs – passed to shutil.copytree Returns:Path to dest

count

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

ctime()

decode

S.decode([encoding[,errors]]) -> object

Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeDecodeError. Other possible values are ‘ignore’ and ‘replace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

digest(hashobject)

Calculate the hash for this file using the given hashobject. It must support the ‘update’ and ‘digest’ methods.

Note:This reads through the entire file.

dirname()

dirs(pattern=None)

D.dirs() -> List of this directory’s subdirectories.

The elements of the list are path objects. This does not walk recursively into subdirectories (but see path.walkdirs).

With the optional pattern argument, this only lists directories whose names match the given pattern. For example, d.dirs(“build-*”).

drive()

The drive specifier, for example ‘C:’. This is always empty on systems that don’t use drive specifiers.

encode

S.encode([encoding[,errors]]) -> object

Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

endswith

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

exists()

expand()

Clean up a filename by calling expandvars() and expanduser()

This is commonly everything needed to clean up a filename read from a configuration file, for example.

If you are not interested in trailing slashes, you should call normpath() on the resulting Path as well.

expand_or_raise()

Returns:Copy of self with all variables expanded ( using expand )

non-recursively !

Raises ValueError:  If we could not expand all environment variables as their values where missing in the environment

expandtabs

S.expandtabs([tabsize]) -> string

Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

expanduser()

expandvars()

expandvars_deep()

Expands all environment variables recursively

expandvars_deep_or_raise()

Expands all environment variables recursively, and raises ValueError if the path still contains variables afterwards

ext()

The file extension, for example ‘.py’.

files(pattern=None)

D.files() -> List of the files in this directory.

The elements of the list are path objects. This does not walk into subdirectories (see path.walkfiles).

With the optional pattern argument, this only lists files whose names match the given pattern. For example, d.files(“*.pyc”).

find

S.find(sub [,start [,end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

fnmatch(pattern)

Return True if self.basename() matches the given pattern.

pattern - A filename pattern with wildcards,

for example “*.py”.

format

S.format(*args, **kwargs) -> unicode

fullChildName(childname)

Add the given name to the string version of our instance :return: string with childname added like name _sep childname

classmethod getcwd()

Returns:the current working directory as a path object.

glob(pattern)

Return a list of path objects that match the pattern.

pattern - a path relative to this directory, with wildcards.

For example, path(‘/users’).glob(‘/bin/‘) returns a list of all the files users have in their bin directories.

index

S.index(sub [,start [,end]]) -> int

Like S.find() but raise ValueError when the substring is not found.

isPartOf(other)

Returns:True if self is a part of other, and thus can be found in other Note:operates on strings only

isRoot()

Returns:True if this path is the root of the DAG

isRootOf(other)

Returns:True other starts with self Note:operates on strings Note:we assume other has the same type as self, thus the same separator

isWritable()

Returns:true if the file can be written to

isabs(s)

Test whether a path is absolute

isalnum

S.isalnum() -> bool

Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

isalpha

S.isalpha() -> bool

Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

isdigit

S.isdigit() -> bool

Return True if all characters in S are digits and there is at least one character in S, False otherwise.

isdir()

isfile()

islink()

islower

S.islower() -> bool

Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

ismount()

isspace

S.isspace() -> bool

Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

istitle

S.istitle() -> bool

Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

isupper

S.isupper() -> bool

Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)

Returns:generator retrieving all parents up to the root Parameter:predicate – returns True for all x that you want to be returned

join

S.join(iterable) -> string

Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

joinpath(*args)

Join two or more path components, adding a separator character (os.sep) if needed. Returns a new path object.

lexists()

lines(encoding=None, errors='strict', retain=True)

Open this file, read all lines, return them in a list.

Optional arguments:

• encoding: The Unicode encoding (or character set) of

  the file. The default is None, meaning the content of the file is read as 8-bit characters and returned as a list of (non-Unicode) str objects.

• errors: How to handle Unicode errors; see help(str.decode)

  for the options. Default is ‘strict’

• retain: If true, retain newline characters; but all newline

  character combinations (“r”, “n”, “rn”) are translated to “n”. If false, newline characters are stripped off. Default is True.

This uses “U” mode in Python 2.3 and later.

link(newpath)

Create a hard link at ‘newpath’, pointing to this file.

Returns:Path to newpath

listdir(pattern=None)

return list of items in this directory.

Use D.files() or D.dirs() instead if you want a listing of just files or just subdirectories.

The elements of the list are path objects.

With the optional ‘pattern’ argument, this only lists items whose names match the given pattern.

ljust

S.ljust(width[, fillchar]) -> string

Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

lower

S.lower() -> string

Return a copy of the string S converted to lowercase.

lstat()

Like path.stat(), but do not follow symbolic links.

lstrip

S.lstrip([chars]) -> string or unicode

Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

makedirs(mode=511)

Smarter makedir, see os.makedirs

Returns:self

mkdir(mode=511)

Make this directory, fail if it already exists

Returns:self

move(dest)

Move self to dest

Returns:Path to dest

mtime()

namebase()

The same as path.basename(), but with one file extension stripped off.

For example, path(‘/home/guido/python.tar.gz’).name == ‘python.tar.gz’, but path(‘/home/guido/python.tar.gz’).namebase == ‘python.tar’

normcase()

normpath()

open(*args, **kwargs)

Open this file. Return a file object.

owner()

Return the name of the owner of this file or directory.

This follows symbolic links.

On Windows, this returns a name of the form ur’DOMAINUser Name’. On Windows, a group can own a file or directory.

parent()

Returns:the parent directory of this Path or None if this is the root

parentDeep()

Returns:all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

partition

S.partition(sep) -> (head, sep, tail)

Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

pathconf(name)

see os.pathconf

readlink()

Return the path to which this symbolic link points.

The result may be an absolute or a relative path.

readlinkabs()

Return the path to which this symbolic link points.

The result is always an absolute path.

realpath()

relpath()

Return this path as a relative path, originating from the current working directory.

relpathfrom(dest)

Return a relative path from dest to self

relpathto(dest)

Return a relative path from self to dest.

If there is no relative path from self to dest, for example if they reside on different drives in Windows, then this returns dest.abspath().

remove()

Remove this file

Returns:self

removedirs()

see os.removedirs

Returns:self

rename(new)

os.rename

Returns:Path to new file

renames(new)

os.renames, super rename

Returns:Path to new file

replace

S.replace (old, new[, count]) -> string

Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

rfind

S.rfind(sub [,start [,end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within s[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex

S.rindex(sub [,start [,end]]) -> int

Like S.rfind() but raise ValueError when the substring is not found.

rjust

S.rjust(width[, fillchar]) -> string

Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

rmdir()

Remove this empty directory

Returns:self

rmtree(**kwargs)

Remove self recursively

Parameter:kwargs – passed to shutil.rmtree Returns:self

root()

Returns:the root of the DAG - it has no further parents

rpartition

S.rpartition(sep) -> (head, sep, tail)

Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

rsplit

S.rsplit([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

rstrip

S.rstrip([chars]) -> string or unicode

Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

samefile(other)

classmethod set_separator(sep)

Set this type to support the given separator as general path separator

setutime(times)

Set the access and modified times of this file.

Returns:self

size()

split

S.split([sep [,maxsplit]]) -> list of strings

Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

splitall()

Return a list of the path components in this path.

The first item in the list will be a path. Its value will be either os.curdir, os.pardir, empty, or the root directory of this path (for example, ‘/’ or ‘C:’). The other items in the list will be strings.

path.path.joinpath(*result) can possibly yield the original path, depending on the input.

splitdrive()

p.splitdrive() -> Return (p.drive, <the rest of p>).

Split the drive specifier from this path. If there is no drive specifier, p.drive is empty, so the return value is simply (path(‘’), p). This is always the case on Unix.

splitext()

p.splitext() -> Return (p.stripext(), p.ext).

Split the filename extension from this path and return the two parts. Either part may be empty.

The extension is everything from ‘.’ to the end of the last path segment. This has the property that if (a, b) == p.splitext(), then a + b == p.

splitlines

S.splitlines([keepends]) -> list of strings

Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

splitpath()

p.splitpath() -> Return (p.parent(), p.basename()).

startswith

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

stat()

Perform a stat() system call on this path.

statvfs()

Perform a statvfs() system call on this path.

strip

S.strip([chars]) -> string or unicode

Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

stripext()

p.stripext() -> Remove one file extension from the path.

For example, path(‘/home/guido/python.tar.gz’).stripext() returns path(‘/home/guido/python.tar’).

supports(interface_type)

Returns:True if this instance supports the interface of the given type Parameter:interface_type – Type of the interface you require this instance to support Note:Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

swapcase

S.swapcase() -> string

Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

symlink(newlink)

Create a symbolic link at ‘newlink’, pointing here.

Returns:Path to newlink

text(encoding=None, errors='strict')

Open this file, read it in, return the content as a string.

This uses “U” mode in Python 2.3 and later, so “rn” and “r” are automatically translated to ‘n’.

Optional arguments:

• encoding - The Unicode encoding (or character set) of the file. If present, the content of the file is decoded and returned as a unicode object; otherwise it is returned as an 8-bit str.
• errors - How to handle Unicode errors; see help(str.decode) for the options. Default is ‘strict’.

title

S.title() -> string

Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

tolinuxpath()

Returns:A path using only slashes as path separator

tonative()

Convert the path separator to the type required by the current operating system - on windows / becomes and on linux becomes /

Returns:native version of self

touch(flags=65, mode=438)

Set the access/modified times of this file to the current time. Create the file if it does not exist.

Returns:self

translate

S.translate(table [,deletechars]) -> string

Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256.

unlink()

unlink this file

Returns:self

upper

S.upper() -> string

Return a copy of the string S converted to uppercase.

walk(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca320>)

create iterator over files and subdirs, recursively.

The iterator yields path objects naming each child item of this directory and its descendants.

It performs a depth-first traversal of the directory tree. Each directory is returned just before all its children.

Parameters:

• pattern – fnmatch compatible pattern or None
• errors – controls behavior when an error occurs. The default is ‘strict’, which causes an exception. The other allowed values are ‘warn’, which reports the error via log.warn(), and ‘ignore’.
• predicate – returns True for each Path p to be yielded by iterator

walkdirs(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca410>)

D.walkdirs() -> iterator over subdirs, recursively. see walk for a parameter description

walkfiles(pattern=None, errors='strict', predicate=<function <lambda> at 0x7f41dd7ca500>)

D.walkfiles() -> iterator over files in D, recursively. see walk for a parameter description

write_bytes(bytes, append=False)

Open this file and write the given bytes to it.

Default behavior is to overwrite any existing file. Call p.write_bytes(bytes, append=True) to append instead. :return: self

write_lines(lines, encoding=None, errors='strict', linesep='n', append=False)

Write the given lines of text to this file.

By default this overwrites any existing file at this path.

This puts a platform-specific newline sequence on every line. See ‘linesep’ below.

lines - A list of strings.

encoding - A Unicode encoding to use. This applies only if

‘lines’ contains any Unicode strings.

errors - How to handle errors in Unicode encoding. This

also applies only to Unicode strings.

linesep - The desired line-ending. This line-ending is

applied to every line. If a line already has any standard line ending, that will be stripped off and this will be used instead. The default is os.linesep, which is platform-dependent (‘rn’ on Windows, ‘n’ on Unix, etc.) Specify None to write the lines as-is, like file.writelines().

Use the keyword argument append=True to append lines to the file. The default is to overwrite the file. Warning: When you use this with Unicode data, if the encoding of the existing data in the file is different from the encoding you specify with the encoding= parameter, the result is mixed-encoding data, which can really confuse someone trying to read the file later.

Returns:self

write_text(text, encoding=None, errors='strict', linesep='n', append=False)

Write the given text to this file.

The default behavior is to overwrite any existing file; to append instead, use the ‘append=True’ keyword argument.

There are two differences between path.write_text() and path.write_bytes(): newline handling and Unicode handling. See below.

Parameters:

• text - str/unicode - The text to be written.

• encoding - str - The Unicode encoding that will be used.

  This is ignored if ‘text’ isn’t a Unicode string.

• errors - str - How to handle Unicode encoding errors.

  Default is ‘strict’. See help(unicode.encode) for the options. This is ignored if ‘text’ isn’t a Unicode string.

• linesep - keyword argument - str/unicode - The sequence of

  characters to be used to mark end-of-line. The default is os.linesep. You can also specify None; this means to leave all newlines as they are in ‘text’.

• append - keyword argument - bool - Specifies what to do if

  the file already exists (True: append to the end of it; False: overwrite it.) The default is False.

Newline handling:

• write_text() converts all standard end-of-line sequences

  (“n”, “r”, and “rn”) to your platforms default end-of-line sequence (see os.linesep; on Windows, for example, the end-of-line marker is “rn”).

• If you don’t like your platform’s default, you can override it

  using the “linesep=” keyword argument. If you specifically want write_text() to preserve the newlines as-is, use “linesep=None”.

• This applies to Unicode text the same as to 8-bit text, except

  there are additional standard Unicode end-of-line sequences, check the code to see them.

• (This is slightly different from when you open a file for

  writing with fopen(filename, “w”) in C or file(filename, “w”) in Python.)

Unicode:

If “text” isn’t Unicode, then apart from newline handling, the bytes are written verbatim to the file. The “encoding” and ‘errors’ arguments are not used and must be omitted.

If ‘text’ is Unicode, it is first converted to bytes using the specified ‘encoding’ (or the default encoding if ‘encoding’ isn’t specified). The ‘errors’ argument applies only to this conversion.

Returns:self

zfill

S.zfill(width) -> string

Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

Epydoc: mrv.path

Epydoc: mrv.path

class mrv.path.iDagItem

Bases: mrv.interface.Interface

Describes interface for a DAG item. Its used to unify interfaces allowing to access objects in a dag like graph Of the underlying object has a string representation, the defatult implementation will work natively. Otherwise the getParent and getChildren methods should be overwritten

Note:a few methods of this class are abstract and need to be overwritten Note:this class expects the attribute ‘_sep’ to exist containing the separator at which your object should be split ( for default implementations ). This works as the passed in pointer will belong to derived classes that can define that attribute on instance or on class level

classmethod addSep(item, sep)

Returns:

item with separator added to it ( just once )

Note:

operates best on strings

Parameters:

• item – item to add separator to
• sep – the separator

basename()

Returns:basename of this path, ‘/hello/world’ -> ‘world’

children(predicate=<function <lambda> at 0x7f41dd7c2ed8>)

Returns:list of intermediate children of path, [ child1 , child2 ] Parameter:predicate – return True to include x in result Note:the child objects returned are supposed to be valid paths, not just relative paths

childrenDeep(order=1, predicate=<function <lambda> at 0x7f41dd7c5050>)

Returns:

list of all children of path, [ child1 , child2 ]

Parameters:

• order – order enumeration
• predicate – returns true if x may be returned

Note:

the child objects returned are supposed to be valid paths, not just relative paths

fullChildName(childname)

Add the given name to the string version of our instance :return: string with childname added like name _sep childname

isPartOf(other)

Returns:True if self is a part of other, and thus can be found in other Note:operates on strings only

isRoot()

Returns:True if this path is the root of the DAG

isRootOf(other)

Returns:True other starts with self Note:operates on strings Note:we assume other has the same type as self, thus the same separator

iterParents(predicate=<function <lambda> at 0x7f41dd7c5230>)

Returns:generator retrieving all parents up to the root Parameter:predicate – returns True for all x that you want to be returned

parent()

Returns:parent of this path, ‘/hello/world’ -> ‘/hello’ or None if this path is the dag’s root

parentDeep()

Returns:all parents of this path, ‘/hello/my/world’ -> [ ‘/hello/my’,’/hello’ ]

root()

Returns:the root of the DAG - it has no further parents

supports(interface_type)

Returns:True if this instance supports the interface of the given type Parameter:interface_type – Type of the interface you require this instance to support Note:Must be used in case you only have a weak reference of your interface instance or proxy which is a case where the ordinary isinstance( obj, iInterface ) will not work

Exceptions

Epydoc: mrv.path.TreeWalkWarning

class mrv.path.TreeWalkWarning

Bases: exceptions.Warning

args

message