Skip to content

test_query_get_name

Revit-hosted tests for pyrevit.revit.db.query.get_name.

Run from Revit via the pyRevit DevTools "Query get_name Tests" button (doc-project context). Validates workset support and IronPython 2 Name fallback.

Attributes

basestring = str module-attribute

Classes

GetNameQueryTests

Bases: TestCase

Tests for query.get_name with Workset and Element types.

Functions

setUp()
Source code in pyrevitlib/pyrevit/unittests/test_query_get_name.py 
65
66
67
def setUp(self):
    if revit.doc.IsFamilyDocument:
        self.skipTest("Requires model document, not family document")
test_get_name_workset()

get_name returns workset.Name for DB.Workset.

Source code in pyrevitlib/pyrevit/unittests/test_query_get_name.py 
69
70
71
72
73
74
75
76
def test_get_name_workset(self):
    """get_name returns workset.Name for DB.Workset."""
    workset = _first_workset(revit.doc)
    if workset is None:
        self.skipTest("No worksets in document")
    name = query.get_name(workset)
    self.assertTrue(_is_text(name))
    self.assertEqual(name, workset.Name)
test_get_name_wall_type_string()

get_name returns a string for WallType; IPY2 matches GetValue.

Source code in pyrevitlib/pyrevit/unittests/test_query_get_name.py 
78
79
80
81
82
83
84
85
86
87
88
89
def test_get_name_wall_type_string(self):
    """get_name returns a string for WallType; IPY2 matches GetValue."""
    wall_type = _first_of_class(revit.doc, DB.WallType)
    if wall_type is None:
        self.skipTest("No WallType in document")
    name = query.get_name(wall_type)
    self.assertTrue(
        _is_text(name),
        "get_name(WallType) must be text, got {0!r}".format(type(name)),
    )
    if IRONPY2:
        self.assertEqual(name, Element.Name.GetValue(wall_type))
test_get_name_family_symbol_string()

get_name returns a string for FamilySymbol; IPY2 matches GetValue.

Source code in pyrevitlib/pyrevit/unittests/test_query_get_name.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def test_get_name_family_symbol_string(self):
    """get_name returns a string for FamilySymbol; IPY2 matches GetValue."""
    symbol = _first_of_class(revit.doc, DB.FamilySymbol)
    if symbol is None:
        self.skipTest("No FamilySymbol in document")
    name = query.get_name(symbol)
    self.assertTrue(
        _is_text(name),
        "get_name(FamilySymbol) must be text, got {0!r}".format(type(name)),
    )
    if IRONPY2:
        self.assertEqual(name, Element.Name.GetValue(symbol))
test_get_name_room_string()

get_name returns a string for Room when rooms exist; IPY2 matches GetValue.

Source code in pyrevitlib/pyrevit/unittests/test_query_get_name.py 
104
105
106
107
108
109
110
111
112
113
114
115
def test_get_name_room_string(self):
    """get_name returns a string for Room when rooms exist; IPY2 matches GetValue."""
    room = _first_placed_room(revit.doc)
    if room is None:
        self.skipTest("No placed Room in document")
    name = query.get_name(room)
    self.assertTrue(
        _is_text(name),
        "get_name(Room) must be text, got {0!r}".format(type(name)),
    )
    if IRONPY2:
        self.assertEqual(name, Element.Name.GetValue(room))