common.cfiles package

Submodules

common.cfiles.filetypes module

class common.cfiles.filetypes.FileType

Bases: enum.Enum

common.cfiles.filetypes.filemeta(filename)

common.cfiles.filetypes.filename(ftype, version)

common.cfiles.filetypes.get_latest(fs, ftype, controller=None)

common.cfiles.filetypes.latest_filename(ftype)

common.cfiles.filetypes.set_latest(fs, ftype, version, controller=None)

common.cfiles.fs module

Controller files: opens files meant to be transferred to controllers via the XFER message.

class common.cfiles.fs.ControllerFiles(directory)

Bases: object

open(name, controller=None, *args, **kwargs)

Opens files for the given controller.

controller can be either a controller ID, or None for files common to all controllers.

See also open_for and path_for.

open_with_common(name, controller=None)

Opens a file: if one for this controller doesn’t exist, falls back to a common one.

Returns the file object opened as read-only in binary mode and unbuffered.

path(name, controller=None)

Returns the real path to the file for this controller.

controller can be either a controller ID, or None for files common to all controllers.

path_with_common(name, controller=None)

Resolves a path: if this file for this controller doesn’t exist, returns a common one.

Returns the real path to the file.

exception common.cfiles.fs.NoSuchFile(name, controller)

Bases: RuntimeError

common.cfiles.fs.mkdirnx(path)

mkdir if does not exist

Module contents