# 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[source]

Base class for FS objects.

__enter__()[source]

Allow use of filesystem as a context manager.

__exit__(exc_type, exc_value, traceback)[source]

Close filesystem on exit.

appendbytes(path, data)[source]

Append bytes to the end of a file, creating it if needed.

Parameters: path (str) – Path to a file. data (bytes) – Bytes to append. TypeError – If data is not a bytes instance. fs.errors.ResourceNotFound – If a parent directory of path does not exist.
appendtext(path, text, encoding=u'utf-8', errors=None, newline=u'')[source]

Append text to the end of a file, creating it if needed.

Parameters: path (str) – Path to a file. text (str) – Text to append. 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. TypeError – if text is not an unicode string. fs.errors.ResourceNotFound – if a parent directory of path does not exist.
check()[source]

Check if a filesystem may be used.

Raises: fs.errors.FilesystemClosed – if the filesystem is closed.
close()[source]

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)[source]

Copy file contents from src_path to dst_path.

Parameters: src_path (str) – Path of source file. dst_path (str) – Path to destination file. overwrite (bool) – If True, overwrite the destination file if it exists (defaults to False). fs.errors.DestinationExists – If dst_path exists, and overwrite is False. fs.errors.ResourceNotFound – If a parent directory of dst_path does not exist.
copydir(src_path, dst_path, create=False)[source]

Copy the contents of src_path to dst_path.

Parameters: src_path (str) – Path of source directory. dst_path (str) – Path to destination directory. create (bool) – If True, then dst_path will be created if it doesn’t exist alreadys (defaults to False). fs.errors.ResourceNotFound – If the dst_path does not exist, and create is not True.
create(path, wipe=False)[source]

Create an empty file.

The default behavior is to create a new file if one doesn’t already exist. If wipe is True, any existing file will be truncated.

Parameters: path (str) – Path to a new file in the filesystem. wipe (bool) – If True, truncate any existing file to 0 bytes (defaults to False). True if a new file had to be created. bool
desc(path)[source]

Return a short descriptive text regarding a path.

Parameters: path (str) – A path to a resource on the filesystem. a short description of the path. str
exists(path)[source]

Check if a path maps to a resource.

Parameters: path (str) – Path to a resource. True if a resource exists at the given path. bool
filterdir(path, files=None, dirs=None, exclude_dirs=None, exclude_files=None, namespaces=None, page=None)[source]

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 (, ) indexes to return an iterator of a subset of the resource info, or None to iterate over the entire directory. Paging a directory scan may be necessary for very large directories. an iterator of Info objects. Iterator
getbasic(path)[source]

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. Resource information object for path. Info
getbytes(path)[source]

Get the contents of a file as bytes.

Parameters: path (str) – A path to a readable file on the filesystem. the file contents. bytes fs.errors.ResourceNotFound – if path does not exist.
getdetails(path)[source]

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. Resource information object for path. Info
getfile(path, file, chunk_size=None, **options)[source]

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)[source]

Get information about a resource on a filesystem.

Parameters: path (str) – A path to a resource on the filesystem. namespaces (list, optional) – Info namespaces to query (defaults to [basic]). resource information object. Info

For more information regarding resource information, see Resource Info.

getmeta(namespace=u'standard')[source]

Get meta information regarding a filesystem.

Parameters: namespace (str) – The meta namespace (defaults to "standard"). the meta information. 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 an os.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)[source]

Get a system path to a resource, encoded in the operating system’s prefered encoding.

Parameters: path (str) – A path on the filesystem. the system path of the resource, if any. str 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 the os 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)[source]

Get the size (in bytes) of a resource.

Parameters: path (str) – A path to a resource. the size of the resource. 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)[source]

Get the system path of a resource.

Parameters: path (str) – A path on the filesystem. the system path of the resource, if any. str 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, a NoSysPath 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'')[source]

Get the contents of a file as a string.

Parameters: path (str) – A path to a readable file on the filesystem. encoding (str, optional) – Encoding to use when reading contents in text mode (defaults to None, reading in binary mode). errors (str, optional) – Unicode errors parameter. newline (str) – Newlines parameter. file contents. str fs.errors.ResourceNotFound – If path does not exist.
gettype(path)[source]

Get the type of a resource.

Parameters: path (str) – A path on the filesystem. the type of the resource. 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) and file (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')[source]

Get the URL to a given resource.

Parameters: path (str) – A path on the filesystem purpose (str) – A short string that indicates which URL to retrieve for the given path (if there is more than one). The default is 'download', which should return a URL that serves the file. Other filesystems may support other values for purpose. a URL. str fs.errors.NoURL – If the path does not map to a URL.
glob

a globber object..

hassyspath(path)[source]

Check if a path maps to a system path.

Parameters: path (str) – A path on the filesystem. True if the resource at path has a syspath. bool
hasurl(path, purpose=u'download')[source]

Check if a path has a corresponding URL.

Parameters: path (str) – A path on the filesystem. purpose (str) – A purpose parameter, as given in geturl. True if an URL for the given purpose exists. bool
isclosed()[source]

Check if the filesystem is closed.

isdir(path)[source]

Check if a path maps to an existing directory.

Parameters: path (str) – A path on the filesystem. True if path maps to a directory. bool
isempty(path)[source]

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. True if the directory is empty. bool errors.DirectoryExpected – If path is not a directory. errors.ResourceNotFound – If path does not exist.
isfile(path)[source]

Check if a path maps to an existing file.

Parameters: path (str) – A path on the filesystem. True if path maps to a file. bool

Check if a path maps to a symlink.

Parameters: path (str) – A path on the filesystem. True if path maps to a symlink. bool
listdir(path)[source]

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 list of names, relative to path. list fs.errors.DirectoryExpected – If path is not a directory. fs.errors.ResourceNotFound – If path does not exist.
lock()[source]

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. 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)[source]

