diff options
Diffstat (limited to 'docs/utilities.rst')
| -rw-r--r-- | docs/utilities.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/utilities.rst b/docs/utilities.rst new file mode 100644 index 0000000..3097729 --- /dev/null +++ b/docs/utilities.rst @@ -0,0 +1,23 @@ +Utility Modules +=============== + +PyFilesystem also contains some miscellaneous utility modules to make writing +new FS implementations easier. + + +fs.path +------- +Contains many utility functions for manipulating filesystem paths. See :mod:`fs.path`. + +fs.errors +--------- +Contains all the standard error classes used by PyFilesystem, along with some useful error-handling decorators. See :mod:`fs.errors`. + +fs.filelike +----------- +Takes care of a lot of the groundwork for implementing and manipulating objects that support Python's standard "file-like" interface. See :mod:`fs.filelike`. + +fs.remote +--------- +Contains useful functions and classes for implementing remote filesystems. See :mod:`fs.remote`. + |