ranger.ext.shutil_generatorized
index
../../ranger/ext/shutil_generatorized.py

Utility functions for copying files and directory trees.
 
XXX The functions here don't copy the resource fork or other metadata on Mac.

 
Modules
       
os
stat
sys

 
Classes
       
builtins.OSError(builtins.Exception)
Error
SpecialFileError

 
class Error(builtins.OSError)
    
Method resolution order:
Error
builtins.OSError
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.OSError:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__(...)
__str__(self, /)
Return str(self).

Data descriptors inherited from builtins.OSError:
characters_written
errno
POSIX exception code
filename
exception filename
filename2
second exception filename
strerror
exception strerror

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class SpecialFileError(builtins.OSError)
    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)
 
 
Method resolution order:
SpecialFileError
builtins.OSError
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.OSError:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__(...)
__str__(self, /)
Return str(self).

Data descriptors inherited from builtins.OSError:
characters_written
errno
POSIX exception code
filename
exception filename
filename2
second exception filename
strerror
exception strerror

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
Functions
       
copy2(src, dst, overwrite=False, symlinks=False)
Copy data and all stat info ("cp -p src dst").
 
The destination may be a directory.
copyfile(src, dst)
Copy data from src to dst
copyfileobj(fsrc, fdst, length=16384)
copy data from file-like object fsrc to file-like object fdst
copystat(src, dst)
Copy all stat info (mode bits, atime, mtime, flags) from src to dst
copytree(src, dst, symlinks=False, ignore=None, overwrite=False)
Recursively copy a directory tree using copy2().
 
The destination directory must not already exist.
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 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.
 
XXX Consider this example code rather than the ultimate tool.
move(src, dst, overwrite=False)
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.
rmtree(path, ignore_errors=False, onerror=None)
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.

 
Data
        BLOCK_SIZE = 16384
__all__ = ['copyfileobj', 'copyfile', 'copystat', 'copy2', 'BLOCK_SIZE', 'copytree', 'move', 'rmtree', 'Error', 'SpecialFileError']