fs.base¶
PyFilesystem base class.
The filesystem base class is common to all filesystems. If you familiarize yourself with this (rather straightforward) API, you can work with any of the supported filesystems.
-
class
fs.base.
FS
¶ Base class for FS objects.
-
appendbytes
(path, data)¶ Append bytes to the end of a file, creating it if needed.
Parameters: Raises: TypeError
– Ifdata
is not abytes
instance.fs.errors.ResourceNotFound
– If a parent directory ofpath
does not exist.
-
appendtext
(path, text, encoding=u'utf-8', errors=None, newline=u'')¶ Append text to the end of a file, creating it if needed.
Parameters: Raises: TypeError
– iftext
is not an unicode string.fs.errors.ResourceNotFound
– if a parent directory ofpath
does not exist.
-
check
()¶ Check if a filesystem may be used.
Raises: fs.errors.FilesystemClosed
– if the filesystem is closed.
-
close
()¶ Close the filesystem and release any resources.
It is important to call this method when you have finished working with the filesystem. Some filesystems may not finalize changes until they are closed (archives for example). You may call this method explicitly (it is safe to call close multiple times), or you can use the filesystem as a context manager to automatically close.
Example
>>> with OSFS('~/Desktop') as desktop_fs: ... desktop_fs.settext( ... 'note.txt', ... "Don't forget to tape Game of Thrones" ... )
If you attempt to use a filesystem that has been closed, a
FilesystemClosed
exception will be thrown.
-
copy
(src_path, dst_path, overwrite=False)¶ Copy file contents from
src_path
todst_path
.Parameters: Raises: fs.errors.DestinationExists
– Ifdst_path
exists, andoverwrite
isFalse
.fs.errors.ResourceNotFound
– If a parent directory ofdst_path
does not exist.
-
copydir
(src_path, dst_path, create=False)¶ Copy the contents of
src_path
todst_path
.Parameters: Raises: fs.errors.ResourceNotFound
– If thedst_path
does not exist, andcreate
is notTrue
.
-
create
(path, wipe=False)¶ Create an empty file.
The default behavior is to create a new file if one doesn’t already exist. If
wipe
isTrue
, any existing file will be truncated.Parameters: Returns: True
if a new file had to be created.Return type:
-
desc
(path)¶ Return a short descriptive text regarding a path.
Parameters: path (str) – A path to a resource on the filesystem. Returns: a short description of the path. Return type: str
-
exists
(path)¶ Check if a path maps to a resource.
Parameters: path (str) – Path to a resource. Returns: True
if a resource exists at the given path.Return type: bool
-
filterdir
(path, files=None, dirs=None, exclude_dirs=None, exclude_files=None, namespaces=None, page=None)¶ Get an iterator of resource info, filtered by patterns.
This method enhances
scandir
with additional filtering functionality.Parameters: - path (str) – A path to a directory on the filesystem.
- files (list, optional) – A list of UNIX shell-style patterns
to filter file names, e.g.
['*.py']
. - dirs (list, optional) – A list of UNIX shell-style patterns to filter directory names.
- exclude_dirs (list, optional) – A list of patterns used to exclude directories.
- exclude_files (list, optional) – A list of patterns used to exclude files.
- namespaces (list, optional) – A list of namespaces to include
in the resource information, e.g.
['basic', 'access']
. - page (tuple, optional) – May be a tuple of
(<start>, <end>)
indexes to return an iterator of a subset of the resource info, orNone
to iterate over the entire directory. Paging a directory scan may be necessary for very large directories.
Returns: an iterator of
Info
objects.Return type:
-
getbasic
(path)¶ Get the basic resource info.
This method is shorthand for the following:
fs.getinfo(path, namespaces=['basic'])
Parameters: path (str) – A path on the filesystem. Returns: Resource information object for path
.Return type: Info
-
getbytes
(path)¶ Get the contents of a file as bytes.
Parameters: path (str) – A path to a readable file on the filesystem. Returns: the file contents. Return type: bytes Raises: fs.errors.ResourceNotFound
– ifpath
does not exist.
-
getdetails
(path)¶ Get the details resource info.
This method is shorthand for the following:
fs.getinfo(path, namespaces=['details'])
Parameters: path (str) – A path on the filesystem. Returns: Resource information object for path
.Return type: Info
-
getfile
(path, file, chunk_size=None, **options)¶ Copies a file from the filesystem to a file-like object.
This may be more efficient that opening and copying files manually if the filesystem supplies an optimized method.
Parameters: - path (str) – Path to a resource.
- file (file-like) – A file-like object open for writing in binary mode.
- chunk_size (int, optional) – Number of bytes to read at a
time, if a simple copy is used, or
None
to use sensible default. - **options – Implementation specific options required to open the source file.
Note that the file object
file
will not be closed by this method. Take care to close it after this method completes (ideally with a context manager).Example
>>> with open('starwars.mov', 'wb') as write_file: ... my_fs.getfile('/movies/starwars.mov', write_file)
-
getinfo
(path, namespaces=None)¶ Get information about a resource on a filesystem.
Parameters: Returns: resource information object.
Return type: For more information regarding resource information, see Resource Info.
-
getmeta
(namespace=u'standard')¶ Get meta information regarding a filesystem.
Parameters: namespace (str) – The meta namespace (defaults to "standard"
).Returns: the meta information. Return type: dict Meta information is associated with a namespace which may be specified with the
namespace
parameter. The default namespace,"standard"
, contains common information regarding the filesystem’s capabilities. Some filesystems may provide other namespaces which expose less common or implementation specific information. If a requested namespace is not supported by a filesystem, then an empty dictionary will be returned.The
"standard"
namespace supports the following keys:key Description case_insensitive True
if this filesystem is case insensitive.invalid_path_chars A string containing the characters that may not be used on this filesystem. max_path_length Maximum number of characters permitted in a path, or None
for no limit.max_sys_path_length Maximum number of characters permitted in a sys path, or None
for no limit.network True
if this filesystem requires a network.read_only True
if this filesystem is read only.supports_rename True
if this filesystem supports anos.rename
operation.Most builtin filesystems will provide all these keys, and third- party filesystems should do so whenever possible, but a key may not be present if there is no way to know the value.
Note
Meta information is constant for the lifetime of the filesystem, and may be cached.
-
getospath
(path)¶ Get a system path to a resource, encoded in the operating system’s prefered encoding.
Parameters: path (str) – A path on the filesystem. Returns: the system path of the resource, if any. Return type: str Raises: fs.errors.NoSysPath
– If there is no corresponding system path.This method takes the output of
getsyspath
and encodes it to the filesystem’s prefered encoding. In Python3 this step is not required, as theos
module will do it automatically. In Python2.7, the encoding step is required to support filenames on the filesystem that don’t encode correctly.Note
If you want your code to work in Python2.7 and Python3 then use this method if you want to work will the OS filesystem outside of the OSFS interface.
-
getsize
(path)¶ Get the size (in bytes) of a resource.
Parameters: path (str) – A path to a resource. Returns: the size of the resource. Return type: int The size of a file is the total number of readable bytes, which may not reflect the exact number of bytes of reserved disk space (or other storage medium).
The size of a directory is the number of bytes of overhead use to store the directory entry.
-
getsyspath
(path)¶ Get the system path of a resource.
Parameters: path (str) – A path on the filesystem. Returns: the system path of the resource, if any. Return type: str Raises: fs.errors.NoSysPath
– If there is no corresponding system path.A system path is one recognized by the OS, that may be used outside of PyFilesystem (in an application or a shell for example). This method will get the corresponding system path that would be referenced by
path
.Not all filesystems have associated system paths. Network and memory based filesystems, for example, may not physically store data anywhere the OS knows about. It is also possible for some paths to have a system path, whereas others don’t.
This method will always return a str on Py3.* and unicode on Py2.7. See
getospath
if you need to encode the path as bytes.If
path
doesn’t have a system path, aNoSysPath
exception will be thrown.Note
A filesystem may return a system path even if no resource is referenced by that path – as long as it can be certain what that system path would be.
-
gettext
(path, encoding=None, errors=None, newline=u'')¶ Get the contents of a file as a string.
Parameters: Returns: file contents.
Return type: Raises: fs.errors.ResourceNotFound
– Ifpath
does not exist.
-
gettype
(path)¶ Get the type of a resource.
Parameters: path (str) – A path on the filesystem. Returns: the type of the resource. Return type: ResourceType A type of a resource is an integer that identifies the what the resource references. The standard type integers may be one of the values in the
ResourceType
enumerations.The most common resource types, supported by virtually all filesystems are
directory
(1) andfile
(2), but the following types are also possible:ResourceType value unknown 0 directory 1 file 2 character 3 block_special_file 4 fifo 5 socket 6 symlink 7 Standard resource types are positive integers, negative values are reserved for implementation specific resource types.
-
geturl
(path, purpose=u'download')¶ Get the URL to a given resource.
Parameters: Returns: a URL.
Return type: Raises: fs.errors.NoURL
– If the path does not map to a URL.
-
hassyspath
(path)¶ Check if a path maps to a system path.
Parameters: path (str) – A path on the filesystem. Returns: True
if the resource atpath
has a syspath.Return type: bool
-
hasurl
(path, purpose=u'download')¶ Check if a path has a corresponding URL.
Parameters: Returns: True
if an URL for the given purpose exists.Return type:
-
isclosed
()¶ Check if the filesystem is closed.
-
isdir
(path)¶ Check if a path maps to an existing directory.
Parameters: path (str) – A path on the filesystem. Returns: True
ifpath
maps to a directory.Return type: bool
-
isempty
(path)¶ Check if a directory is empty.
A directory is considered empty when it does not contain any file or any directory.
Parameters: path (str) – A path to a directory on the filesystem.
Returns: True
if the directory is empty.Return type: Raises: errors.DirectoryExpected
– Ifpath
is not a directory.errors.ResourceNotFound
– Ifpath
does not exist.
-
isfile
(path)¶ Check if a path maps to an existing file.
Parameters: path (str) – A path on the filesystem. Returns: True
ifpath
maps to a file.Return type: bool
-
islink
(path)¶ Check if a path maps to a symlink.
Parameters: path (str) – A path on the filesystem. Returns: True
ifpath
maps to a symlink.Return type: bool
-
listdir
(path)¶ Get a list of the resource names in a directory.
This method will return a list of the resources in a directory. A resource is a file, directory, or one of the other types defined in
ResourceType
.Parameters: path (str) – A path to a directory on the filesystem
Returns: list of names, relative to
path
.Return type: Raises: fs.errors.DirectoryExpected
– Ifpath
is not a directory.fs.errors.ResourceNotFound
– Ifpath
does not exist.
-
lock
()¶ Get a context manager that locks the filesystem.
Locking a filesystem gives a thread exclusive access to it. Other threads will block until the threads with the lock has left the context manager.
Returns: a lock specific to the filesystem instance. Return type: threading.RLock Example
>>> with my_fs.lock(): # May block ... # code here has exclusive access to the filesystem
It is a good idea to put a lock around any operations that you would like to be atomic. For instance if you are copying files, and you don’t want another thread to delete or modify anything while the copy is in progress.
Locking with this method is only required for code that calls multiple filesystem methods. Individual methods are thread safe already, and don’t need to be locked.
Note
This only locks at the Python level. There is nothing to prevent other processes from modifying the filesystem outside of the filesystem instance.
-
makedir
(path, permissions=None, recreate=False)¶ Make a directory.
Parameters: Returns: a filesystem whose root is the new directory.
Return type: Raises: fs.errors.DirectoryExists
– If the path already exists.fs.errors.ResourceNotFound
– If the path is not found.
-
makedirs
(path, permissions=None, recreate=False)¶ Make a directory, and any missing intermediate directories.
Parameters: Returns: A sub-directory filesystem.
Return type: Raises: fs.errors.DirectoryExists
– if the path is already a directory, andrecreate
isFalse
.fs.errors.DirectoryExpected
– if one of the ancestors in the path is not a directory.
-
match
(patterns, name)¶ Check if a name matches any of a list of wildcards.
Parameters: Returns: True
ifname
matches any of the patterns.Return type: If a filesystem is case insensitive (such as Windows) then this method will perform a case insensitive match (i.e.
*.py
will match the same names as*.PY
). Otherwise the match will be case sensitive (*.py
and*.PY
will match different names).Example
>>> home_fs.match(['*.py'], '__init__.py') True >>> home_fs.match(['*.jpg', '*.png'], 'foo.gif') False
-
move
(src_path, dst_path, overwrite=False)¶ Move a file from
src_path
todst_path
.Parameters: Raises: fs.errors.FileExpected
– Ifsrc_path
maps to a directory instead of a file.fs.errors.DestinationExists
– Ifdst_path
exists, andoverwrite
isFalse
.fs.errors.ResourceNotFound
– If a parent directory ofdst_path
does not exist.
-
movedir
(src_path, dst_path, create=False)¶ Move contents of directory
src_path
todst_path
.Parameters: Raises: fs.errors.ResourceNotFound
– ifdst_path
does not exist, andcreate
isFalse
.
-
open
(path, mode=u'r', buffering=-1, encoding=None, errors=None, newline=u'', **options)¶ Open a file.
Parameters: - path (str) – A path to a file on the filesystem.
- mode (str) – Mode to open the file object with (defaults to r).
- buffering (int) – Buffering policy (-1 to use default buffering, 0 to disable buffering, 1 to select line buffering, of any positive integer to indicate a buffer size).
- encoding (str) – Encoding for text files (defaults to
utf-8
) - errors (str, optional) – What to do with unicode decode errors
(see
codecs
module for more information). - newline (str) – Newline parameter.
- **options – keyword arguments for any additional information required by the filesystem (if any).
Returns: a file-like object.
Return type: Raises: fs.errors.FileExpected
– If the path is not a file.fs.errors.FileExists
– If the file exists, and exclusive mode is specified (x
in the mode).fs.errors.ResourceNotFound
– If the path does not exist.
-
openbin
(path, mode=u'r', buffering=-1, **options)¶ Open a binary file-like object.
Parameters: - path (str) – A path on the filesystem.
- mode (str) – Mode to open file (must be a valid non-text mode,
defaults to r). Since this method only opens binary files,
the
b
in the mode string is implied. - buffering (int) – Buffering policy (-1 to use default buffering, 0 to disable buffering, or any positive integer to indicate a buffer size).
- **options – keyword arguments for any additional information required by the filesystem (if any).
Returns: a file-like object.
Return type: Raises: fs.errors.FileExpected
– If the path is not a file.fs.errors.FileExists
– If the file exists, and exclusive mode is specified (x
in the mode).fs.errors.ResourceNotFound
– If the path does not exist.
-
opendir
(path, factory=None)¶ Get a filesystem object for a sub-directory.
Parameters: Returns: A filesystem representing a sub-directory.
Return type: Raises: fs.errors.DirectoryExpected
– Ifdst_path
does not exist or is not a directory.
-
remove
(path)¶ Remove a file from the filesystem.
Parameters: path (str) – Path of the file to remove.
Raises: fs.errors.FileExpected
– If the path is a directory.fs.errors.ResourceNotFound
– If the path does not exist.
-
removedir
(path)¶ Remove a directory from the filesystem.
Parameters: path (str) – Path of the directory to remove.
Raises: fs.errors.DirectoryNotEmpty
– If the directory is not empty ( seeremovetree
for a way to remove the directory contents.).fs.errors.DirectoryExpected
– If the path does not refer to a directory.fs.errors.ResourceNotFound
– If no resource exists at the given path.fs.errors.RemoveRootError
– If an attempt is made to remove the root directory (i.e.'/'
)
-
removetree
(dir_path)¶ Recursively remove the contents of a directory.
This method is similar to
removedir
, but will remove the contents of the directory if it is not empty.Parameters: dir_path (str) – Path to a directory on the filesystem.
-
scandir
(path, namespaces=None, page=None)¶ Get an iterator of resource info.
Parameters: - path (str) – A path to a directory on the filesystem.
- namespaces (list, optional) – A list of namespaces to include
in the resource information, e.g.
['basic', 'access']
. - page (tuple, optional) – May be a tuple of
(<start>, <end>)
indexes to return an iterator of a subset of the resource info, orNone
to iterate over the entire directory. Paging a directory scan may be necessary for very large directories.
Returns: an iterator of
Info
objects.Return type: Raises: fs.errors.DirectoryExpected
– Ifpath
is not a directory.fs.errors.ResourceNotFound
– Ifpath
does not exist.
-
setbinfile
(path, file)¶ Set a file to the contents of a binary file object.
This method copies bytes from an open binary file to a file on the filesystem. If the destination exists, it will first be truncated.
Parameters: Note that the file object
file
will not be closed by this method. Take care to close it after this method completes (ideally with a context manager).Example
>>> with open('myfile.bin') as read_file: ... my_fs.setbinfile('myfile.bin', read_file)
-
setbytes
(path, contents)¶ Copy binary data to a file.
Parameters: Raises: TypeError
– if contents is not bytes.
-
setfile
(path, file, encoding=None, errors=None, newline=u'')¶ Set a file to the contents of a file object.
Parameters: - path (str) – A path on the filesystem.
- file (io.IOBase) – A file object open for reading.
- encoding (str, optional) – Encoding of destination file,
defaults to
None
for binary. - errors (str, optional) – How encoding errors should be treated
(same as
io.open
). - newline (str) – Newline parameter (same as
io.open
).
This method will read the contents of a supplied file object, and write to a file on the filesystem. If the destination exists, it will first be truncated.
If
encoding
is supplied, the destination will be opened in text mode.Note that the file object
file
will not be closed by this method. Take care to close it after this method completes (ideally with a context manager).Example
>>> with open('myfile.bin') as read_file: ... my_fs.setfile('myfile.bin', read_file)
-
setinfo
(path, info)¶ Set info on a resource.
This method is the compliment to
getinfo
and is used to set info values on a resource.Parameters: Raises: fs.errors.ResourceNotFound
– Ifpath
does not exist on the filesystemThe
info
dict should be in the same format as the raw info returned bygetinfo(file).raw
.Example
>>> details_info = {"details": { ... "modified": time.time() ... }} >>> my_fs.setinfo('file.txt', details_info)
-
settext
(path, contents, encoding=u'utf-8', errors=None, newline=u'')¶ Create or replace a file with text.
Parameters: Raises: TypeError
– ifcontents
is not a unicode string.
-
settimes
(path, accessed=None, modified=None)¶ Set the accessed and modified time on a resource.
Parameters:
-
touch
(path)¶ Touch a file on the filesystem.
Touching a file means creating a new file if
path
doesn’t exist, or update accessed and modified times if the path does exist. This method is similar to the linux command of the same name.Parameters: path (str) – A path to a file on the filesystem.
-
tree
(**kwargs)¶ Render a tree view of the filesystem to stdout or a file.
The parameters are passed to
render()
.Keyword Arguments: - path (str) – The path of the directory to start rendering
from (defaults to root folder, i.e.
'/'
). - file (io.IOBase) – An open file-like object to render the
tree, or
None
for stdout. - encoding (str) – Unicode encoding, or
None
to auto-detect. - max_levels (int) – Maximum number of levels to
display, or
None
for no maximum. - with_color (bool) – Enable terminal color output,
or
None
to auto-detect terminal. - dirs_first (bool) – Show directories first.
- exclude (list) – Option list of directory patterns to exclude from the tree render.
- filter (list) – Optional list of files patterns to match in the tree render.
- path (str) – The path of the directory to start rendering
from (defaults to root folder, i.e.
-
validatepath
(path)¶ Check if a path is valid, returning a normalized absolute path.
Many filesystems have restrictions on the format of paths they support. This method will check that
path
is valid on the underlaying storage mechanism and throw aInvalidPath
exception if it is not.Parameters: path (str) – A path.
Returns: A normalized, absolute path.
Return type: Raises: fs.errors.InvalidCharsInPath
– If the path contains invalid characters.fs.errors.InvalidPath
– If the path is invalid.fs.errors.FilesystemClosed
– if the filesystem is closed.
-
walk
¶ BoundWalker
– a walker bound to this filesystem.
-
walker_class
¶ alias of
fs.walk.Walker
-