aopp_deconv_tool.fpath.FPath

class documentation

class FPath(PurePath):

Constructor: FPath(*args, **kwargs)

View In Hierarchy

A field-aware abstract path (PurePath). Instantiate via FPath('path/{with}_some_{field}'). String used in instantiation will be passed to str.format(...) when used.

Defaults are set via keyword arguments on construction.

Use the FPath.with_fields(**kwargs) method to create a concrete path (Path) with **kwargs passed to str.format(...). These **kwargs overwrite defaults.

Method __fspath__ Return the "filesystem-path" of the current FPath object, all fields will take their default values.
Method __init__ Undocumented
Method defaults.setter Set the default values of the FPath's template fields
Method with_fields Return a new Path object created by substituting the values in **kwargs for the FPath's template fields. Any template fields not in **kwargs will take their default values.
Class Variable field_re Undocumented
Property defaults Return the default values of the FPath's template fields
Property fields Return the template fields of the FPath
Instance Variable _defaults Undocumented
Instance Variable _fields Undocumented
Instance Variable _parts Undocumented
def __fspath__(self):

Return the "filesystem-path" of the current FPath object, all fields will take their default values.

def __init__(self, *args, **kwargs):

Undocumented

@defaults.setter
def defaults(self, **kwargs):

Set the default values of the FPath's template fields

def with_fields(self, **kwargs):

Return a new Path object created by substituting the values in **kwargs for the FPath's template fields. Any template fields not in **kwargs will take their default values.

field_re =

Undocumented

@property
defaults =

Return the default values of the FPath's template fields

@property
fields =

Return the template fields of the FPath

_defaults =

Undocumented

_fields =

Undocumented

_parts =

Undocumented