Summary

Lazy-load TestCase to preventing pytest crashes.

Review Request #13324 — Created Oct. 9, 2023 and submitted Oct. 10, 2023, 2:03 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

In Review Board 6, the pytest fixtures were moved into

reviewboard.testing.pytest_fixtures. This caused pytest to have to

import reviewboard.testing on load. The problem there is that this

module forward-imports reviewboard.testing.testcase.TestCase, and this

module depends on a working Django environment first. That causes a

crash for pytest help output or operations that don't require setting up

a test environment.
We now lazily-import TestCase in this module so that we only pull it

in when explicitly requested. This is done through a module-level

__getattr__ (available in all supported versions of Python).
A TYPE_CHECKING-level import is done to ensure that importers see the

right type for this class.

Testing Done

Unit tests pass on Python 3.8-3.11.

I can run pytest --help without a crash.

Commits

Summary	ID
Lazy-load TestCase to preventing pytest crashes. In Review Board 6, the pytest fixtures were moved into `reviewboard.testing.pytest_fixtures`. This caused pytest to have to import `reviewboard.testing` on load. The problem there is that this module forward-imports `reviewboard.testing.testcase.TestCase`, and this module depends on a working Django environment first. That causes a crash for pytest help output or operations that don't require setting up a test environment. We now lazily-import `TestCase` in this module so that we only pull it in when explicitly requested. This is done through a module-level `__getattr__` (available in all supported versions of Python). A `TYPE_CHECKING`-level import is done to ensure that importers see the right type for this class.	a8dc79456c089fe5441107cf894bdf6482adc9bb

Summary

Lazy-load TestCase to preventing pytest crashes.

In Review Board 6, the pytest fixtures were moved into `reviewboard.testing.pytest_fixtures`. This caused pytest to have to import `reviewboard.testing` on load. The problem there is that this module forward-imports `reviewboard.testing.testcase.TestCase`, and this module depends on a working Django environment first. That causes a crash for pytest help output or operations that don't require setting up a test environment. We now lazily-import `TestCase` in this module so that we only pull it in when explicitly requested. This is done through a module-level `__getattr__` (available in all supported versions of Python). A `TYPE_CHECKING`-level import is done to ensure that importers see the right type for this class.

a8dc79456c089fe5441107cf894bdf6482adc9bb

Issues

Description	From	Last Updated
Can you add a module docstring while you're touching this?	david	Oct. 9, 2023, 3:41 p.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```
reviewboard/testing/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can you add a module docstring while you're touching this?
```

Change Summary:

Added a module docstring.

Commits:

	Summary	ID
	Lazy-load TestCase to preventing pytest crashes. In Review Board 6, the pytest fixtures were moved into `reviewboard.testing.pytest_fixtures`. This caused pytest to have to import `reviewboard.testing` on load. The problem there is that this module forward-imports `reviewboard.testing.testcase.TestCase`, and this module depends on a working Django environment first. That causes a crash for pytest help output or operations that don't require setting up a test environment. We now lazily-import `TestCase` in this module so that we only pull it in when explicitly requested. This is done through a module-level `__getattr__` (available in all supported versions of Python). A `TYPE_CHECKING`-level import is done to ensure that importers see the right type for this class.	73306c9b2ca9e0d630bf2b14210099701a788bbb
	Lazy-load TestCase to preventing pytest crashes. In Review Board 6, the pytest fixtures were moved into `reviewboard.testing.pytest_fixtures`. This caused pytest to have to import `reviewboard.testing` on load. The problem there is that this module forward-imports `reviewboard.testing.testcase.TestCase`, and this module depends on a working Django environment first. That causes a crash for pytest help output or operations that don't require setting up a test environment. We now lazily-import `TestCase` in this module so that we only pull it in when explicitly requested. This is done through a module-level `__getattr__` (available in all supported versions of Python). A `TYPE_CHECKING`-level import is done to ensure that importers see the right type for this class.	a8dc79456c089fe5441107cf894bdf6482adc9bb

Diff:

Revision 2 (+100 -4)

Show changes

reviewboard/testing/__init__.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-6.x (5d91151)