Module Command

An augmented version of glob.glob()

Parameters:

• showhidden - if True, return matching files that start with '.' as well
• hidenonexistent - if True return arg unchanged if nothing matches

  The latter is usefull to define two different behaviours:

  e.q. touch('aaa') creates a file, if 'aaa' doesn't exist but ls('aaa') returns nothing if 'aaa' does not exist.

Returns:

a (possibly empty) list of filenames that match arg

Process a number of files one by one and write the results to a file.

Note that this is different from the mux() funtion:

   mux()    operates on src,dst filename-pairs
   bunch()  operates on the contents of several src files and writes to a dst file

A processor is passed by the keyword parameter and should be a class that implements the blockprocess interface. By default a simple copy processor is used.

The blockprocess interface:

   __init__() initializes a blockprocessor,
   process(iterator) iterates over iterator (typically a file object or a list of lines)
   end() ends the processing of input
   results() a generator that returns results.

Copy data and all stat info if src is newer ("cp -pu src dst").

The destination may be a directory.

The source is also considered newer if the destination does not exist.

Returns:

1 if file is copied, 0 otherwise

Recursively copy a directory tree using copy2().

The destination directory must not already exist, unless update=True.

If exception(s) occur, an Error is raised with a list of reasons.

If the optional symlinks flag is true, symbolic links in the source tree result in symbolic links in the destination tree; if it is false, the contents of the files pointed to by symbolic links are copied.

The optional ignore_pattern argument is a callable. If given, it is called with the `src` parameter, which is the directory being visited by copytree(), and `names` which is the list of `src` contents, as returned by os.listdir():

   callable(src, names) -> ignored_names

Since copytree() is called recursively, the callable will be called once for each directory that is copied. It returns a list of names relative to the `src` directory that should not be copied.

The optional update flag ensures that files are only copied if the source is newer than the destination or if the destination does not exist.

Note that this if a rather straightforward reimplementation of the shutil.copytree() function present in python 2.x and 3.x including most of the documentation.

Returns:

the number of files copied.

Flatten a list of filenames, directory names a glob patterns to a single flat list of filenames.

Example:

expand('filea',['fileb','filec'],'*.txt')

might result in (depending on the content of the globbed dir):

['filea','fileb','filec','a.txt','b.txt']

args that contain no glob chars ('?' or '*') are not globbed.

Parameters:

• args - a (possibly nested) list of strings or glob patterns.
• directories - if True names of directories are included in the result.

Returns:

a list of strings (i.e. filenames although they need pot exist.)

Copy the contents of one or more source.files to destination while filtering each line through a filter.

process=copy unchanged by default, see 'substitute()' for a more meaningfull application.

Note: source.filenames prefixed with a minus sign '-' are processed but not written to the destination.

Parameters:

• args (str) - files, last one is destination.
• ignore - if True all errors are ignored.

Returns:

nothing.

return a (possibly nested) list of iterables as a single flat listen. Strings are *not* flattened. For examples see expand().

Expand a (possibly nested) list of strings and globs and open all resulting filenames. Return a single iterator that will iterate over all lines in all opend files.

Example:

   for line in lopen('*.txt'):
       print line,

will print all lines of all text files in the current directory.

multiplex a function to any number of sourcefiles.

mux() calls function f() with a src and a dst argument and any keyword arguments are passed along. After expanding 'args' (see expand), dst is the last element of the resulting list and src is from the rest of the list, but one by one. So, say you have a function A(src,dst) a call like:

   mux(A,'*.txt','*.doc','summary.dat')

is equivalent to:

   A('a.txt','summary.dat')
   A('b.txt','summary.dat')
   A('c.doc','summary.dat')

depending on the actual files that match of course.

Parameters:

• f - a function (callable) that takes two string arguments.
• args - a (possibly nested) list of strings or glob patterns.

Returns:

nothing.

multiplex a function to any number of sourcefiles.

muxnodst() calls function f() with a single argument and any keyword arguments are passed along. After expanding 'args' (see expand), each argument is taken is from the resulting list, one by one. So, say you have a function A(src) a call like:

   mux(A,'*.txt','*.doc')

is equivalent to:

   A('a.txt')
   A('b.txt')
   A('c.doc')

depending on the actual files that match of course.

Parameters:

• f - a function (callable) that takes one string argument.
• args - a (possibly nested) list of strings or glob patterns.

Returns:

nothing.

__nonpipeable__

Value:

['touch', 'cp', 'sshupdate', 'rm', 'mkdir', 'mv', 'substitute', 'call', ...

__pipeable__

Value:

['cat', 'grep', 'egrep', 'sort', 'tee', 'uniq', 'infile', 'outfile', ...

__utils__

Value:

['mux', 'muxnodst', 'bunch', 'expand', 'lopen', 'flatten', 'copy3', 'copytree2', ...