import fsutil

# Raise an OSError if the given path doesn't exist or it is not a directory. fsutil.assert_dir(path)

# Raise an OSError if the given path doesn't exist. fsutil.assert_exists(path)

# Raise an OSError if the given path doesn't exist or it is not a file. fsutil.assert_file(path)

# Raise an OSError if the given path is an existing directory. fsutil.assert_not_dir(path)

# Raise an OSError if the given path already exists. fsutil.assert_not_exists(path)

# Raise an OSError if the given path is an existing file. fsutil.assert_not_file(path)

# Clean a directory by removing empty sub-directories and/or empty files. fsutil.clean_dir(path, dirs=True, files=True)

# Convert the given size bytes to string using the right unit suffix. size_str = fsutil.convert_size_bytes_to_string(size)

# Convert the given size string to bytes. size_bytes = fsutil.convert_size_string_to_bytes(size)

# Copy the directory at the given path and all its content to dest path. # If overwrite is not allowed and dest path exists, an OSError is raised. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.copytree fsutil.copy_dir(path, dest, overwrite=False, **kwargs)

# Copy the content of the directory at the given path to dest path. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.copytree fsutil.copy_dir_content(path, dest, **kwargs)

# Copy the file at the given path and its metadata to dest path. # If overwrite is not allowed and dest path exists, an OSError is raised. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.copy2 fsutil.copy_file(path, dest, overwrite=False, **kwargs)

# Create directory at the given path. # If overwrite is not allowed and path exists, an OSError is raised. fsutil.create_dir(path, overwrite=False)

# Create file with the specified content at the given path. # If overwrite is not allowed and path exists, an OSError is raised. fsutil.create_file(path, content="", overwrite=False)

# Create tar file at path compressing directories/files listed in content_paths. # If overwrite is allowed and dest tar already exists, it will be overwritten. fsutil.create_tar_file(path, content_paths, overwrite=True, compression="gzip")

# Create zip file at path compressing directories/files listed in content_paths. # If overwrite is allowed and dest zip already exists, it will be overwritten. fsutil.create_zip_file(path, content_paths, overwrite=True, compression=zipfile.ZIP_DEFLATED)

# Alias for remove_dir. fsutil.delete_dir(path)

# Alias for remove_dir_content. fsutil.delete_dir_content(path)

# Alias for remove_dirs. fsutil.delete_dirs(*paths)

# Alias for remove_file. fsutil.delete_file(path)

# Alias for remove_files. fsutil.delete_files(*paths)

# Download a file from url to the given dirpath and return the filepath. # If dirpath is not provided, the file will be downloaded to a temp directory. # If filename is provided, the file will be named using filename. # It is possible to pass extra request options (eg. for authentication) using **kwargs. filepath = fsutil.download_file(url, dirpath=None, filename="archive.zip", chunk_size=8192, **kwargs)

# Check if a directory of a file exists at the given path. value = fsutil.exists(path)

# Extract tar file at path to dest path. # If autodelete, the archive will be deleted after extraction. # If content_paths list is defined, only listed items will be extracted, otherwise all. fsutil.extract_tar_file(path, dest, content_paths=None, autodelete=False)

# Extract zip file at path to dest path. # If autodelete, the archive will be deleted after extraction. # If content_paths list is defined, only listed items will be extracted, otherwise all. fsutil.extract_zip_file(path, dest, content_paths=None, autodelete=False)

# Get the directory creation date. date = fsutil.get_dir_creation_date(path)

# Get the directory creation date formatted using the given format. date_str = fsutil.get_dir_creation_date_formatted(path, format='%Y-%m-%d %H:%M:%S')

# Get the hash of the directory at the given path using # the specified algorithm function (md5 by default). hash = fsutil.get_dir_hash(path, func="md5")

# Get the directory last modification date. date = fsutil.get_dir_last_modified_date(path)

# Get the directory last modification date formatted using the given format. date_str = fsutil.get_dir_last_modified_date_formatted(path, format="%Y-%m-%d %H:%M:%S")

# Get the directory size in bytes. size = fsutil.get_dir_size(path)

# Get the directory size formatted using the right unit suffix. size_str = fsutil.get_dir_size_formatted(path)

# Get the file basename from the given path/url. basename = fsutil.get_file_basename(path)

# Get the file creation date. date = fsutil.get_file_creation_date(path)

# Get the file creation date formatted using the given format. date_str = fsutil.get_file_creation_date_formatted(path, format="%Y-%m-%d %H:%M:%S")

# Get the file extension from the given path/url. extension = fsutil.get_file_extension(path)

# Get the hash of the file at the given path using # the specified algorithm function (md5 by default). filehash = fsutil.get_file_hash(path, func="md5")

# Get the file last modification date. date = fsutil.get_file_last_modified_date(path)

# Get the file last modification date formatted using the given format. date_str = fsutil.get_file_last_modified_date_formatted(path, format="%Y-%m-%d %H:%M:%S")

# Get the file size in bytes. size = fsutil.get_file_size(path)

