Incompatibility with latest DRF 3.12.0 #641

fasih · 2020-09-28T10:49:59Z

Encode has just released the new version of DRF django-rest-framework 3.12.0 which has dropped all compat support to Django < 2 urls

Affected import in dry-yasg

from rest_framework.compat import URLPattern, URLResolver, get_original_route

DRF merged PR
DRF Commit

The text was updated successfully, but these errors were encountered:

rozacek · 2020-09-28T10:58:00Z

Hi,
Here in compat.py file there are removed lines highlighted: encode/django-rest-framework@3.11.1...3.12.0

I also noticed this problem about 1 hour ago as 3.12.0 DRF was released. Currently I had to use fixed requirement of DRF 3.11.1

Let me add some logs to make better search engine inexing ;)

Traceback (most recent call last):
  File "/usr/local/lib/python3.8/threading.py", line 932, in _bootstrap_inner
    self.run()
  File "/usr/local/lib/python3.8/threading.py", line 870, in run
    self._target(*self._args, **self._kwargs)
  File "/usr/local/lib/python3.8/site-packages/django/utils/autoreload.py", line 53, in wrapper
    fn(*args, **kwargs)
  File "/usr/local/lib/python3.8/site-packages/django/core/management/commands/runserver.py", line 118, in inner_run
    self.check(display_num_errors=True)
  File "/usr/local/lib/python3.8/site-packages/django/core/management/base.py", line 392, in check
    all_issues = checks.run_checks(
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/registry.py", line 70, in run_checks
    new_errors = check(app_configs=app_configs, databases=databases)
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/urls.py", line 13, in check_url_config
    return check_resolver(resolver)
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/urls.py", line 23, in check_resolver
    return check_method()
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 408, in check
    for pattern in self.url_patterns:
  File "/usr/local/lib/python3.8/site-packages/django/utils/functional.py", line 48, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 589, in url_patterns
    patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
  File "/usr/local/lib/python3.8/site-packages/django/utils/functional.py", line 48, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 582, in urlconf_module
    return import_module(self.urlconf_name)
  File "/usr/local/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/usr/src/app/main/urls.py", line 36, in <module>
    SchemaView = get_schema_view(
  File "/usr/local/lib/python3.8/site-packages/drf_yasg/views.py", line 67, in get_schema_view
    _generator_class = generator_class or swagger_settings.DEFAULT_GENERATOR_CLASS
  File "/usr/local/lib/python3.8/site-packages/drf_yasg/app_settings.py", line 122, in __getattr__
    val = perform_import(val, attr)
  File "/usr/local/lib/python3.8/site-packages/rest_framework/settings.py", line 166, in perform_import
    return import_from_string(val, setting_name)
  File "/usr/local/lib/python3.8/site-packages/rest_framework/settings.py", line 180, in import_from_string
    raise ImportError(msg)
ImportError: Could not import 'drf_yasg.generators.OpenAPISchemaGenerator' for API setting 'DEFAULT_GENERATOR_CLASS'. ImportError: cannot import name 'URLPattern' from 'rest_framework.compat' (/usr/local/lib/python3.8/site-packages/rest_framework/compat.py).

JoelLefkowitz · 2020-09-28T11:20:10Z

Patched with #642

fasih · 2020-09-28T15:29:50Z

I think we should also drop support of Django < 2.1
Raised PR #644

al-muammar · 2020-09-29T06:37:36Z

@axnsan12, could we get your attention here?
Also, the build is failing because of unrelated issues, should we raise an issue to resolve it?

See axnsan12/drf-yasg#641

JackAtOmenApps · 2020-10-04T01:49:36Z

Having same issue here after updating to 3.12.1, (running with django 3.1.2 on Ubuntu).

Traceback (most recent call last):
  File "manage.py", line 31, in <module>
    execute_from_command_line(sys.argv)
  File "/usr/local/lib/python3.8/site-packages/django/core/management/__init__.py", line 401, in execute_from_command_line
    utility.execute()
  File "/usr/local/lib/python3.8/site-packages/django/core/management/__init__.py", line 395, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/usr/local/lib/python3.8/site-packages/django_extensions/management/commands/shell_plus.py", line 120, in run_from_argv
    return super().run_from_argv(argv)
  File "/usr/local/lib/python3.8/site-packages/django/core/management/base.py", line 330, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/usr/local/lib/python3.8/site-packages/django/core/management/base.py", line 368, in execute
    self.check()
  File "/usr/local/lib/python3.8/site-packages/django/core/management/base.py", line 392, in check
    all_issues = checks.run_checks(
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/registry.py", line 70, in run_checks
    new_errors = check(app_configs=app_configs, databases=databases)
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/urls.py", line 13, in check_url_config
    return check_resolver(resolver)
  File "/usr/local/lib/python3.8/site-packages/django/core/checks/urls.py", line 23, in check_resolver
    return check_method()
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 408, in check
    for pattern in self.url_patterns:
  File "/usr/local/lib/python3.8/site-packages/django/utils/functional.py", line 48, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 589, in url_patterns
    patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
  File "/usr/local/lib/python3.8/site-packages/django/utils/functional.py", line 48, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/usr/local/lib/python3.8/site-packages/django/urls/resolvers.py", line 582, in urlconf_module
    return import_module(self.urlconf_name)
  File "/usr/local/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/app/config/urls.py", line 21, in <module>
    schema_view = get_schema_view(
  File "/usr/local/lib/python3.8/site-packages/drf_yasg/views.py", line 67, in get_schema_view
    _generator_class = generator_class or swagger_settings.DEFAULT_GENERATOR_CLASS
  File "/usr/local/lib/python3.8/site-packages/drf_yasg/app_settings.py", line 122, in __getattr__
    val = perform_import(val, attr)
  File "/usr/local/lib/python3.8/site-packages/rest_framework/settings.py", line 166, in perform_import
    return import_from_string(val, setting_name)
  File "/usr/local/lib/python3.8/site-packages/rest_framework/settings.py", line 180, in import_from_string
    raise ImportError(msg)
ImportError: Could not import 'drf_yasg.generators.OpenAPISchemaGenerator' for API setting 'DEFAULT_GENERATOR_CLASS'. ImportError: cannot import name 'URLPattern' from 'rest_framework.compat' (/usr/local/lib/python3.8/site-packages/rest_framework/compat.py).

pablobuenaposada · 2020-10-05T12:26:23Z

same here @OmenApps

gonzalejandro · 2020-10-05T14:40:08Z

same problem than @OmenApps

niviacampos · 2020-10-05T23:50:36Z

same problem than @OmenApps

do update on drf, for me decided

johnthagen · 2020-10-06T12:36:17Z

I'm worried this project is no longer maintained given that there has been no activity since February (#590).

The maintainer, @axnsan12, is still slightly active on GitHub (see https://github.com/rabbitmq/rabbitmq-management/issues/836#issue-678646238 dated Aug 13), but there hasn't been any activity on this repo.

Does the project need to be forked?

JoelLefkowitz · 2020-10-06T14:56:58Z

I'm worried this project is no longer maintained given that there has been no activity since February (#590).

The maintainer, @axnsan12, is still slightly active on GitHub (see rabbitmq/rabbitmq-management#836 (comment) dated Aug 13), but there hasn't been any activity on this repo.

Does the project need to be forked?

We can continue on my fork, drf-yasg2. Would someone like to volunteer to fix the test suite and build failures?

johnthagen · 2020-10-06T15:04:37Z

Thanks!

Here are some PR's I triaged that would be good to migrate over:

Update Redoc to 2.0.0-rc36 #625
Fix tox environment to properly test on Django 3.0 #636
Drop all compat support to Django < 2.1 urls #644 (some of this might already be done in your fork)
Drf extra fields base64 integration #445

Typos:

https://github.com/axnsan12/drf-yasg/pulls?q=is%3Apr+is%3Aopen+typo

Perhaps we should comment on the PRs when they've been merged into the fork so that if people need the fix, they know to check out drf-yasq2.

JoelLefkowitz · 2020-10-06T15:37:24Z

@johnthagen Issues now enabled

AlekseiKhatkevich · 2020-10-06T16:48:29Z

Hi.
Is it any chance you are gonna release a patched version on this issue?
Thanks and thanks for the package, its awesome!

GitRon · 2020-10-07T08:54:16Z

Same problem here. Sad to see this package dying...

JoelLefkowitz · 2020-10-07T11:23:19Z

Same problem here. Sad to see this package dying...

Since the maintainers of this repo are not replying, we've moved to my fork drf-yasg2

creyD · 2020-10-08T12:11:40Z

I wrote an email to the owner of this repository stating the problems, I hope he has a solution.

JoelLefkowitz · 2020-10-12T09:44:25Z

Please note a compatible and stable version of this package is now available on pypi; drf-yasg2

See [thread](axnsan12/drf-yasg#641)

captbilard · 2020-10-12T22:04:13Z

Uninstalling drf-yasg & then installing drf_yasg2 fixed this for me

PaulWay · 2020-10-12T23:36:48Z

Probably means I should move some of my patches over to drf_yasg2.

The libary we use currently for this `drf-yasg` appears to be no longer maintained and we are experiencing an error, having upgraded to a newer version of `djangorestframework`, see: axnsan12/drf-yasg#641 I also had to update to the latest version of `pytest` as I consistently got an error installing dependencies. IssueID #35

The previously referenced django-heluser branch was merged to the master branch and we pin the latest commit in master branch as time of writing. We need to pin specific versions of djangoresetframework and ipython because: - drf-yasg is not compatible with DRF 3.12+, see details: axnsan12/drf-yasg#641 - ipython 7.17+ requires python 3.7+ (we need to support Python 3.6) Refs: LIIK-197

fasih · 2020-10-25T04:52:00Z

Since the maintainers of this repo are not replying, we've moved to my fork drf-yasg2

@JoelLefkowitz I was thinking to update the description of the issue, to move to drf-yasg2
and close the same. What you say?

Even I have been already moved to drf-yasg2. Thanks to you

johnthagen · 2020-10-25T13:56:36Z

I was thinking to update the description of the issue, to move to drf-yasg2 and close the same.

@fasih I went ahead and created a new issue with a clear title about the fork. I think it's good to keep this issue open to document the clear DRF 3.12 problem for current users of drf-yasg to reference.

axnsan12 · 2020-10-25T22:21:15Z

1.20.0 is now out with the fix. I think we can consider this closed.

rozacek mentioned this issue Sep 28, 2020

Changes in compat.py in DRF 3.12.0 causes error in drf-yasg library. encode/django-rest-framework#7555

Closed

BeryJu added a commit to goauthentik/authentik that referenced this issue Sep 30, 2020

root: lock rest-framework to 3.11.1 to prevent drf-yasg

e956b86

See axnsan12/drf-yasg#641

iflare3g mentioned this issue Oct 1, 2020

Attempt patch compatibility with DRF 3.12.x #648

Closed

nokome mentioned this issue Oct 4, 2020

fix(deps): update dependency djangorestframework to v3.12.1 stencila/hub#734

Merged

1 task

nishantwrp mentioned this issue Oct 5, 2020

Upgrade to the latest version of drf_yasg COPS-IITBHU/hackalog-backend#2

Closed

valentijnscholten mentioned this issue Oct 6, 2020

build(deps): bump djangorestframework from 3.11.1 to 3.12.1 DefectDojo/django-DefectDojo#2925

Closed

This was referenced Oct 6, 2020

ImportError: cannot import name 'URLPattern' from 'rest_framework.compat' #649

Closed

Is this project dead? #590

Closed

johnthagen mentioned this issue Oct 6, 2020

Incompatibility with djangorestframework 3.12.0 #640

Closed

This comment has been minimized.

Sign in to view

terencehonles mentioned this issue Oct 8, 2020

inline deleted rest_framework.compat dependencies #652

Closed

TmLev mentioned this issue Oct 9, 2020

drf-yasg incompatible with drf 3.12+ hse-mtc/dal#50

Closed

mraarif mentioned this issue Oct 12, 2020

BOM-1983 : Post Python 3.8 changes openedx-unsupported/registrar#344

Merged

zachmullen added a commit to kitware-resonant/cookiecutter-resonant that referenced this issue Oct 12, 2020

Use drf-yasg2 and unpin DRF

1bc79a8

See [thread](axnsan12/drf-yasg#641)

zachmullen mentioned this issue Oct 12, 2020

Use drf-yasg2 and unpin DRF kitware-resonant/cookiecutter-resonant#71

Merged

zachmullen added a commit to kitware-resonant/cookiecutter-resonant that referenced this issue Oct 12, 2020

Use drf-yasg2 and unpin DRF

7fe8cd9

See [thread](axnsan12/drf-yasg#641)

johnthagen mentioned this issue Oct 13, 2020

drf_yasg incompatible with django_rest_framework 3.10 #411

Closed

ad-m mentioned this issue Oct 13, 2020

Migrate to drf-yasg2 watchdogpolska/small_eod#660

Merged

krashish8 mentioned this issue Oct 14, 2020

Migrate to drf-yasg2 IIT-BHU-InstiApp/lite-hai-backend#59

Closed

evadeflow mentioned this issue Oct 14, 2020

Ch9 drf_yasg incompatibility with Django 3.12.0 wsvincent/djangoforapis#36

Closed

johnthagen mentioned this issue Oct 19, 2020

Add drf-yasg2 reference encode/django-rest-framework#7602

Closed

marksmall mentioned this issue Oct 22, 2020

migrate drf/swagger generator astrosat/django-astrosat-core#35

Closed

marksmall mentioned this issue Oct 22, 2020

fix(backend): Switch to supported version of drf/swagger generator astrosat/django-astrosat-core#36

Merged

mingfeng mentioned this issue Oct 23, 2020

Update plan model City-of-Helsinki/city-infrastructure-platform#156

Merged

johnthagen mentioned this issue Oct 25, 2020

NOTICE: Consider using drf-yasg2 as an active fork of this project #662

Closed

axnsan12 closed this as completed Oct 25, 2020

marksmall mentioned this issue Oct 28, 2020

migrate drf/swagger generator astrosat/django-astrosat-users#121

Closed

chrismaille mentioned this issue Sep 23, 2022

ImportError: Module "drf_yasg.generators" does not define a "OpenAPISchemaGenerator" attribute/class after upgrading DRF==3.14.0 #813

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Incompatibility with latest DRF 3.12.0 #641

Incompatibility with latest DRF 3.12.0 #641

fasih commented Sep 28, 2020 •

edited

Loading

rozacek commented Sep 28, 2020

JoelLefkowitz commented Sep 28, 2020

fasih commented Sep 28, 2020

al-muammar commented Sep 29, 2020

JackAtOmenApps commented Oct 4, 2020

pablobuenaposada commented Oct 5, 2020

gonzalejandro commented Oct 5, 2020

niviacampos commented Oct 5, 2020

johnthagen commented Oct 6, 2020 •

edited

Loading

JoelLefkowitz commented Oct 6, 2020

johnthagen commented Oct 6, 2020 •

edited

Loading

This comment has been minimized.

JoelLefkowitz commented Oct 6, 2020

AlekseiKhatkevich commented Oct 6, 2020

GitRon commented Oct 7, 2020

JoelLefkowitz commented Oct 7, 2020

creyD commented Oct 8, 2020 •

edited

Loading

JoelLefkowitz commented Oct 12, 2020 •

edited

Loading

captbilard commented Oct 12, 2020

PaulWay commented Oct 12, 2020

fasih commented Oct 25, 2020

johnthagen commented Oct 25, 2020

axnsan12 commented Oct 25, 2020

Incompatibility with latest DRF 3.12.0 #641

Incompatibility with latest DRF 3.12.0 #641

Comments

fasih commented Sep 28, 2020 • edited Loading

rozacek commented Sep 28, 2020

JoelLefkowitz commented Sep 28, 2020

fasih commented Sep 28, 2020

al-muammar commented Sep 29, 2020

JackAtOmenApps commented Oct 4, 2020

pablobuenaposada commented Oct 5, 2020

gonzalejandro commented Oct 5, 2020

niviacampos commented Oct 5, 2020

johnthagen commented Oct 6, 2020 • edited Loading

JoelLefkowitz commented Oct 6, 2020

johnthagen commented Oct 6, 2020 • edited Loading

This comment has been minimized.

JoelLefkowitz commented Oct 6, 2020

AlekseiKhatkevich commented Oct 6, 2020

GitRon commented Oct 7, 2020

JoelLefkowitz commented Oct 7, 2020

creyD commented Oct 8, 2020 • edited Loading

JoelLefkowitz commented Oct 12, 2020 • edited Loading

captbilard commented Oct 12, 2020

PaulWay commented Oct 12, 2020

fasih commented Oct 25, 2020

johnthagen commented Oct 25, 2020

axnsan12 commented Oct 25, 2020

fasih commented Sep 28, 2020 •

edited

Loading

johnthagen commented Oct 6, 2020 •

edited

Loading

johnthagen commented Oct 6, 2020 •

edited

Loading

creyD commented Oct 8, 2020 •

edited

Loading

JoelLefkowitz commented Oct 12, 2020 •

edited

Loading