diff options
Diffstat (limited to 'doc/pydoc/ranger.ext.shutil_generatorized.html')
| -rw-r--r-- | doc/pydoc/ranger.ext.shutil_generatorized.html | 98 |
1 files changed, 49 insertions, 49 deletions
diff --git a/doc/pydoc/ranger.ext.shutil_generatorized.html b/doc/pydoc/ranger.ext.shutil_generatorized.html index 343f3fa5..8c768653 100644 --- a/doc/pydoc/ranger.ext.shutil_generatorized.html +++ b/doc/pydoc/ranger.ext.shutil_generatorized.html @@ -1,6 +1,6 @@ + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.ext.shutil_generatorized</title> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> @@ -8,7 +8,7 @@ <td valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.<a href="ranger.ext.html"><font color="#ffffff">ext</font></a>.shutil_generatorized</strong></big></big></font></td ><td align=right valign=bottom -><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/ext/shutil_generatorized.py">/home/hut/work/ranger/ranger/ext/shutil_generatorized.py</a></font></td></tr></table> +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/ranger/ranger/ext/shutil_generatorized.py">/home/hut/ranger/ranger/ext/shutil_generatorized.py</a></font></td></tr></table> <p><tt>Utility functions for copying files and directory trees.<br> <br> XXX The functions here don't copy the resource fork or other metadata on Mac.</tt></p> @@ -31,7 +31,7 @@ XXX The functions here don't copy the resourc <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> <td width="100%"><dl> -<dt><font face="helvetica, arial"><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>(<a href="builtins.html#Exception">builtins.Exception</a>) +<dt><font face="helvetica, arial"><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>(<a href="exceptions.html#StandardError">exceptions.StandardError</a>) </font></dt><dd> <dl> <dt><font face="helvetica, arial"><a href="ranger.ext.shutil_generatorized.html#Error">Error</a> @@ -43,15 +43,16 @@ XXX The functions here don't copy the resourc <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>)</font></td></tr> +<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>)</font></td></tr> <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.ext.shutil_generatorized.html#Error">Error</a></dd> -<dd><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a></dd> -<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> -<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> -<dd><a href="builtins.html#object">builtins.object</a></dd> +<dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd> +<dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> </dl> <hr> Data descriptors defined here:<br> @@ -59,7 +60,7 @@ Data descriptors defined here:<br> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> -Methods inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> <dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> <dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> @@ -67,7 +68,7 @@ Methods inherited from <a href="builtins.html#EnvironmentError">builtins.Environ <dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl> <hr> -Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> <dl><dt><strong>errno</strong></dt> <dd><tt>exception errno</tt></dd> </dl> @@ -78,43 +79,42 @@ Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtin <dd><tt>exception strerror</tt></dd> </dl> <hr> -Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> -<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f6a9223ec80><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> +Data and other attributes inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7fdbe7034c40><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> <hr> -Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> <dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> <dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> +<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + <dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> <dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> <dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> -<dl><dt><a name="Error-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt>Exception.<a href="#Error-with_traceback">with_traceback</a>(tb) --<br> -set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> +<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> <hr> -Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> -<dl><dt><strong>__cause__</strong></dt> -<dd><tt>exception cause</tt></dd> -</dl> -<dl><dt><strong>__context__</strong></dt> -<dd><tt>exception context</tt></dd> -</dl> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> <dl><dt><strong>__dict__</strong></dt> </dl> -<dl><dt><strong>__traceback__</strong></dt> -</dl> <dl><dt><strong>args</strong></dt> </dl> +<dl><dt><strong>message</strong></dt> +</dl> </td></tr></table> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="SpecialFileError">class <strong>SpecialFileError</strong></a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>)</font></td></tr> +<font color="#000000" face="helvetica, arial"><a name="SpecialFileError">class <strong>SpecialFileError</strong></a>(<a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>)</font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>Raised when trying to do a kind of operation (e.g. copying) which is<br> @@ -122,10 +122,11 @@ not supported on a special file (e.g. a <tr><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.ext.shutil_generatorized.html#SpecialFileError">SpecialFileError</a></dd> -<dd><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a></dd> -<dd><a href="builtins.html#Exception">builtins.Exception</a></dd> -<dd><a href="builtins.html#BaseException">builtins.BaseException</a></dd> -<dd><a href="builtins.html#object">builtins.object</a></dd> +<dd><a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a></dd> +<dd><a href="exceptions.html#StandardError">exceptions.StandardError</a></dd> +<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> +<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> </dl> <hr> Data descriptors defined here:<br> @@ -133,7 +134,7 @@ Data descriptors defined here:<br> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> -Methods inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +Methods inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> <dl><dt><a name="SpecialFileError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl> <dl><dt><a name="SpecialFileError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> @@ -141,7 +142,7 @@ Methods inherited from <a href="builtins.html#EnvironmentError">builtins.Environ <dl><dt><a name="SpecialFileError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> <hr> -Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> +Data descriptors inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> <dl><dt><strong>errno</strong></dt> <dd><tt>exception errno</tt></dd> </dl> @@ -152,38 +153,37 @@ Data descriptors inherited from <a href="builtins.html#EnvironmentError">builtin <dd><tt>exception strerror</tt></dd> </dl> <hr> -Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>:<br> -<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7f6a9223ec80><dd><tt>T.<a href="#SpecialFileError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> +Data and other attributes inherited from <a href="exceptions.html#EnvironmentError">exceptions.EnvironmentError</a>:<br> +<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object at 0x7fdbe7034c40><dd><tt>T.<a href="#SpecialFileError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> <hr> -Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> +Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> <dl><dt><a name="SpecialFileError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> <dl><dt><a name="SpecialFileError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> +<dl><dt><a name="SpecialFileError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> + +<dl><dt><a name="SpecialFileError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> + <br> +Use of negative indices is not supported.</tt></dd></dl> + <dl><dt><a name="SpecialFileError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> <dl><dt><a name="SpecialFileError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> <dl><dt><a name="SpecialFileError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> -<dl><dt><a name="SpecialFileError-with_traceback"><strong>with_traceback</strong></a>(...)</dt><dd><tt>Exception.<a href="#SpecialFileError-with_traceback">with_traceback</a>(tb) --<br> -set self.<strong>__traceback__</strong> to tb and return self.</tt></dd></dl> +<dl><dt><a name="SpecialFileError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> <hr> -Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>:<br> -<dl><dt><strong>__cause__</strong></dt> -<dd><tt>exception cause</tt></dd> -</dl> -<dl><dt><strong>__context__</strong></dt> -<dd><tt>exception context</tt></dd> -</dl> +Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> <dl><dt><strong>__dict__</strong></dt> </dl> -<dl><dt><strong>__traceback__</strong></dt> -</dl> <dl><dt><strong>args</strong></dt> </dl> +<dl><dt><strong>message</strong></dt> +</dl> </td></tr></table></td></tr></table><p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> @@ -191,17 +191,17 @@ Data descriptors inherited from <a href="builtins.html#BaseException">builtins.B <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> -<td width="100%"><dl><dt><a name="-copy"><strong>copy</strong></a>(src, dst)</dt><dd><tt>Copy data and mode bits ("cp src dst").<br> +<td width="100%"><dl><dt><a name="-copy"><strong>copy</strong></a>(src, dst, overwrite<font color="#909090">=False</font>)</dt><dd><tt>Copy data and mode bits ("cp src dst").<br> <br> The destination may be a directory.</tt></dd></dl> - <dl><dt><a name="-copy2"><strong>copy2</strong></a>(src, dst)</dt><dd><tt>Copy data and all stat info ("cp -p src dst").<br> + <dl><dt><a name="-copy2"><strong>copy2</strong></a>(src, dst, overwrite<font color="#909090">=False</font>, symlinks<font color="#909090">=False</font>)</dt><dd><tt>Copy data and all stat info ("cp -p src dst").<br> <br> The destination may be a directory.</tt></dd></dl> <dl><dt><a name="-copyfile"><strong>copyfile</strong></a>(src, dst)</dt><dd><tt>Copy data from src to dst</tt></dd></dl> <dl><dt><a name="-copyfileobj"><strong>copyfileobj</strong></a>(fsrc, fdst, length<font color="#909090">=16384</font>)</dt><dd><tt>copy data from file-like object fsrc to file-like object fdst</tt></dd></dl> <dl><dt><a name="-copymode"><strong>copymode</strong></a>(src, dst)</dt><dd><tt>Copy mode bits from src to dst</tt></dd></dl> <dl><dt><a name="-copystat"><strong>copystat</strong></a>(src, dst)</dt><dd><tt>Copy all stat info (mode bits, atime, mtime, flags) from src to dst</tt></dd></dl> - <dl><dt><a name="-copytree"><strong>copytree</strong></a>(src, dst, symlinks<font color="#909090">=False</font>, ignore<font color="#909090">=None</font>)</dt><dd><tt>Recursively copy a directory tree using <a href="#-copy2">copy2</a>().<br> + <dl><dt><a name="-copytree"><strong>copytree</strong></a>(src, dst, symlinks<font color="#909090">=False</font>, ignore<font color="#909090">=None</font>, overwrite<font color="#909090">=False</font>)</dt><dd><tt>Recursively copy a directory tree using <a href="#-copy2">copy2</a>().<br> <br> The destination directory must not already exist.<br> If exception(s) occur, an <a href="#Error">Error</a> is raised with a list of reasons.<br> @@ -224,7 +224,7 @@ list of names relative to the `src` directory not be copied.<br> <br> XXX Consider this example code rather than the ultimate tool.</tt></dd></dl> - <dl><dt><a name="-move"><strong>move</strong></a>(src, dst)</dt><dd><tt>Recursively move a file or directory to another location. This is<br> + <dl><dt><a name="-move"><strong>move</strong></a>(src, dst, overwrite<font color="#909090">=False</font>)</dt><dd><tt>Recursively move a file or directory to another location. This is<br> similar to the Unix "mv" command.<br> <br> If the destination is a directory or a symlink to a directory, the source<br> |