duHast.Revit.Family.LibraryCleanUp package

Subpackages

• duHast.Revit.Family.LibraryCleanUp.Utility package
  • Submodules
  • duHast.Revit.Family.LibraryCleanUp.Utility.defaults module
  • duHast.Revit.Family.LibraryCleanUp.Utility.directive_maintain_types_execute module
    • update_type_catalogue_file()
    • get_names_of_types_to_keep()
    • create_default_type()
    • delete_non_conforming_types()
  • duHast.Revit.Family.LibraryCleanUp.Utility.directives_checks module
    • verify_copy_directives_are_unique()
    • check_directives()
  • duHast.Revit.Family.LibraryCleanUp.Utility.directives_create module
    • get_code_to_use()
    • get_unique_group_codes_from_family()
    • create_copy_directive_catalogue_file()
    • create_copy_directives()
    • create_type_maintained_lists()
    • create_swap_directives()
    • create_directives()
  • duHast.Revit.Family.LibraryCleanUp.Utility.directives_execute module
    • execute_copy_directives_for_library_families()
  • duHast.Revit.Family.LibraryCleanUp.Utility.directives_read_from_file module
    • read_maintain_types()
  • duHast.Revit.Family.LibraryCleanUp.Utility.directives_write_to_file module
    • write_maintain_list()
    • write_swap_directives()
    • write_copy_directives()
    • write_duplicate_directives_to_file()
    • write_directives_to_file()
    • write_families_with_missing_group_codes()
  • duHast.Revit.Family.LibraryCleanUp.Utility.family_file_name module
    • clean_up_family_name()
    • build_family_name_from_descriptor()
  • duHast.Revit.Family.LibraryCleanUp.Utility.family_load module
    • get_families_to_be_loaded_for_swapping()
    • load_families_required_for_swapping()
  • duHast.Revit.Family.LibraryCleanUp.Utility.grouping_code module
    • clean_code()
    • convert_to_file_name_code()
    • load_group_code_description()
  • duHast.Revit.Family.LibraryCleanUp.Utility.write_task_lists module
    • write_task_lists()
  • Module contents

Submodules

duHast.Revit.Family.LibraryCleanUp.in_process module

duHast.Revit.Family.LibraryCleanUp.in_process.in_process_family(doc, library_path, output)

duHast.Revit.Family.LibraryCleanUp.post_process module

duHast.Revit.Family.LibraryCleanUp.post_process.move_files(files, destination_directory, output)

Moves files to the specified destination directory.

Parameters:

• files (list[str]) – List of file paths to be moved.

• destination_directory (str) – Directory where the files will be moved.

• output (function) – Output function to log messages.

Returns:

True if all files were moved successfully, False otherwise.

Return type:

bool

duHast.Revit.Family.LibraryCleanUp.post_process.get_part_atom_files_from_families(file_path)

Gets part atom files from the specified family file path.

Parameters:

file_path – list of Path to the family files.

Returns:

List of part atom files.

duHast.Revit.Family.LibraryCleanUp.post_process.move_original_families_to_backup_directory(family_copy_directive_directory, backupPath, output)

Moves original families from the library path to the backup path.

Parameters:

• family_copy_directive_directory (str) – Directory containing family copy directives.

• backupPath (str) – Path to the backup directory where families will be moved.

• output (function) – Output function to log messages.

Returns:

Result object indicating success or failure of the operation.

Return type:

Result

duHast.Revit.Family.LibraryCleanUp.post_process.copy_new_families_to_library(output_path, library_path, output)

Copies new families from the output path to the library path. :param output_path: Path where new families are located. :type output_path: str :param library_path: Path to the library where families will be copied. :type library_path: str :param output: Output function to log messages. :type output: function

Returns:

Result object indicating success or failure of the operation.

Return type:

Result

duHast.Revit.Family.LibraryCleanUp.post_process.post_process_family(output_path, library_path, backup_directory_path, output)

Post-process function to handle the final steps after family processing.

This function copies new families to the library and moves original families to a backup directory.

Parameters:

• output_path (str) – Path where new families are located.

• library_path (str) – Path to the library where new families will be copied to.

• backup_directory_path (str) – Path to the backup directory where original families will be moved.

Returns:

Result object indicating the success or failure of the post-processing step.

Return type:

Result

duHast.Revit.Family.LibraryCleanUp.pre_process module

duHast.Revit.Family.LibraryCleanUp.pre_process.get_family_data_from_file(libraryPath)

Extracts family type data from XML files in the specified library path.

Returns:

Result class instance.

• result.status: XML conversion status will be returned in result.status. False if an exception occurred, otherwise True.

• result.message will contain which xml file was read and converted into family type data.

• result.result will be [FamilyTypeDataStorageManager]

On exception

• Reload.status (bool) will be False

• Reload.message will contain the exception message

• Reload.result will be an empty list

Return type:

Result

duHast.Revit.Family.LibraryCleanUp.pre_process.pre_process(library_path, output_path, task_list_directory_path, code_descriptor_path, output)

Pre-process function to prepare for the family type data extraction.

This function is a placeholder for any pre-processing steps that may be needed before extracting family type data from the library.

Parameters:

• library_path (str) – Path to the library containing family files to be renamed.

• output_path (str) – Path where the directives will be written and changed family files will be copied to.

• task_list_directory_path (str) – Path where the task lists for RBP will be written.

• code_descriptor_path (str) – Path to the code descriptor file. (AUSHFG)

• output – Output object to write messages to.

Returns:

Result object indicating the success or failure of the pre-processing step.

Return type:

Result

Module contents