piel.file_system ================ .. py:module:: piel.file_system Attributes ---------- .. autoapisummary:: piel.file_system.rp Functions --------- .. autoapisummary:: piel.file_system.check_path_exists piel.file_system.check_example_design piel.file_system.copy_source_folder piel.file_system.copy_example_design piel.file_system.create_new_directory piel.file_system.create_piel_home_directory piel.file_system.delete_path piel.file_system.delete_path_list_in_directory piel.file_system.get_files_recursively_in_directory piel.file_system.get_id_map_directory_dictionary piel.file_system.get_top_level_script_directory piel.file_system.list_prefix_match_directories piel.file_system.permit_script_execution piel.file_system.permit_directory_all piel.file_system.read_json piel.file_system.rename_file piel.file_system.rename_files_in_directory piel.file_system.replace_string_in_file piel.file_system.replace_string_in_directory_files piel.file_system.return_path piel.file_system.run_script piel.file_system.write_file piel.file_system.write_model_to_json Module Contents --------------- .. py:function:: check_path_exists(path: piel.types.PathTypes, raise_errors: bool = False) -> bool Checks if a directory exists. :param path: Input path. :type path: PathTypes :returns: True if directory exists. :rtype: directory_exists(bool) .. py:function:: check_example_design(design_name: str = 'simple_design', designs_directory: piel.types.PathTypes | None = None) -> bool We copy the example simple_design from docs to the `/foss/designs` in the `iic-osic-tools` environment. :param design_name: Name of the design to check. :type design_name: str :param designs_directory: Directory that contains the DESIGNS environment flag. :type designs_directory: PathTypes :param # TODO: :returns: None .. py:function:: copy_source_folder(source_directory: piel.types.PathTypes, target_directory: piel.types.PathTypes, delete: bool = None) -> None Copies the files from a source_directory to a target_directory :param source_directory: Source directory. :type source_directory: PathTypes :param target_directory: Target directory. :type target_directory: PathTypes :param delete: Delete target directory. Default: False. :type delete: bool :returns: None .. py:function:: copy_example_design(project_source: piel.types.ProjectType = 'piel', example_name: str = 'simple_design', target_directory: piel.types.PathTypes = None, target_project_name: Optional[str] = None, **kwargs) -> None We copy the example simple_design from docs to the `/foss/designs` in the `iic-osic-tools` environment. :param project_source: Source of the project. :type project_source: str :param example_name: Name of the example design. :type example_name: str :param target_directory: Target directory. :type target_directory: PathTypes :param target_project_name: Name of the target project. :type target_project_name: str :returns: None .. py:function:: create_new_directory(directory_path: str | pathlib.Path, overwrite: bool = False) -> bool Creates a new directory. If the parents of the target_directory do not exist, they will be created too. :param overwrite: Overwrite directory if it already exists. :param directory_path: Input path. :type directory_path: str | pathlib.Path :returns: None .. py:function:: create_piel_home_directory() -> None Creates the piel home directory. :returns: None .. py:function:: delete_path(path: str | pathlib.Path) -> None Deletes a path. :param path: Input path. :type path: str | pathlib.Path :returns: None .. py:function:: delete_path_list_in_directory(directory_path: piel.types.PathTypes, path_list: list, ignore_confirmation: bool = False, validate_individual: bool = False) -> None Deletes a list of files in a directory. Usage: ```python delete_path_list_in_directory( directory_path=directory_path, path_list=path_list, ignore_confirmation=True ) ``` :param directory_path: Input path. :type directory_path: PathTypes :param path_list: List of files. :type path_list: list :param ignore_confirmation: Ignore confirmation. Default: False. :type ignore_confirmation: bool :param validate_individual: Validate individual files. Default: False. :type validate_individual: bool :returns: None .. py:function:: get_files_recursively_in_directory(path: piel.types.PathTypes, extension: str = '*') Returns a list of files in a directory. Usage: get_files_recursively_in_directory('path/to/directory', 'extension') :param path: Input path. :type path: PathTypes :param extension: File extension. :type extension: str :returns: List of files. :rtype: file_list(list) .. py:function:: get_id_map_directory_dictionary(path_list: list[piel.types.PathTypes], target_prefix: str) Returns a dictionary of ids to directories. Usage: get_id_to_directory_dictionary(path_list, target_prefix) :param path_list: List of paths. :type path_list: list[PathTypes] :param target_prefix: Target prefix. :type target_prefix: str :returns: Dictionary of ids to directories. :rtype: id_dict(dict) .. py:function:: get_top_level_script_directory() -> pathlib.Path Attempts to return the top-level script directory when this file is run, compatible with various execution environments like Jupyter Lab, pytest, PDM, etc. TODO run full verification. :returns: Top level script directory. :rtype: top_level_script_directory(pathlib.Path) .. py:function:: list_prefix_match_directories(output_directory: piel.types.PathTypes, target_prefix: str) Returns a list of directories that match a prefix. Usage: list_prefix_match_directories('path/to/directory', 'prefix') :param output_directory: Output directory. :type output_directory: PathTypes :param target_prefix: Target prefix. :type target_prefix: str :returns: List of directories. :rtype: matching_dirs(list) .. py:function:: permit_script_execution(script_path: piel.types.PathTypes) -> None Permits the execution of a script. Usage: permit_script_execution('path/to/script') :param script_path: Script path. :type script_path: PathTypes :returns: None .. py:function:: permit_directory_all(directory_path: piel.types.PathTypes) -> None Permits a directory to be read, written and executed. Use with care as it can be a source for security issues. Usage: permit_directory_all('path/to/directory') :param directory_path: Input path. :type directory_path: PathTypes :returns: None .. py:function:: read_json(path: piel.types.PathTypes) -> dict Reads a JSON file. Usage: read_json('path/to/file.json') :param path: Input path. :type path: PathTypes :returns: JSON files. :rtype: json_data(dict) .. py:function:: rename_file(match_file_path: piel.types.PathTypes, renamed_file_path: piel.types.PathTypes) -> None Renames a file. Usage: rename_file('path/to/match_file', 'path/to/renamed_file') :param match_file_path: Input path. :type match_file_path: PathTypes :param renamed_file_path: Input path. :type renamed_file_path: PathTypes :returns: None .. py:function:: rename_files_in_directory(target_directory: piel.types.PathTypes, match_string: str, renamed_string: str) -> None Renames all files in a directory. Usage: rename_files_in_directory('path/to/directory', 'match_string', 'renamed_string') :param target_directory: Input path. :type target_directory: PathTypes :param match_string: String to match. :type match_string: str :param renamed_string: String to replace. :type renamed_string: str :returns: None .. py:function:: replace_string_in_file(file_path: piel.types.PathTypes, match_string: str, replace_string: str) Replaces a string in a file. Usage: replace_string_in_file('path/to/file', 'match_string', 'replace_string') :param file_path: Input path. :type file_path: PathTypes :param match_string: String to match. :type match_string: str :param replace_string: String to replace. :type replace_string: str :returns: None .. py:function:: replace_string_in_directory_files(target_directory: piel.types.PathTypes, match_string: str, replace_string: str) Replaces a string in all files in a directory. Usage: replace_string_in_directory_files('path/to/directory', 'match_string', 'replace_string') :param target_directory: Input path. :type target_directory: PathTypes :param match_string: String to match. :type match_string: str :param replace_string: String to replace. :type replace_string: str :returns: None .. py:function:: return_path(input_path: piel.types.PathTypes, as_piel_module: bool = False) -> pathlib.Path Returns a pathlib.Path to be able to perform operations accordingly internally. This allows us to maintain compatibility between POSIX and Windows systems. When the `as_piel_module` flag is enabled, it will analyse whether the input path can be treated as a piel module, and treat the returned path as a module would be treated. This comes useful when analysing files generated in this particular structure accordingly. Usage: return_path('path/to/file') :param input_path: Input path. :type input_path: str :returns: Pathlib path. :rtype: pathlib.Path .. py:data:: rp .. py:function:: run_script(script_path: piel.types.PathTypes, program: str = None) -> None Runs a script on the filesystem `script_path`. By default this is a bash script. :param script_path: Script path. :type script_path: PathTypes :returns: None .. py:function:: write_file(directory_path: piel.types.PathTypes, file_text: str, file_name: str, append: bool = False) -> bool Writes a file to a directory. Appends to the file if it exists and append is True. :param directory_path: Directory path. :type directory_path: PathTypes :param file_text: File text. :type file_text: str :param file_name: File name. :type file_name: str :param append: If True, appends to the file if it exists. Defaults to False. :type append: bool :returns: True if successful. :rtype: bool .. py:function:: write_model_to_json(model: piel.types.PielBaseModel, file_path: piel.types.PathTypes) Writes a pydantic model to a JSON file.