Skip to content

test_revit_module

Hosted unit tests for the pyrevit.revit module surface.

Run from Revit via the DevTools "Revit Module Tests" button (zero-doc context) or the "Run All Tests" aggregator. Document-dependent helpers are exercised with a skip-unless-doc pattern so the suite stays useful on an empty Revit session.

Classes

HostAppTests

Bases: TestCase

HOST_APP application wrapper sanity checks.

Methods:

setUp()

Grab the host application wrapper.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
16
17
18
19
20
def setUp(self):
    """Grab the host application wrapper."""
    from pyrevit import HOST_APP

    self.host_app = HOST_APP
test_host_app_available()

HOST_APP wraps a running Revit application.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
22
23
24
25
def test_host_app_available(self):
    """HOST_APP wraps a running Revit application."""
    self.assertIsNotNone(self.host_app)
    self.assertIsNotNone(self.host_app.app)
test_version_accessors()

Version accessors report a numeric Revit version.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
27
28
29
30
def test_version_accessors(self):
    """Version accessors report a numeric Revit version."""
    version = self.host_app.is_newer_than(2000)
    self.assertTrue(version)
test_uiapp_application()

Controlled application exposes the UI application.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
32
33
34
def test_uiapp_application(self):
    """Controlled application exposes the UI application."""
    self.assertIsNotNone(self.host_app.uiapp)

ModuleSurfaceTests

Bases: TestCase

pyrevit.revit submodules expose their documented entry points.

Methods:

test_query_module_entry_points()

Query module exposes core lookup helpers.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
def test_query_module_entry_points(self):
    """Query module exposes core lookup helpers."""
    from pyrevit.revit import query

    for name in (
        "get_builtincategory",
        "get_category",
        "get_param",
        "get_all_elements",
        "get_elements_by_class",
        "get_name",
    ):
        self.assertTrue(callable(getattr(query, name)))
test_selection_module_entry_points()

Selection module exposes selection helpers.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
54
55
56
57
58
def test_selection_module_entry_points(self):
    """Selection module exposes selection helpers."""
    from pyrevit.revit import selection

    self.assertTrue(callable(selection.get_selection))
test_transaction_classes()

Database modules expose Transaction and parameter wrappers.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
60
61
62
63
64
65
66
def test_transaction_classes(self):
    """Database modules expose Transaction and parameter wrappers."""
    from pyrevit.revit import db
    from pyrevit.revit.db import transaction

    self.assertTrue(hasattr(transaction, "Transaction"))
    self.assertTrue(hasattr(db, "ProjectParameter"))
test_events_module_entry_points()

Events module exposes subscribe/unsubscribe helpers.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
68
69
70
71
72
73
def test_events_module_entry_points(self):
    """Events module exposes subscribe/unsubscribe helpers."""
    from pyrevit.revit import events

    self.assertTrue(callable(events.handle))
    self.assertTrue(callable(events.stop_events))

UnitConversionTests

Bases: TestCase

Length parsing delegates conversion to Revit's unit API.

Methods:

test_parse_length_matches_unit_utils()

Metric text converts through the Revit millimeter unit identifier.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
79
80
81
82
83
84
85
86
87
88
89
90
def test_parse_length_matches_unit_utils(self):
    """Metric text converts through the Revit millimeter unit identifier."""
    from pyrevit import DB, HOST_APP
    from pyrevit.revit import units

    if HOST_APP.is_newer_than(2021):
        unit_id = DB.UnitTypeId.Millimeters
    else:
        unit_id = DB.DisplayUnitType.DUT_MILLIMETERS

    expected = DB.UnitUtils.ConvertToInternalUnits(900.0, unit_id)
    self.assertEqual(expected, units.parse_length("900mm"))
test_parse_length_converts_imperial_components_with_unit_utils()

Feet and inches text converts each component through Revit's unit API.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def test_parse_length_converts_imperial_components_with_unit_utils(self):
    """Feet and inches text converts each component through Revit's unit API."""
    from pyrevit import DB, HOST_APP
    from pyrevit.revit import units

    if HOST_APP.is_newer_than(2021):
        feet_id = DB.UnitTypeId.Feet
        inches_id = DB.UnitTypeId.Inches
    else:
        feet_id = DB.DisplayUnitType.DUT_DECIMAL_FEET
        inches_id = DB.DisplayUnitType.DUT_DECIMAL_INCHES

    expected = DB.UnitUtils.ConvertToInternalUnits(
        32.0, feet_id
    ) + DB.UnitUtils.ConvertToInternalUnits(6.5, inches_id)
    self.assertEqual(expected, units.parse_length("32' 6 1/2\""))

DocumentGatedTests

Bases: TestCase

Helpers that need an active project document (skip when absent).

Methods:

setUp()

Skip unless a project document is active.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
113
114
115
116
117
118
119
120
121
def setUp(self):
    """Skip unless a project document is active."""
    from pyrevit import revit

    if not revit.doc:
        self.skipTest("Requires open document")
    if revit.doc.IsFamilyDocument:
        self.skipTest("Requires project document, not family document")
    self.doc = revit.doc
test_get_doc_categories()

Document categories list non-empty on a project document.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
123
124
125
126
127
128
def test_get_doc_categories(self):
    """Document categories list non-empty on a project document."""
    from pyrevit.revit import query

    categories = list(query.get_doc_categories(doc=self.doc))
    self.assertTrue(categories)
test_get_all_elements()

Element collection returns elements of the active document.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
130
131
132
133
134
135
def test_get_all_elements(self):
    """Element collection returns elements of the active document."""
    from pyrevit.revit import query

    elements = query.get_all_elements(doc=self.doc)
    self.assertTrue(elements)
test_get_name_on_element()

Name lookup reads element names without schema errors.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
137
138
139
140
141
142
def test_get_name_on_element(self):
    """Name lookup reads element names without schema errors."""
    from pyrevit.revit import query

    name = query.get_name(self.doc.ProjectInformation)
    self.assertIsInstance(name, str)
test_get_builtincategory_round_trip()

Category resolution maps a category back to its enum value.

Source code in pyrevitlib/pyrevit/unittests/test_revit_module.py 
144
145
146
147
148
149
150
def test_get_builtincategory_round_trip(self):
    """Category resolution maps a category back to its enum value."""
    from pyrevit import DB
    from pyrevit.revit import query

    bicat = query.get_builtincategory(DB.BuiltInCategory.OST_Walls, doc=self.doc)
    self.assertEqual(DB.BuiltInCategory.OST_Walls, bicat)