Skip to content

bundletypemaker

Create necessary compiled types for pyRevit bundles.

Attributes

mlogger = logger.get_logger(__name__) module-attribute

Functions

create_bundle_type(module_builder, type_name, bundle_script, bundle_config_script, bundle_search_paths, bundle_arguments, bundle_help_url, bundle_tooltip, bundle_name, bundle_full_name, bundle_extension_name, bundle_unique_name, bundle_control_id, bundle_context, engine_cfgs)

Source code in pyrevitlib/pyrevit/runtime/bundletypemaker.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def create_bundle_type(
        module_builder,
        type_name,
        bundle_script,
        bundle_config_script,
        bundle_search_paths,
        bundle_arguments,
        bundle_help_url,
        bundle_tooltip,
        bundle_name,
        bundle_full_name,
        bundle_extension_name,
        bundle_unique_name,
        bundle_control_id,
        bundle_context,
        engine_cfgs,
    ):
    runtime.create_type(
        module_builder,
        runtime.CMD_EXECUTOR_TYPE,
        type_name,
        runtime.create_ext_command_attrs(),
        bundle_script,
        bundle_config_script,
        coreutils.join_strings(bundle_search_paths),
        coreutils.join_strings(bundle_arguments),
        bundle_help_url,
        bundle_tooltip,
        bundle_name,
        bundle_full_name,
        bundle_extension_name,
        bundle_unique_name,
        bundle_control_id,
        bundle_context,
        engine_cfgs)

create_executor_type(extension, module_builder, cmd_component, eng_cfgs='')

Source code in pyrevitlib/pyrevit/runtime/bundletypemaker.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def create_executor_type(extension, module_builder, cmd_component, eng_cfgs=''):
    mlogger.debug('Creating executor type for: %s', cmd_component)
    mlogger.debug('%s uses clean engine: %s',
                  cmd_component.name, cmd_component.requires_clean_engine)
    mlogger.debug('%s requires Fullframe engine: %s',
                  cmd_component.name, cmd_component.requires_fullframe_engine)
    mlogger.debug('%s requires Fullframe engine: %s',
                  cmd_component.name, cmd_component.requires_fullframe_engine)

    create_bundle_type(
        module_builder=module_builder,
        type_name=cmd_component.unique_name,
        bundle_script=cmd_component.script_file or "",
        bundle_config_script=cmd_component.config_script_file or "",
        bundle_search_paths=cmd_component.module_paths,
        bundle_arguments=cmd_component.arguments,
        bundle_help_url=cmd_component.help_url or "",
        bundle_tooltip=cmd_component.tooltip or "",
        bundle_name=cmd_component.name,
        bundle_full_name=cmd_component.get_full_bundle_name(),
        bundle_extension_name=extension.name,
        bundle_unique_name=cmd_component.unique_name,
        bundle_control_id=cmd_component.control_id,
        bundle_context=cmd_component.context or "",
        engine_cfgs=eng_cfgs
        )

    mlogger.debug('Successfully created executor type for: %s', cmd_component)

create_selection_avail_type(module_builder, cmd_component)

Source code in pyrevitlib/pyrevit/runtime/bundletypemaker.py 
80
81
82
83
84
85
def create_selection_avail_type(module_builder, cmd_component):
    runtime.create_type(module_builder,
                        runtime.CMD_AVAIL_TYPE_SELECTION,
                        cmd_component.avail_class_name,
                        [],
                        cmd_component.context)

create_zerodoc_avail_type(module_builder, cmd_component)

Source code in pyrevitlib/pyrevit/runtime/bundletypemaker.py 
88
89
90
91
92
def create_zerodoc_avail_type(module_builder, cmd_component):
    runtime.create_type(module_builder,
                        runtime.CMD_AVAIL_TYPE_ZERODOC,
                        cmd_component.avail_class_name,
                        [])

create_extended_avail_type(module_builder, cmd_component)

Source code in pyrevitlib/pyrevit/runtime/bundletypemaker.py 
 95
 96
 97
 98
 99
100
def create_extended_avail_type(module_builder, cmd_component):
    runtime.create_type(module_builder,
                        runtime.CMD_AVAIL_TYPE_EXTENDED,
                        cmd_component.avail_class_name,
                        [],
                        cmd_component.context)