pyiron_snippets.files module

class pyiron_snippets.files.DirectoryObject(directory: str | Path | DirectoryObject = '.', generate_unique_directory: bool | None = None, protected: bool | None = None)

Bases: object

A class to represent a directory object that can be created, deleted, and managed. It can also compress and decompress its contents. It supports unique directory generation and can be protected from deletion on garbage collection.

compress(exclude_files: list[str | Path] | None = None)

create()

create_subdirectory(path: str | Path | None = None) → DirectoryObject

decompress()

delete(only_if_empty: bool = False)

file_exists(file_name)

get_path(file_name)

is_empty() → bool

list_content()

remove_files(*files: str)

write(file_name, content, mode='w')

pyiron_snippets.files.categorize_folder_items(folder_path)

pyiron_snippets.files.delete_files_and_directories_recursively(path)