duHast.pyRevit package

Subpackages

• duHast.pyRevit.Objects package
  • Submodules
  • duHast.pyRevit.Objects.ProgressPyRevit module
    • A class used to wrap the pyRevit progress bar form into a call back function.
    • ProgressPyRevit
      • ProgressPyRevit.update()
      • ProgressPyRevit.is_cancelled()
  • duHast.pyRevit.Objects.WPFWindowBasePyRevit module
    • An implementation of a custom wpf window base class which can be shown in the Revit context.
    • WPFWindowBase
      • WPFWindowBase.on_current_view_model_changed()
      • WPFWindowBase.update_content_view()
      • WPFWindowBase.on_closed()
      • WPFWindowBase.action_on_close()
  • Module contents
• duHast.pyRevit.UI package
  • Submodules
  • duHast.pyRevit.UI.multiselectors module
    • A module to provide pyRevit multiselectors for some standard Revit elements.
    • room_selector()
    • pick_room()
    • pick_rooms()
    • level_selector()
    • pick_level()
    • pick_levels()
  • Module contents

Submodules

duHast.pyRevit.console_output module

A number of helper functions relating to py pyrevit output to console duHast result class.

duHast.pyRevit.console_output.print_result(result, header=None)

Prints a result class instance to the pyRevit console.

Parameters:

• result (Result) – The result instance to be printed.

• header (str) – The header to be printed before the result.

duHast.pyRevit.console_output.print_header(header)

Prints a header to the pyRevit console.

Parameters:

header (str) – The header to be printed.

duHast.pyRevit.console_output.print_error(message)

Prints an error message to the pyRevit console.

Parameters:

message (str) – The error message to be printed.

duHast.pyRevit.directory_picker module

A number of helper functions relating to pyrevit directory selection.

duHast.pyRevit.directory_picker.get_user_options(forms)

Gets the user options for saving out families

Options are: save out to single directory, exclude existing families, overwrite existing families

Parameters:

forms (Forms) – the forms object

Returns:

the user options

Return type:

dict

duHast.pyRevit.directory_picker.get_process_directories(forms, form_title='Select directory')

Gets the directories to process

Parameters:

forms (Forms) – the forms object

Returns:

the directories to process

Return type:

list

duHast.pyRevit.directory_picker.get_process_directory(forms, form_title='Select directory')

Gets the directories to process

Parameters:

forms (Forms) – the forms object

Returns:

the directories to process

Return type:

list

duHast.pyRevit.file_picker module

This module contains a pyRevit file picker wrapper function.

duHast.pyRevit.file_picker.get_file_path_from_user(forms, title, file_extension, multi_file=False)

Very simple wrapper function to get a file path from the user.

Parameters:

• forms (pyRevit forms module) – pyRevit forms

• title (str) – The title of the file picker dialog.

• file_extension (str) – The file extension to filter for. Example: “csv”

• multi_file (bool, optional) – Single vs multi file selection, defaults to False (single file)

Returns:

The file path(s) selected by the user. None if no file was selected.

Return type:

str, [str],None

duHast.pyRevit.net_dll_loader module

duHast.pyRevit.net_dll_loader.load_net_dll_path(dlls_to_load)

Loads dlls from the libs folder of the duHast extension. Useful if a dll is not loaded through the startup script of a pyRevit extension.

Parameters:

dlls_to_load (list) – List of dlls to load.

Returns:

Result object with status and message.

Return type:

Result

duHast.pyRevit.ui_element_selection module

This module contains a number of helper functions relating to py Revit element selection from list.

duHast.pyRevit.ui_element_selection.default_name_builder(element)

Deafult element name builder is used to build the element name shown in the UI by combining the element name and element Id

Parameters:

element (Autodesk.Revit.DB.Element) – An element

Returns:

A name of the element.

Return type:

str

duHast.pyRevit.ui_element_selection.get_element_selection_from_user(doc, forms, element_getter, element_selection_description, multiselect=True, ui_element_name_builder=<function default_name_builder>)

lists Elements provided by element getter function in UI and returns the users selection

Parameters:

• doc (Autodesk.Revit.DB.Document) – Ther current Revit model.

• forms (_type_) – pyRevit forms

• element_getter (_type_) – Function accpeting the document as the only argument returning a list of elements or empty list.

• element_selection_description (str) – Text to be displayes on button to prompt user

Returns:

None if nothing was selected. Otherwise a list of element ids

Return type:

None or [Autodesk.Revit.ElementId]

Module contents