2015-03-22 06:18:45 +00:00
|
|
|
``fileutils`` - Filesystem helpers
|
|
|
|
|
==================================
|
2015-03-22 00:12:50 +00:00
|
|
|
|
|
|
|
|
.. automodule:: boltons.fileutils
|
2015-04-05 22:01:20 +00:00
|
|
|
|
|
|
|
|
Creating, Finding, and Copying
|
|
|
|
|
------------------------------
|
|
|
|
|
|
|
|
|
|
Python's :mod:`os`, :mod:`os.path`, and :mod:`shutil` modules provide
|
|
|
|
|
good coverage of file wrangling fundaments, and these functions help
|
|
|
|
|
close a few remaining gaps.
|
|
|
|
|
|
|
|
|
|
.. autofunction:: boltons.fileutils.mkdir_p
|
|
|
|
|
|
|
|
|
|
.. autofunction:: boltons.fileutils.iter_find_files
|
|
|
|
|
|
|
|
|
|
.. autofunction:: boltons.fileutils.copytree
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Atomic File Saving
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
Ideally, the road to success should never put current progress at
|
|
|
|
|
risk. That's why overwriting a file should only happen after the task
|
|
|
|
|
at hand has completed. And that's exactly what :func:`atomic_save` and
|
|
|
|
|
:class:`AtomicSaver` do.
|
|
|
|
|
|
|
|
|
|
.. autofunction:: boltons.fileutils.atomic_save
|
|
|
|
|
|
|
|
|
|
.. autoclass:: boltons.fileutils.AtomicSaver
|
|
|
|
|
|
2016-02-24 10:36:17 +00:00
|
|
|
.. autofunction:: boltons.fileutils.atomic_rename
|
|
|
|
|
|
|
|
|
|
.. autofunction:: boltons.fileutils.replace
|
|
|
|
|
|
2015-04-05 22:01:20 +00:00
|
|
|
File Permissions
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Linux, BSD, Mac OS, and other Unix-like operating systems all share a
|
|
|
|
|
simple, foundational file permission structure that is commonly
|
|
|
|
|
complicit in accidental access denial, as well as file
|
|
|
|
|
leakage. :class:`FilePerms` was built to increase clarity and cut down
|
|
|
|
|
on permission-related accidents when working with files from Python
|
|
|
|
|
code.
|
|
|
|
|
|
|
|
|
|
.. autoclass:: boltons.fileutils.FilePerms
|
2016-02-24 10:36:17 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Miscellaneous
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
.. autoclass:: boltons.fileutils.DummyFile
|