# Get the file size formatted using the right unit suffix. size_str = fsutil.get_file_size_formatted(path)

# Get the filename from the given path/url. filename = fsutil.get_filename(path)

# Get the parent directory for the given path going up N levels. parent_dir = fsutil.get_parent_dir(path, levels=1)

# Get the file/directory permissions. permissions = fsutil.get_permissions(path)

# Get a unique name for a directory/file at the given directory path. unique_name = fsutil.get_unique_name(path, prefix="", suffix="", extension="", separator="-")

# Determine whether the specified path represents an existing directory. value = fsutil.is_dir(path)

# Determine whether the specified path represents an empty directory or an empty file. value = fsutil.is_empty(path)

# Determine whether the specified path represents an empty directory. value = fsutil.is_empty_dir(path)

# Determine whether the specified path represents an empty file. value = fsutil.is_empty_file(path)

# Determine whether the specified path represents an existing file. value = fsutil.is_file(path)

# Create a filename joining the file basename and the extension. filename = fsutil.join_filename(basename, extension)

# Create a filepath joining the directory path and the filename. filepath = fsutil.join_filepath(dirpath, filename)

# Create a path joining path and paths. # If path is __file__ (or a .py file), the resulting path will be relative # to the directory path of the module in which it's used. path = fsutil.join_path(path, *paths)

# List all directories contained at the given directory path. dirs = fsutil.list_dirs(path)

# List all files contained at the given directory path. files = fsutil.list_files(path)

# Create the directories needed to ensure that the given path exists. # If a file already exists at the given path an OSError is raised. fsutil.make_dirs(path)

# Create the directories needed to ensure that the given path exists. # If a directory already exists at the given path an OSError is raised. fsutil.make_dirs_for_file(path)

# Move an existing dir from path to dest directory. # If overwrite is not allowed and dest path exists, an OSError is raised. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.move fsutil.move_dir(path, dest, overwrite=False, **kwargs)

# Move an existing file from path to dest directory. # If overwrite is not allowed and dest path exists, an OSError is raised. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.move fsutil.move_file(path, dest, overwrite=False, **kwargs)

# Read the content of the file at the given path using the specified encoding. content = fsutil.read_file(path, encoding="utf-8")

# Read the content of the file at the given url. content = fsutil.read_file_from_url(url, **kwargs)

# Read and decode a json encoded file at the given path. data = fsutil.read_file_json(path, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None)

# Read file content lines. # It is possible to specify the line indexes (negative indexes too), # very useful especially when reading large files. content = fsutil.read_file_lines(path, line_start=0, line_end=-1, strip_white=True, skip_empty=True, encoding="utf-8")

# Read file lines count. lines_count = fsutil.read_file_lines_count(path)

# Remove a directory at the given path and all its content. # If the directory is removed with success returns True, otherwise False. # More informations about kwargs supported options here: # https://docs.python.org/3/library/shutil.html#shutil.rmtree fsutil.remove_dir(path, **kwargs)

# Removes all directory content (both sub-directories and files). fsutil.remove_dir_content(path)

# Remove multiple directories at the given paths and all their content. fsutil.remove_dirs(*paths)

# Remove a file at the given path. # If the file is removed with success returns True, otherwise False. fsutil.remove_file(path)

# Remove multiple files at the given paths. fsutil.remove_files(*paths)

# Rename a directory with the given name. # If a directory or a file with the given name already exists, an OSError is raised. fsutil.rename_dir(path, name)

# Rename a file with the given name. # If a directory or a file with the given name already exists, an OSError is raised. fsutil.rename_file(path, name)

# Rename a file basename with the given basename. fsutil.rename_file_basename(path, basename)

# Rename a file extension with the given extension. fsutil.rename_file_extension(path, extension)

# Replace directory at the specified path with the directory located at src. # If autodelete, the src directory will be removed at the end of the operation. # Optimized for large directories. fsutil.replace_dir(path, src, autodelete=False)

# Replace file at the specified path with the file located at src. # If autodelete, the src file will be removed at the end of the operation. # Optimized for large files. fsutil.replace_file(path, src, autodelete=False)

# Search for directories at path matching the given pattern. dirs = fsutil.search_dirs(path, pattern="**/*")

# Search for files at path matching the given pattern. files = fsutil.search_files(path, pattern="**/*.*")

# Set the file/directory permissions. fsutil.set_permissions(path, 700)

# Split a filename and returns its basename and extension. basename, extension = fsutil.split_filename(path)

# Split a filename and returns its directory-path and filename. dirpath, filename = fsutil.split_filepath(path)

# Split a path and returns its path-names. path_names = fsutil.split_path(path)

# Trasform a filepath by applying the provided optional changes. filepath = fsutil.transform_filepath(path, dirpath=None, basename=lambda b: slugify(b), extension="webp")

# Write file with the specified content at the given path. fsutil.write_file(path, content, append=False, encoding="utf-8", atomic=False)

# Write a json file at the given path with the specified data encoded in json format. fsutil.write_file_json(path, data, encoding="utf-8", atomic=False, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False)