Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix test Client headers for Django 4.2 #1465

Merged
merged 3 commits into from
Sep 18, 2023
Merged

Fix test Client headers for Django 4.2 #1465

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
433a7d8
Fix test Client headers for Django 4.2
kiendang Sep 18, 2023
b4c427b
Lazy import pkg_resources
kiendang Sep 18, 2023
a4b7b40
Remove use of pkg_resources altogether
kiendang Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion graphene_django/utils/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from django.test import Client, TestCase, TransactionTestCase

from graphene_django.settings import graphene_settings
from graphene_django.utils.utils import _DJANGO_VERSION_AT_LEAST_4_2

DEFAULT_GRAPHQL_URL = "/graphql"

Expand Down Expand Up @@ -55,8 +56,14 @@ def graphql_query(
else:
body["variables"] = {"input": input_data}
if headers:
header_params = (
{"headers": headers} if _DJANGO_VERSION_AT_LEAST_4_2 else headers
)
resp = client.post(
graphql_url, json.dumps(body), content_type="application/json", **headers
graphql_url,
json.dumps(body),
content_type="application/json",
**header_params
)
else:
resp = client.post(
Expand Down
15 changes: 15 additions & 0 deletions graphene_django/utils/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,18 @@ def bypass_get_queryset(resolver):
"""
resolver._bypass_get_queryset = True
return resolver


def __django_version():
from pkg_resources import get_distribution
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a warning at the top here https://setuptools.pypa.io/en/latest/pkg_resources.html saying

Use of pkg_resources is deprecated in favor of importlib.resources, importlib.metadata and their backports (importlib_resources, importlib_metadata). Some useful APIs are also provided by packaging (e.g. requirements and version parsing). Users should refrain from new usage of pkg_resources and should work to port to importlib-based solutions.

Instead of parse_version(), it looks like we could use https://packaging.pypa.io/en/stable/version.html (from packaging.version import parse). And for getting the currently-installed django version string, it looks like import django; django.get_version() would work (or alternatively importlib.metadata.version seems to be the substitute for get_distribution("...").parsed_version).

Unsure how important this deprecation warning is, but seems like it may be worthwhile to avoid the new code depending on this, as they suggest.

Another alternative could be something like this (if we want to avoid packaging for instance):

import django

_DJANGO_VERSION_AT_LEAST_4_2 = django.VERSION[0] > 4 or (django.VERSION[0] >= 4 and django.VERSION[1] >= 2)

Copy link
Collaborator Author

@kiendang kiendang Sep 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sjdemartini @superlevure Thanks for the review. I know about pkg_resources being deprecated in favor of importlib... modules. However went for pkg_resources.get_distribution("...").parsed_version here since we need to compare 2 semvers while importlib.metadata.version only returns the version string, unparsed.

django.VERSION looks like exactly what we need which I was not aware of. Will convert to that. Thanks for pointing that out!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The usage of pkg_resources is deprecated: https://setuptools.pypa.io/en/latest/pkg_resources.html

How about using:

from django import VERSION
print(VERSION)
# (4, 1, 11, 'final', 0)

instead?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like @sjdemartini beat me to it


return get_distribution("django").parsed_version


def __parse_version(v):
from pkg_resources import parse_version

return parse_version(v)


_DJANGO_VERSION_AT_LEAST_4_2 = __django_version() >= __parse_version("4.2")