Skip to content

Commit

Permalink
Backport 7406 (#7433)
Browse files Browse the repository at this point in the history
* load_extension_class_names - correct module_name

95015a changed over to using importlib rather than pkg_resources,
unfortunately the object is not exactly the same.

Attempting to start up a celery instance with `django-celery-results`
installed results in an exception during `load_extension_class_names`;

```
During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib/python3.10/site-packages/celery/worker/worker.py", line 203, in start
    self.blueprint.start(self)
  File "/usr/lib/python3.10/site-packages/celery/bootsteps.py", line 112, in start
    self.on_start()
  File "/usr/lib/python3.10/site-packages/celery/apps/worker.py", line 136, in on_start
    self.emit_banner()
  File "/usr/lib/python3.10/site-packages/celery/apps/worker.py", line 170, in emit_banner
    ' \n', self.startup_info(artlines=not use_image))),
  File "/usr/lib/python3.10/site-packages/celery/apps/worker.py", line 232, in startup_info
    results=self.app.backend.as_uri(),
  File "/usr/lib/python3.10/site-packages/celery/app/base.py", line 1252, in backend
    self._local.backend = new_backend = self._get_backend()
  File "/usr/lib/python3.10/site-packages/celery/app/base.py", line 955, in _get_backend
    backend, url = backends.by_url(
  File "/usr/lib/python3.10/site-packages/celery/app/backends.py", line 69, in by_url
    return by_name(backend, loader), url
  File "/usr/lib/python3.10/site-packages/celery/app/backends.py", line 47, in by_name
    aliases.update(load_extension_class_names(extension_namespace))
  File "/usr/lib/python3.10/site-packages/celery/utils/imports.py", line 146, in load_extension_class_names
    yield ep.name, ':'.join([ep.module_name, ep.attrs[0]])
AttributeError: 'EntryPoint' object has no attribute 'module_name'
```

Move over to using the direct value should resolve this issue;

```
>>> from pkg_resources import iter_entry_points
>>> list(iter_entry_points('celery.result_backends'))[0].__dict__
{'name': 'django-cache', 'module_name': 'django_celery_results.backends', 'attrs': ('CacheBackend',), 'extras': (), 'dist': django-celery-results 2.3.0 (/usr/lib/python3.10/site-packages)}
```
vs
```
>>> from importlib.metadata import entry_points
>>> entry_points().get('celery.result_backends')[0]
EntryPoint(name='django-cache', value='django_celery_results.backends:CacheBackend', group='celery.result_backends')
```

* Update changelog.

Co-authored-by: Damian Zaremba <damian@damianzaremba.co.uk>
Co-authored-by: Omer Katz <omer.katz@kcg.tech>
  • Loading branch information
3 people committed Apr 5, 2022
1 parent 272b534 commit 8661e12
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ in the & 5.2.x series, please see :ref:`whatsnew-5.2` for
an overview of what's new in Celery 5.2.


.. _version-5.2.6:

5.2.6
=====

:release-date: 2022-4-04 21:15 P.M UTC+2:00
:release-by: Omer Katz

- load_extension_class_names - correct module_name (#7406).
This fixes a regression caused by #7218.

.. _version-5.2.5:

5.2.5
Expand All @@ -17,6 +28,8 @@ an overview of what's new in Celery 5.2.
:release-date: 2022-4-03 20:42 P.M UTC+2:00
:release-by: Omer Katz

**This release was yanked due to a regression caused by the PR below**

- Use importlib instead of deprecated pkg_resources (#7218).

.. _version-5.2.4:
Expand Down
2 changes: 1 addition & 1 deletion celery/utils/imports.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ def gen_task_name(app, name, module_name):

def load_extension_class_names(namespace):
for ep in entry_points().get(namespace, []):
yield ep.name, ':'.join([ep.module_name, ep.attrs[0]])
yield ep.name, ep.value


def load_extension_classes(namespace):
Expand Down

0 comments on commit 8661e12

Please sign in to comment.