ranger - mirror of ranger - a simple, vim-like file manager

diff options

Diffstat (limited to 'doc')

0 files changed, 0 insertions, 0 deletions

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

<!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"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big><a href="ranger.html">ranger</a>.<a href="ranger.ext.html">ext</a>.shutil_generatorized</big></big></td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:/home/hut/work/ranger/ranger/ext/shutil_generatorized.py">/home/hut/work/ranger/ranger/ext/shutil_generatorized.py</a></td></tr></table> <tt>Utility functions for copying files and directory trees.   XXX The functions here don't copy the resource fork or other metadata on Mac.</tt> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom>  <big>Modules</big></td></tr> <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="fnmatch.html">fnmatch</a> </td><td width="25%" valign=top><a href="os.html">os</a> </td><td width="25%" valign=top><a href="stat.html">stat</a> </td><td width="25%" valign=top><a href="sys.html">sys</a> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%"><dl> <dt><a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>(<a href="builtins.html#Exception">builtins.Exception</a>) </dt><dd> <dl> <dt><a href="ranger.ext.shutil_generatorized.html#Error">Error</a> </dt><dt><a href="ranger.ext.shutil_generatorized.html#SpecialFileError">SpecialFileError</a> </dt></dl> </dd> </dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="Error">class Error</a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>)</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> </dl> <hr> Data descriptors defined here: <dl><dt>__weakref__</dt> <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>: <dl><dt><a name="Error-__init__">__init__</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__">__reduce__</a>(...)</dt></dl> <dl><dt><a name="Error-__str__">__str__</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>: <dl><dt>errno</dt> <dd><tt>exception errno</tt></dd> </dl> <dl><dt>filename</dt> <dd><tt>exception filename</tt></dd> </dl> <dl><dt>strerror</dt> <dd><tt>exception strerror</tt></dd> </dl> <hr> Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>: <dl><dt>__new__ = <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> <hr> Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt><a name="Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> <dl><dt><a name="Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> <dl><dt><a name="Error-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> <dl><dt><a name="Error-__setattr__">__setattr__</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__">__setstate__</a>(...)</dt></dl> <dl><dt><a name="Error-with_traceback">with_traceback</a>(...)</dt><dd><tt>Exception.<a href="#Error-with_traceback">with_traceback</a>(tb) -- set self.__traceback__ to tb and return self.</tt></dd></dl> <hr> Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt>__cause__</dt> <dd><tt>exception cause</tt></dd> </dl> <dl><dt>__context__</dt> <dd><tt>exception context</tt></dd> </dl> <dl><dt>__dict__</dt> </dl> <dl><dt>__traceback__</dt> </dl> <dl><dt>args</dt> </dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="SpecialFileError">class SpecialFileError</a>(<a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>)</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 not supported on a special file (e.g. a named pipe)  </tt></td></tr> <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> </dl> <hr> Data descriptors defined here: <dl><dt>__weakref__</dt> <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>: <dl><dt><a name="SpecialFileError-__init__">__init__</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__">__reduce__</a>(...)</dt></dl> <dl><dt><a name="SpecialFileError-__str__">__str__</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>: <dl><dt>errno</dt> <dd><tt>exception errno</tt></dd> </dl> <dl><dt>filename</dt> <dd><tt>exception filename</tt></dd> </dl> <dl><dt>strerror</dt> <dd><tt>exception strerror</tt></dd> </dl> <hr> Data and other attributes inherited from <a href="builtins.html#EnvironmentError">builtins.EnvironmentError</a>: <dl><dt>__new__ = <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> <hr> Methods inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt><a name="SpecialFileError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> <dl><dt><a name="SpecialFileError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> <dl><dt><a name="SpecialFileError-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#SpecialFileError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> <dl><dt><a name="SpecialFileError-__setattr__">__setattr__</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__">__setstate__</a>(...)</dt></dl> <dl><dt><a name="SpecialFileError-with_traceback">with_traceback</a>(...)</dt><dd><tt>Exception.<a href="#SpecialFileError-with_traceback">with_traceback</a>(tb) -- set self.__traceback__ to tb and return self.</tt></dd></dl> <hr> Data descriptors inherited from <a href="builtins.html#BaseException">builtins.BaseException</a>: <dl><dt>__cause__</dt> <dd><tt>exception cause</tt></dd> </dl> <dl><dt>__context__</dt> <dd><tt>exception context</tt></dd> </dl> <dl><dt>__dict__</dt> </dl> <dl><dt>__traceback__</dt> </dl> <dl><dt>args</dt> </dl> </td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#eeaa77"> <td colspan=3 valign=bottom>  <big>Functions</big></td></tr> <tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td> <td width="100%"><dl><dt><a name="-copy">copy</a>(src, dst)</dt><dd><tt>Copy data and mode bits ("cp src dst").   The destination may be a directory.</tt></dd></dl> <dl><dt><a name="-copy2">copy2</a>(src, dst)</dt><dd><tt>Copy data and all stat info ("cp -p src dst").   The destination may be a directory.</tt></dd></dl> <dl><dt><a name="-copyfile">copyfile</a>(src, dst)</dt><dd><tt>Copy data from src to dst</tt></dd></dl> <dl><dt><a name="-copyfileobj">copyfileobj</a>(fsrc, fdst, length=16384)</dt><dd><tt>copy data from file-like object fsrc to file-like object fdst</tt></dd></dl> <dl><dt><a name="-copymode">copymode</a>(src, dst)</dt><dd><tt>Copy mode bits from src to dst</tt></dd></dl> <dl><dt><a name="-copystat">copystat</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">copytree</a>(src, dst, symlinks=False, ignore=None)</dt><dd><tt>Recursively copy a directory tree using <a href="#-copy2">copy2</a>().   The destination directory must not already exist. If exception(s) occur, an <a href="#Error">Error</a> 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 argument is a callable. If given, it is called with the `src` parameter, which is the directory being visited by <a href="#-copytree">copytree</a>(), and `names` which is the list of `src` contents, as returned by os.listdir():       callable(src, names) -> ignored_names   Since <a href="#-copytree">copytree</a>() 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.   XXX Consider this example code rather than the ultimate tool.</tt></dd></dl> <dl><dt><a name="-move">move</a>(src, dst)</dt><dd><tt>Recursively move a file or directory to another location. This is similar to the Unix "mv" command.   If the destination is a directory or a symlink to a directory, the source is moved inside the directory. The destination path must not already exist.   If the destination already exists but is not a directory, it may be overwritten depending on os.rename() semantics.   If the destination is on our current filesystem, then rename() is used. Otherwise, src is copied to the destination and then removed. A lot more could be done here...  A look at a mv.c shows a lot of the issues this implementation glosses over.</tt></dd></dl> <dl><dt><a name="-rmtree">rmtree</a>(path, ignore_errors=False, onerror=None)</dt><dd><tt>Recursively delete a directory tree.   If ignore_errors is set, errors are ignored; otherwise, if onerror is set, it is called to handle the error with arguments (func, path, exc_info) where func is os.listdir, os.remove, or os.rmdir; path is the argument to that function that caused it to fail; and exc_info is a tuple returned by sys.exc_info().  If ignore_errors is false and onerror is None, an exception is raised.</tt></dd></dl> </td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#55aa55"> <td colspan=3 valign=bottom>  <big>Data</big></td></tr> <tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td> <td width="100%">__all__ = ['copyfileobj', 'copyfile', 'copymode', 'copystat', 'copy', 'copy2', 'copytree', 'move', 'rmtree', 'Error', 'SpecialFileError']</td></tr></table> </body></html>


context:
space:
mode: