revitdevtool-pytest 0.2.0

pytest plugin for testing Revit API code via RevitDevTool Named Pipe bridge

RevitDevTool.PyTest

pytest plugin for testing Revit API code via RevitDevTool Named Pipe bridge. Tests run inside a live Revit process — write standard pytest, execute remotely.

Installation

pip install revitdevtool_pytest

Dependencies

Package	Version
Python	>= 3.10
pytest	>= 9.0
pywin32	>= 311

Requirements

• Windows (Named Pipes)
• Revit with RevitDevTool add-in installed and loaded

Project Setup

Recommended: scaffold your project with uv or pixi:

# uv
uv init my-revit-tests
cd my-revit-tests
uv add revitdevtool_pytest

# pixi (uses pyproject.toml as manifest)
pixi init --format pyproject my-revit-tests
cd my-revit-tests
pixi add --pypi revitdevtool_pytest

Configuration

Add plugin settings to [tool.pytest.ini_options] in your pyproject.toml:

[tool.pytest.ini_options]
revit_version = "2025"
revit_launch = false
revit_launch_timeout = "180"

Option	Type	Default	Description
revit_version	string	—	Revit version year (e.g. "2025"). Required when revit_launch = true.
revit_launch	bool	false	Force-launch a new Revit instance (skip reusing existing free instances).
revit_timeout	string	"60"	Per-test execution timeout in seconds.
revit_launch_timeout	string	"120"	Seconds to wait for Revit to start.
revit_pipe	string	—	Explicit pipe name (bypasses auto-discovery).

CLI flags override INI settings:

pytest --revit-launch --revit-version=2025 -v

Connection Behavior

• Default (revit_launch = false): plugin auto-discovers a running Revit instance matching revit_version via Named Pipe scan. If none found, exits with error.
• Force launch (revit_launch = true): always spawns a new Revit process, waits for its pipe to appear, then connects. Existing instances are ignored.

Print Output

Captured print() output from tests running inside Revit is automatically shown in the terminal for passing tests (equivalent to -rP). No extra flags needed.

Usage

Fixtures

Define fixtures in conftest.py that provide Revit API objects:

import pytest

@pytest.fixture(scope="session")
def revit_uiapp():
    return __revit__  # UIApplication injected by RevitDevTool

@pytest.fixture(scope="session")
def revit_app(revit_uiapp):
    return revit_uiapp.Application

@pytest.fixture(scope="session")
def revit_doc(revit_uiapp):
    return revit_uiapp.ActiveUIDocument.Document

Writing Tests

def test_active_view(revit_doc):
    view = revit_doc.ActiveView
    print(f"Active View: {view.Name}")
    assert view.Name is not None

def test_revit_version(revit_app):
    assert "2025" in revit_app.VersionName

PEP 723 Dependencies

Declare test-suite dependencies in conftest.py using PEP 723 metadata. RevitDevTool auto-installs them before test execution:

# /// script
# dependencies = [
#   "numpy>=2.0",
#   "polars>=1.0",
# ]
# ///

Running Tests

# With pyproject.toml configured:
pytest

# Override version for a single run:
pytest --revit-version=2026 -v

# Using uv or pixi:
uv run pytest
pixi run pytest

How It Works

1. pytest discovers and collects tests locally
2. Plugin intercepts pytest_runtestloop, connects to Revit via Named Pipe
3. Test nodeids are sent to Revit's PytestRunner.py (embedded in RevitDevTool)
4. Tests execute inside Revit's Python.NET environment with full API access
5. Results (pass/fail/skip, stdout, stderr, tracebacks) are returned via pipe
6. Plugin maps results back to standard pytest reports

IDE Integration

VS Code / Cursor

{
    "python.testing.pytestEnabled": true,
    "python.testing.pytestArgs": ["tests"]
}

PyCharm

Enable pytest as the test runner. Plugin auto-detects IDE adapters and disables streaming to avoid duplicate results in the test tree.

License

MIT