Make a directory.

Parameters: path (str) – Path to directory from root. permissions (Permissions, optional) – a Permissions instance, or None to use default. recreate (bool) – Set to True to avoid raising an error if the directory already exists (defaults to False). a filesystem whose root is the new directory. SubFS fs.errors.DirectoryExists – If the path already exists. fs.errors.ResourceNotFound – If the path is not found.
makedirs(path, permissions=None, recreate=False)[source]

Make a directory, and any missing intermediate directories.

Parameters: path (str) – Path to directory from root. permissions (Permissions, optional) – Initial permissions, or None to use defaults. recreate (bool) – If False (the default), attempting to create an existing directory will raise an error. Set to True to ignore existing directories. A sub-directory filesystem. SubFS fs.errors.DirectoryExists – if the path is already a directory, and recreate is False. fs.errors.DirectoryExpected – if one of the ancestors in the path is not a directory.
match(patterns, name)[source]

Check if a name matches any of a list of wildcards.

Parameters: patterns (list) – A list of patterns, e.g. ['*.py'] name (str) – A file or directory name (not a path) True if name matches any of the patterns. bool

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


Note

If patterns is None (or ['*']), then this method will always return True.

move(src_path, dst_path, overwrite=False)[source]

Move a file from src_path to dst_path.

Parameters: src_path (str) – A path on the filesystem to move. dst_path (str) – A path on the filesystem where the source file will be written to. overwrite (bool) – If True, destination path will be overwritten if it exists. fs.errors.FileExpected – If src_path maps to a directory instead of a file. fs.errors.DestinationExists – If dst_path exists, and overwrite is False. fs.errors.ResourceNotFound – If a parent directory of dst_path does not exist.
movedir(src_path, dst_path, create=False)[source]

Move contents of directory src_path to dst_path.

Parameters: src_path (str) – Path of source directory on the filesystem. dst_path (str) – Path to destination directory. create (bool) – If True, then dst_path will be created if it doesn’t exist already (defaults to False). fs.errors.ResourceNotFound – if dst_path does not exist, and create is False.
open(path, mode=u'r', buffering=-1, encoding=None, errors=None, newline=u'', **options)[source]

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). a file-like object. io.IOBase 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)[source]

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). a file-like object. io.IOBase 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)[source]

Get a filesystem object for a sub-directory.

Parameters: path (str) – Path to a directory on the filesystem. factory (callable, optional) – A callable that when invoked with an FS instance and path will return a new FS object representing the sub-directory contents. If no factory is supplied then SubFS will be used. A filesystem representing a sub-directory. SubFS fs.errors.DirectoryExpected – If dst_path does not exist or is not a directory.
remove(path)[source]

Remove a file from the filesystem.

Parameters: path (str) – Path of the file to remove. fs.errors.FileExpected – If the path is a directory. fs.errors.ResourceNotFound – If the path does not exist.
removedir(path)[source]

Remove a directory from the filesystem.

Parameters: path (str) – Path of the directory to remove. fs.errors.DirectoryNotEmpty – If the directory is not empty ( see removetree 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)[source]

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)[source]

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 (, ) indexes to return an iterator of a subset of the resource info, or None to iterate over the entire directory. Paging a directory scan may be necessary for very large directories. an iterator of Info objects. Iterator fs.errors.DirectoryExpected – If path is not a directory. fs.errors.ResourceNotFound – If path does not exist.
setbinfile(path, file)[source]

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: path (str) – A path on the filesystem. file (io.IOBase) – a file object open for reading in binary 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:

setbytes(path, contents)[source]

Copy binary data to a file.

Parameters: path (str) – Destination path on the filesystem. contents (bytes) – Data to be written. TypeError – if contents is not bytes.
setfile(path, file, encoding=None, errors=None, newline=u'')[source]

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:

setinfo(path, info)[source]

Set info on a resource.

This method is the compliment to getinfo and is used to set info values on a resource.

Parameters: path (str) – Path to a resource on the filesystem. info (dict) – Dictionary of resource info. fs.errors.ResourceNotFound – If path does not exist on the filesystem

The info dict should be in the same format as the raw info returned by getinfo(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'')[source]

Create or replace a file with text.

Parameters: path (str) – Destination path on the filesystem. contents (str) – Text to be written. encoding (str, optional) – Encoding of destination file (defaults to 'ut-8'). errors (str, optional) – How encoding errors should be treated (same as io.open). newline (str) – Newline parameter (same as io.open). TypeError – if contents is not a unicode string.
settimes(path, accessed=None, modified=None)[source]

Set the accessed and modified time on a resource.

Parameters: path – A path to a resource on the filesystem. accessed (datetime, optional) – The accessed time, or None (the default) to use the current time. modified (datetime, optional) – The modified time, or None (the default) to use the same time as the accessed parameter.
touch(path)[source]

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)[source]

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.
validatepath(path)[source]

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 a InvalidPath exception if it is not.

Parameters: path (str) – A path. A normalized, absolute path. str 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

a walker bound to this filesystem.

walker_class

alias of fs.walk.Walker