Summary

Add and use a pyproject-compatible build backend for extensions.

Review Request #14140 — Created Sept. 4, 2024 and submitted Nov. 12, 2024, 3:34 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

We now support building extensions entirely based on a pyproject.toml.
This will be the standard going forward, and will require the following
configuration:

[build-system]
requires = [
    'reviewboard~=<version>',
    'reviewboard[extension-packaging]',
]
build-backend = 'reviewboard.extensions.packaging.backend'

If there's an existing setup.py, then things will continue to work
as-is. If one doesn't exist, it will be generated during the lifecycle
of the build, calling into our own setup() method. This is the same
process that setuptools itself uses when building packages, since it
still uses its own machinery under the hood.

rbext create will now generate this file automatically, and no longer
generates setup.py.

The documentation has been updated to reference pyproject.toml and
show examples, replacing all old setup.py references, old references
to eggs, and old command line examples, in an effort to help modernize
some of this.

Testing Done

Generated new extensions and built them without issue.

Added a bare-bones pyproject.toml to an existing package, specifying
the new build backend, and verified it built.

Built the docs and went over the changes, making sure they didn't appear
broken.

Commits

Summary	ID
Add and use a pyproject-compatible build backend for extensions. We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.	c07213a454995960b2fe3c9194db2bf9d0b3673b

Summary

Add and use a pyproject-compatible build backend for extensions.

We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.

c07213a454995960b2fe3c9194db2bf9d0b3673b

Issues

Description	From	Last Updated
We should give a short comment to describe why this is necessary. Would this ever need to change depending on …	maubin	Nov. 12, 2024, 3:34 a.m.
Old typo here: "Once this is Python package is installed..."	maubin	Nov. 12, 2024, 3:34 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	Sept. 4, 2024, 2:23 a.m.
This one wasn't added in 7.1.	maubin	Nov. 12, 2024, 3:34 a.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	Nov. 3, 2024, 9:01 p.m.
module level import not at top of file Column: 1 Error code: E402	reviewbot	Nov. 3, 2024, 9:12 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/cmdline/rbext.py (Diff revision 1)
The issue has been dropped. Show all issues
```
module level import not at top of file

Column: 1
Error code: E402
```

Ship it!

```
Ship It!
```

docs/manual/extending/extensions/distribution.rst (Diff revision 1)

The issue has been resolved. Show all issues

We should give a short comment to describe why this is necessary. Would this ever need to change depending on the extension?

docs/manual/extending/legacy-auth-backends.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Old typo here: "Once this is Python package is installed..."
```
reviewboard/cmdline/rbext.py (Diff revision 1)
The issue has been resolved. Show all issues
```
This one wasn't added in 7.1.
```

Change Summary:


Added guidance comments in the pyproject.toml example.
Fixed some typos and wording for legacy backends.
Removed a Version Added: 7.1 for an existing argument.

Commits:

	Summary	ID
	Add and use a pyproject-compatible build backend for extensions. We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.	aaaf5c6486c5c4e8ef18c99f2afb45e443527a59
	Add and use a pyproject-compatible build backend for extensions. We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.	1101a6d850c3c49df6a820a94a8ac0b85cee5664

Diff:

Revision 2 (+820 -332)

Show changes

	setup.py
	docs/manual/admin/integrations/circle-ci.rst
	docs/manual/extending/auth-backends.rst
	docs/manual/extending/legacy-auth-backends.rst
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/distribution.rst
	docs/manual/extending/extensions/file-layout.rst
	docs/manual/extending/extensions/rbext.rst
	2 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/cmdline/rbext.py (Diff revision 2)
The issue has been dropped. Show all issues
```
module level import not at top of file

Column: 1
Error code: E402
```

Change Summary:

Removed the now-unused function for generating setup.py.

Commits:

	Summary	ID
	Add and use a pyproject-compatible build backend for extensions. We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.	1101a6d850c3c49df6a820a94a8ac0b85cee5664
	Add and use a pyproject-compatible build backend for extensions. We now support building extensions entirely based on a `pyproject.toml`. This will be the standard going forward, and will require the following configuration: [build-system] requires = [ 'reviewboard~=<version>`, 'reviewboard[extension-packaging]', ] build-backend = 'reviewboard.extensions.packaging.backend' If there's an existing `setup.py`, then things will continue to work as-is. If one doesn't exist, it will be generated during the lifecycle of the build, calling into our own `setup()` method. This is the same process that setuptools itself uses when building packages, since it still uses its own machinery under the hood. `rbext create` will now generate this file automatically, and no longer generates `setup.py`. The documentation has been updated to reference `pyproject.toml` and show examples, replacing all old `setup.py` references, old references to eggs, and old command line examples, in an effort to help modernize some of this.	c07213a454995960b2fe3c9194db2bf9d0b3673b

Diff:

Revision 3 (+816 -478)

Show changes

	setup.py
	docs/manual/admin/integrations/circle-ci.rst
	docs/manual/extending/auth-backends.rst
	docs/manual/extending/legacy-auth-backends.rst
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/distribution.rst
	docs/manual/extending/extensions/file-layout.rst
	docs/manual/extending/extensions/rbext.rst
	2 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/cmdline/rbext.py (Diff revision 3)
The issue has been dropped. Show all issues
```
module level import not at top of file

Column: 1
Error code: E402
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

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