module `filehelper.file_tree_node`¶

Short summary¶

module pyquickhelper.filehelper.file_tree_node

a node which contains a file or a folder

Classes¶

class	truncated documentation
`FileTreeNode`	Defines a node for a folder or a tree. Example:

Properties¶

property	truncated documentation
`date`	Returns the modification date.
`fullname`	Returns the full name.
`name`	Returns the file name from the root.
`root`	Returns the root directory, the one used as a root for a synchronization.
`size`	Returns the size.
`type`	Returns the file type (`file` or `folder`).

Static Methods¶

staticmethod	truncated documentation
`build_expression`	Builds a regular expression validating a list of extension.

Methods¶

method	truncated documentation
`__getitem__`	returns the element i
`__init__`	Defines a file, relative to a root.
`__iter__`	iterator on the element
`__len__`	Returns the number of elements in this folder and in the subfolders.
`__str__`	usual
`_fill`	look for subfolders
`_fillstat`	private: fill _type, _size
`copy_to`	Copies the file to path.
`difference`	Returns the differences with another folder.
`exists`	say if it does exist or not
`get`	return a dictionary with some values which describe the file
`get_content`	Returns the content of a text file.
`get_dict`	Returns a dictionary `{ self._file : node }`.
`get_fullname`
`hash_md5_readfile`	Computes a hash of a file.
`isdir`	is it a folder?
`isfile`	is it a file?
`max_date`	return the more recent date
`nb_children`	return the number of children
`remove`	Removes the file.
`repo_ls`	call ls of an instance of `SourceRepository`
`sign`	Returns `==`, `<` or `>` according the dates if the size is not too big, if the sign is `<` or `>`, …

Documentation¶

a node which contains a file or a folder

source on GitHub

class pyquickhelper.filehelper.file_tree_node.FileTreeNode(root, file=None, filter=None, level=0, parent=None, repository=False, log=False, log1=False, fLOG=<function noLOG>)[source]¶

Bases: object

Defines a node for a folder or a tree. Example:

def example (p1, p2, hash_size = 1024**2*2, svn1 = True, svn2 = False) :
    extout = re.compile (FileTreeNode.build_expression ("dvi bbl blg ilg ind old out pyc pyd " \
                                "bak idx obj log aux pdb sbr ncb res idb suo dep " \
                                "ogm manifest dsp dsz user ilk bsc exp eps".split ()))
    extfou = re.compile ("(exeinterpreter[/\\].*[.]dll)|([/\\]upgradereport)|" \
                        "(thumbs[.]db)|([.]svn)|(temp[_/\\].*)")

    def filter (root, path, f, d) :
        root = root.lower ()
        path = path.lower ()
        f    = f.lower ()
        if extout.search (f) :
            if not d and not f.endswith(".pyc"):
                print("rejected (o1)", path, f)
            return False
        fu = os.path.join (path, f)
        if extfou.search (fu) :
            if not d and not f.endswith(".pyc"):
                print("rejected (o2)", path, f)
            return False
        return True

    f1  = p1
    f2  = p2

    node1 = FileTreeNode(f1, filter = filter, repository = svn1)
    node2 = FileTreeNode(f2, filter = filter, repository = svn2)
    print(len(node1), node1.max_date())
    print(len(node2), node2.max_date())

    res = node1.difference(node2, hash_size=hash_size)
    return res

print(__file__, "synchro", OutputPrint = __name__ == "__main__")
res = example (p1, p2)

source on GitHub

Defines a file, relative to a root.

Parameters:

root – root (it must exist)
file – file, if None, fill _children
filter – function (root, path, f, dir) –> True or False if this is a string, it will be converted into a regular expression (using re), and it will look into subfolders
level – hierarchy level
parent – link to the parent
repository – use SVN or GIT if True
log – log every explored folder
log1 – intermediate logs (first level)
fLOG – logging function to use

source on GitHub

__getitem__(i)[source]¶

returns the element i

Parameters:: i – element
Returns:: element

source on GitHub

__init__(root, file=None, filter=None, level=0, parent=None, repository=False, log=False, log1=False, fLOG=<function noLOG>)[source]¶

Defines a file, relative to a root.

Parameters:

root – root (it must exist)
file – file, if None, fill _children
filter – function (root, path, f, dir) –> True or False if this is a string, it will be converted into a regular expression (using re), and it will look into subfolders
level – hierarchy level
parent – link to the parent
repository – use SVN or GIT if True
log – log every explored folder
log1 – intermediate logs (first level)
fLOG – logging function to use

source on GitHub

__iter__()[source]¶

iterator on the element

Returns:: iterator on all contained files

source on GitHub

__len__()[source]¶

Returns the number of elements in this folder and in the subfolders.

source on GitHub

__str__()[source]¶

usual

source on GitHub

_default_not_ext = ['bbl', 'out', 'pyc', 'log', 'lib', 'ind', 'pdb', 'opt'][source]¶

_default_out = re.compile('([.]svn)|(hal.*[.]((exe)|(dll)|(so)|(sln)|(vcproj)))(.*[.]bbl$)|(.*[.]out$)|(.*[.]pyc$)|(.*[.]log$)|(.*[.]lib$)|(.*[.]ind$)|(.*[.]pdb$)|(.*[.]opt$)')[source]¶

_fill(filter, repository)[source]¶

look for subfolders

Parameters: