Summary

Split reviewboard.extensions.packaging into sub-modules.

Review Request #14139 — Created Sept. 3, 2024 and submitted Nov. 12, 2024, 3:33 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

In preparation for new extension packaging work, required for changes
coming in Python's packaging ecosystem, we're now splitting up
reviewboard.extensions.packaging into new setuptools_backend and
static_media modules. This mirrors the type of move we did back in
Djblets 5.

The old imports will continue to work, but with deprecation warnings.

Testing Done

Successfully built extension packages. Saw the deprecation warning
but verified the packages built fine.

Commits

Summary	ID
Split reviewboard.extensions.packaging into sub-modules. In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.	c1227e127ab14eb1aa8a65ffd0591585c589123e

Summary

Split reviewboard.extensions.packaging into sub-modules.

In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.

c1227e127ab14eb1aa8a65ffd0591585c589123e

Issues

Description	From	Last Updated
'typing.Any' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 3, 2024, 8:14 p.m.
'typing.Optional' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 3, 2024, 8:14 p.m.
'from setuptools.build_meta import *' used; unable to detect undefined names Column: 1 Error code: F403	reviewbot	Sept. 3, 2024, 8:14 p.m.
'setuptools.build_meta.*' imported but unused Column: 1 Error code: F401	reviewbot	Sept. 3, 2024, 8:14 p.m.
This module docstring can be more specific. Maybe "Setuptools backend support for building Review Board extensions."?	maubin	Nov. 3, 2024, 1:45 p.m.
This one can also be more specific. How about "A builder for static media files."? (Copied from Djblets)	maubin	Nov. 3, 2024, 1:45 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/extensions/packaging/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Any' imported but unused

Column: 1
Error code: F401
```
reviewboard/extensions/packaging/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Optional' imported but unused

Column: 1
Error code: F401
```
reviewboard/extensions/packaging/setuptools_backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'from setuptools.build_meta import *' used; unable to detect undefined names

Column: 1
Error code: F403
```
reviewboard/extensions/packaging/setuptools_backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'setuptools.build_meta.*' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Split reviewboard.extensions.packaging into sub-modules. In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.	ca118776b411372cd8b4e8c599ee4fafb66325da
	Split reviewboard.extensions.packaging into sub-modules. In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.	eb3030ac0d078d769792b1b00365968436cb3705

Diff:

Revision 2 (+368 -80)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/extensions/packaging/__init__.py
	reviewboard/extensions/packaging/setuptools_backend.py
	reviewboard/extensions/packaging.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/extensions/packaging/setuptools_backend.py (Diff revision 2)

The issue has been resolved. Show all issues

This module docstring can be more specific. Maybe "Setuptools backend support for building Review Board extensions."?

reviewboard/extensions/packaging/static_media.py (Diff revision 2)

The issue has been resolved. Show all issues

This one can also be more specific. How about "A builder for static media files."? (Copied from Djblets)

Change Summary:

Rewrote the module docstrings.

Commits:

	Summary	ID
	Split reviewboard.extensions.packaging into sub-modules. In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.	eb3030ac0d078d769792b1b00365968436cb3705
	Split reviewboard.extensions.packaging into sub-modules. In preparation for new extension packaging work, required for changes coming in Python's packaging ecosystem, we're now splitting up `reviewboard.extensions.packaging` into new `setuptools_backend` and `static_media` modules. This mirrors the type of move we did back in Djblets 5. The old imports will continue to work, but with deprecation warnings.	c1227e127ab14eb1aa8a65ffd0591585c589123e

Diff:

Revision 3 (+366 -80)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/extensions/packaging/__init__.py
	reviewboard/extensions/packaging/setuptools_backend.py
	reviewboard/extensions/packaging.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (a488bc7)