Summary

Update djblets.extensions to drop usage of pkg_resources.

Review Request #13100 — Created June 6, 2023 and submitted July 14, 2023, 4:26 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

pkg_resources has long been deprecated, but until recently has
remained consistent in behavior. The replacements can be found in
importlib.resources, importlib.metadata, and packaging modules.

Over time, pkg_resources began to wrap newer versions of some of these
modules, breaking backwards-compatibility. While not ideal, it's
incentive to move toward the modern packaging support in Python.

This change updates djblets.extensions to (almost) fully move to these
new packages. In some cases, the updates are fairly straight-forward,
but in others there's some rewriting that needs to take place:

Version parsing is now strict, so we need to better bullet-proof
against parsing issues.
Metadata is now handled by importlib.metadata, allowing us to remove
a bunch of old code.
The old extension package installation code had to be wired off. This
was never truly supported, couldn't install wheels, and had a big
scary warning in the docs, so we're not going through a deprecation
cycle for this.

The packaging support still uses pkg_resources, as that's what
setuptools.Command uses. This will need to be converted in time.

There may be some fallout from this change, as there may be behavioral
differences in results/error handling in some cases. If any issues come
up from this change, we'll need to identify the differences and
proactively address them.

Testing Done

Djblets and Review Board unit tests pass. Tested on Python 3.7 and 3.12
with the latest versions of packaging, importlib_metadata, and
importlib_resources packages.

Tested Review Board with loading and using extensions (integrations,
Review Bot, and Power Pack).

Commits

Summary	ID
Update djblets.extensions to drop usage of pkg_resources. `pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.	ba9da8c7ffb2159849263287abdf49d2f405d947

Summary

Update djblets.extensions to drop usage of pkg_resources.

`pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.

ba9da8c7ffb2159849263287abdf49d2f405d947

Issues

Description	From	Last Updated
Is this really something we want to do for 3.x?	david	July 13, 2023, 5:36 p.m.
'typing.Dict' imported but unused Column: 1 Error code: F401	reviewbot	June 6, 2023, 3:51 a.m.
line too long (80 > 79 characters) Column: 80 Error code: E501	reviewbot	June 6, 2023, 3:51 a.m.
'importlib_resources' imported but unused Column: 1 Error code: F401	reviewbot	June 6, 2023, 3:51 a.m.
'pathlib.PosixPath' imported but unused Column: 1 Error code: F401	reviewbot	June 6, 2023, 3:52 a.m.
'importlib_resources' imported but unused Column: 1 Error code: F401	reviewbot	June 6, 2023, 3:54 a.m.

flake8 failed.

JSHint passed.

flake8

djblets/extensions/extension.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Dict' imported but unused

Column: 1
Error code: F401
```
djblets/extensions/extension.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (80 > 79 characters)

Column: 80
Error code: E501
```
djblets/extensions/manager.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'importlib_resources' imported but unused

Column: 1
Error code: F401
```
djblets/extensions/staticfiles.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'pathlib.PosixPath' imported but unused

Column: 1
Error code: F401
```
djblets/extensions/staticfiles.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'importlib_resources' imported but unused

Column: 1
Error code: F401
```

Change Summary:


Removed unused imports.
Added a missing typing import.
Fixed a line length issue.

Commits:

	Summary	ID
	Update djblets.extensions to drop usage of pkg_resources. `pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.	0388f464fcc073b21de7ce107bab1548a5563715
	Update djblets.extensions to drop usage of pkg_resources. `pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.	faa604c9b0b1c6adbb75598030594d5043e0a630

Diff:

Revision 2 (+728 -316)

Show changes

	djblets/dependencies.py
	djblets/extensions/extension.py
	djblets/extensions/loaders.py
	djblets/extensions/manager.py
	djblets/extensions/packaging.py
	djblets/extensions/staticfiles.py
	djblets/extensions/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Is this really something we want to do for 3.x?

chipx86 June 6, 2023, 9:05 p.m.

No, I really don't. I had hit regressions due to modern pkg_resources pulling in modern packaging and importlib stuff, but perhaps I can work around those in a less invasive way for now.
pkg_resources is strongly marked as deprecated, throwing warnings on access, so I'm a little concerned about whether these versions will be able to be installed long-term (and I don't want to have to cap setuptools, as packages probably shouldn't be capping package installation code), but maybe that's just a problem for later.

Change Summary:

Updated for Djblets 4.

Commits:

	Summary	ID
	Update djblets.extensions to drop usage of pkg_resources. `pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.	faa604c9b0b1c6adbb75598030594d5043e0a630
	Update djblets.extensions to drop usage of pkg_resources. `pkg_resources` has long been deprecated, but until recently has remained consistent in behavior. The replacements can be found in `importlib.resources`, `importlib.metadata`, and `packaging` modules. Over time, `pkg_resources` began to wrap newer versions of some of these modules, breaking backwards-compatibility. While not ideal, it's incentive to move toward the modern packaging support in Python. This change updates `djblets.extensions` to (almost) fully move to these new packages. In some cases, the updates are fairly straight-forward, but in others there's some rewriting that needs to take place: * Version parsing is now strict, so we need to better bullet-proof against parsing issues. * Metadata is now handled by `importlib.metadata`, allowing us to remove a bunch of old code. * The old extension package installation code had to be wired off. This was never truly supported, couldn't install wheels, and had a big scary warning in the docs, so we're not going through a deprecation cycle for this. The packaging support still uses `pkg_resources`, as that's what `setuptools.Command` uses. This will need to be converted in time. There may be some fallout from this change, as there may be behavioral differences in results/error handling in some cases. If any issues come up from this change, we'll need to identify the differences and proactively address them.	ba9da8c7ffb2159849263287abdf49d2f405d947

Branch:

-	release-3.x
+	release-4.x

Diff:

Revision 3 (+728 -318)

Show changes

	djblets/dependencies.py
	djblets/extensions/extension.py
	djblets/extensions/loaders.py
	djblets/extensions/manager.py
	djblets/extensions/packaging.py
	djblets/extensions/staticfiles.py
	djblets/extensions/testing/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-4.x (6472c13)