.. _f-synchelper: module ``filehelper.synchelper`` ================================ Short summary +++++++++++++ module ``pyquickhelper.filehelper.synchelper`` Series of functions related to folder, explore, synchronize, remove (recursively). :githublink:`%|py|6` Functions +++++++++ +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=========================================================================================================+===========================================================================================================================+ | :func:`download_urls_iterfile ` | Same as :func:`explore_folder` but iterates on files included in a folder and its subfolders. | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`explore_folder ` | Returns the list of files included in a folder and its subfolders. Returned names can be modified if *sub_pattern* is ... | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`explore_folder_iterfile ` | Same as :func:`explore_folder` but iterates on files included in a folder and its subfolders. | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`explore_folder_iterfile_repo ` | Returns all files present in folder and added to a :epkg:`SVN` or :epkg:`GIT` repository. | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`has_been_updated ` | It assumes *dest* is a copy of *source*, it wants to know if the copy is up to date or not. | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`remove_folder ` | Removes everything in folder *top*. | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`synchronize_folder ` | Synchronizes two folders (or copy if the second is empty), it only copies more recent files. It can walk through ... | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | :func:`walk ` | Does the same as :epkg:`*py:os:walk` plus does not go through a sub-folder if this one is big. Folders such *build* ... | +---------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.filehelper.synchelper :members: :special-members: __init__ :show-inheritance: