zim.newfs.base.FSObjectBase

class documentation

class FSObjectBase(FilePath): (source)

Known subclasses: zim.newfs.base.File, zim.newfs.base.Folder, zim.newfs.mock.MockFSObjectBase

Base class for File and Folder

Method	`__init__`	Undocumented
Method	`copyto`	Undocumented
Method	`ctime`	Undocumented
Method	`exists`	Undocumented
Method	`isequal`	No summary
Method	`iswritable`	Undocumented
Method	`moveto`	Undocumented
Method	`mtime`	Undocumented
Method	`parent`	Undocumented
Method	`remove`	Undocumented
Method	`touch`	Undocumented
Instance Variable	`watcher`	Undocumented
Method	`_cleanup`	Undocumented
Method	`_moveto`	Undocumented
Method	`_set_mtime`	Undocumented

Inherited from FilePath:

Class Method	`new_from_zim_config`	Returns a new object based on the string representation for that path
Method	`__eq__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`commonparent`	Undocumented
Method	`get_abspath`	No summary
Method	`get_childpath`	Undocumented
Method	`ischild`	Undocumented
Method	`parents`	Undocumented
Method	`relpath`	Undocumented
Method	`serialize_zim_config`	Returns the file path as string for serializing the object
Class Variable	`__slots__`	Undocumented
Instance Variable	`islocal`	Undocumented
Instance Variable	`path`	Undocumented
Instance Variable	`pathnames`	Undocumented
Property	`basename`	Undocumented
Property	`dirname`	Undocumented
Property	`uri`	Undocumented
Property	`userpath`	Undocumented

def __init__(self, path, watcher=None): (source)

overrides zim.newfs.base.FilePath.__init__

overridden in zim.newfs.base.File, zim.newfs.base.Folder, zim.newfs.mock.MockFSObjectBase

Undocumented

def copyto(self, other): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def ctime(self): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def exists(self): (source)

overridden in zim.newfs.mock.MockFolder, zim.newfs.mock.MockFSObjectBase

Undocumented

def isequal(self, other): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Check file paths are equal based on stat results (inode number etc.). Intended to detect when two files or dirs are the same on case-insensitive filesystems. Does not explicitly check the content is the same.

Parameters
other	an other `FilePath` object
Returns
`True` when the two paths are one and the same file

def iswritable(self): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def moveto(self, other): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def mtime(self): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def parent(self): (source)

overrides zim.newfs.base.FilePath.parent

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def remove(self, cleanup=True): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented

def touch(self): (source)

overridden in zim.newfs.base.File, zim.newfs.mock.MockFolder, zim.newfs.mock.MockFolder

Undocumented

watcher = (source)

Undocumented

def _cleanup(self): (source)

Undocumented

def _moveto(self, other): (source)

Undocumented

def _set_mtime(self, mtime): (source)

overridden in zim.newfs.mock.MockFSObjectBase

Undocumented