report

"Utility methods for reporting Revit data uniformly.

Attributes

app = HOST_APP.app module-attribute

doc = HOST_APP.doc module-attribute

revit_version = int(app.VersionNumber) module-attribute

Classes

Functions

print_revision(rev, prefix='', print_id=True)

Print a revision.

Parameters:

Name	Type	Description	Default
rev	Revision	revision to output	required
prefix	str	prefix to add to the output text. Defaults to empty string.	''
print_id	bool	whether to print the revision id. Defaults to True.	True

Source code in pyrevitlib/pyrevit/revit/report.py

def print_revision(rev, prefix='', print_id=True):
    """Print a revision.

    Args:
        rev (DB.Revision): revision to output
        prefix (str, optional): prefix to add to the output text. Defaults to empty string.
        print_id (bool, optional): whether to print the revision id. Defaults to True.
    """

    if revit_version > 2022:
        revision_sequence = doc.GetElement(rev.RevisionNumberingSequenceId)
        revision_number_type = revision_sequence.NumberType
    else:
        revision_number_type = rev.NumberType

    outstr = 'SEQ#: {} REV#: {} DATE: {} TYPE: {} DESC: {} ' \
             .format(rev.SequenceNumber,
                     str(rev.RevisionNumber).ljust(5),
                     str(rev.RevisionDate).ljust(10),
                     str(revision_number_type).ljust(15),
                     str(rev.Description).replace('\n', '').replace('\r', ''))
    if print_id:
        outstr = PyRevitOutputWindow.linkify(rev.Id) + '\t' + outstr
    print(prefix + outstr)

print_sheet(sht, prefix='', print_id=True)

Print the name of a sheet.

Parameters:

Name	Type	Description	Default
sht	ViewSheet	sheet to output	required
prefix	str	prefix to add to the output text. Defaults to empty string.	''
print_id	bool	whether to print the sheet id. Defaults to True.	True

Source code in pyrevitlib/pyrevit/revit/report.py

def print_sheet(sht, prefix='', print_id=True):
    """Print the name of a sheet.

    Args:
        sht (DB.ViewSheet): sheet to output
        prefix (str, optional): prefix to add to the output text. Defaults to empty string.
        print_id (bool, optional): whether to print the sheet id. Defaults to True.
    """
    outstr = '{}\t{}'.format(
        sht.Parameter[DB.BuiltInParameter.SHEET_NUMBER].AsString(),
        sht.Parameter[DB.BuiltInParameter.SHEET_NAME].AsString()
        )
    if print_id:
        outstr = PyRevitOutputWindow.linkify(sht.Id) + '\t' + outstr
    print(prefix + outstr)

print_view(view, prefix='', print_id=True)

Print the name of a view.

Parameters:

Name	Type	Description	Default
view	View	view to output	required
prefix	str	prefix to add to the output text. Defaults to empty string.	''
print_id	bool	whether to print the view id. Defaults to True.	True

Source code in pyrevitlib/pyrevit/revit/report.py

def print_view(view, prefix='', print_id=True):
    """Print the name of a view.

    Args:
        view (DB.View): view to output
        prefix (str, optional): prefix to add to the output text. Defaults to empty string.
        print_id (bool, optional): whether to print the view id. Defaults to True.
    """
    outstr = query.get_name(view)
    if print_id:
        outstr = PyRevitOutputWindow.linkify(view.Id) + '\t' + outstr
    print(prefix + outstr)