django-esi 6.0.0__tar.gz → 7.0.0b1__tar.gz

{django_esi-6.0.0 → django_esi-7.0.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: django-esi
-Version: 6.0.0
+Version: 7.0.0b1
 Summary: Django app for accessing the EVE Swagger Interface (ESI).
 Author-email: Alliance Auth <adarnof@gmail.com>
 Requires-Python: >=3.8
@@ -8,8 +8,8 @@ Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Framework :: Django :: 4.2
-Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
@@ -20,12 +20,14 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
-Requires-Dist: bravado>=10.6,<11
+License-File: LICENSE
+Requires-Dist: bravado>=10.6,<12
 Requires-Dist: brotli
 Requires-Dist: celery>=4.0.2
-Requires-Dist: django>=4.2,<5.2
+Requires-Dist: django>=4.2,<6
 Requires-Dist: jsonschema<4
 Requires-Dist: python-jose>=3.3
 Requires-Dist: requests>=2.26
@@ -34,7 +36,7 @@ Requires-Dist: tqdm>=4.62.3
 Requires-Dist: myst-parser ; extra == "docs"
 Requires-Dist: sphinx ; extra == "docs"
 Requires-Dist: sphinx-copybutton ; extra == "docs"
-Requires-Dist: sphinx-rtd-theme<3,>=2 ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=3,<4 ; extra == "docs"
 Requires-Dist: sphinx-tabs ; extra == "docs"
 Requires-Dist: sphinxcontrib-django ; extra == "docs"
 Requires-Dist: coverage ; extra == "test"
@@ -47,27 +49,27 @@ Project-URL: Tracker, https://gitlab.com/allianceauth/django-esi/-/issues
 Provides-Extra: docs
 Provides-Extra: test
 
-# django-esi
+# Django-ESI
 
 Django app for easy access to the EVE Swagger Interface (ESI)
 
-[![version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
-[![python](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
-[![django](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
-[![license](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
-[![pipeline-status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
-[![coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
+[![Django Versions](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
+[![License](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
+[![Pipeline Status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
 [![Documentation Status](https://readthedocs.org/projects/django-esi/badge/?version=latest)](https://django-esi.readthedocs.io/en/latest/?badge=latest)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Chat on Discord](https://img.shields.io/discord/399006117012832262.svg)](https://discord.gg/fjnHAmk)
 
 ## Overview
 
-Django-esi is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
+Django-ESI is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
 
-It is build upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
+It is built upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
 
-Django-esi adds the following main functionalities to a Django site:
+Django-ESI adds the following main functionalities to a Django site:
 
 - Dynamically generated client for interacting with public and private ESI endpoints
 - Support for adding EVE SSO to authenticate characters and retrieve tokens
@@ -75,8 +77,8 @@ Django-esi adds the following main functionalities to a Django site:
 
 ## Python Support
 
-Django-esi follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
-<https://docs.djangoproject.com/en/5.0/faq/install/#what-python-version-can-i-use-with-django>
+Django-ESI follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
+<https://docs.djangoproject.com/en/5.2/faq/install/#what-python-version-can-i-use-with-django>
 
 ## History of this app
 
@@ -84,5 +86,5 @@ This app is a fork from [adarnauth-esi](https://gitlab.com/Adarnof/adarnauth-esi
 
 ## Documentation
 
-For all details on how to install and use django-esi please see the [documentation](https://django-esi.readthedocs.io/en/latest/).
+For all details on how to install and use Django-ESI please see the [Documentation](https://django-esi.readthedocs.io/en/latest/).
 

{django_esi-6.0.0 → django_esi-7.0.0b1}/README.md

@@ -1,24 +1,24 @@
-# django-esi
+# Django-ESI
 
 Django app for easy access to the EVE Swagger Interface (ESI)
 
-[![version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
-[![python](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
-[![django](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
-[![license](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
-[![pipeline-status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
-[![coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Version](https://img.shields.io/pypi/v/django-esi)](https://pypi.org/project/django-esi/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/django-esi)](https://pypi.org/project/django-esi/)
+[![Django Versions](https://img.shields.io/pypi/djversions/django-esi)](https://pypi.org/project/django-esi/)
+[![License](https://img.shields.io/badge/license-GPLv3-green)](https://pypi.org/project/django-esi/)
+[![Pipeline Status](https://gitlab.com/allianceauth/django-esi/badges/master/pipeline.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
+[![Coverage](https://gitlab.com/allianceauth/django-esi/badges/master/coverage.svg)](https://gitlab.com/allianceauth/django-esi/pipelines)
 [![Documentation Status](https://readthedocs.org/projects/django-esi/badge/?version=latest)](https://django-esi.readthedocs.io/en/latest/?badge=latest)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 [![Chat on Discord](https://img.shields.io/discord/399006117012832262.svg)](https://discord.gg/fjnHAmk)
 
 ## Overview
 
-Django-esi is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
+Django-ESI is a Django app that provides an interface for easy access to the EVE Swagger Interface (ESI), the official API for the game [EVE Online](https://www.eveonline.com/).
 
-It is build upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
+It is built upon [Bravado](https://github.com/Yelp/bravado) - a python client library for Swagger 2.0 services.
 
-Django-esi adds the following main functionalities to a Django site:
+Django-ESI adds the following main functionalities to a Django site:
 
 - Dynamically generated client for interacting with public and private ESI endpoints
 - Support for adding EVE SSO to authenticate characters and retrieve tokens
@@ -26,8 +26,8 @@ Django-esi adds the following main functionalities to a Django site:
 
 ## Python Support
 
-Django-esi follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
-<https://docs.djangoproject.com/en/5.0/faq/install/#what-python-version-can-i-use-with-django>
+Django-ESI follows the Django Python support schedule, The supported version of Python will differ based on the version of Django used.
+<https://docs.djangoproject.com/en/5.2/faq/install/#what-python-version-can-i-use-with-django>
 
 ## History of this app
 
@@ -35,4 +35,4 @@ This app is a fork from [adarnauth-esi](https://gitlab.com/Adarnof/adarnauth-esi
 
 ## Documentation
 
-For all details on how to install and use django-esi please see the [documentation](https://django-esi.readthedocs.io/en/latest/).
+For all details on how to install and use Django-ESI please see the [Documentation](https://django-esi.readthedocs.io/en/latest/).

django_esi-7.0.0b1/esi/__init__.py

@@ -0,0 +1,5 @@
+"""Django app for accessing the EVE Swagger Interface (ESI)."""
+
+__version__ = '7.0.0b1'
+__title__ = 'Django-ESI'
+__url__ = 'https://gitlab.com/allianceauth/django-esi'

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/admin.py

@@ -23,7 +23,6 @@ class TokenAdmin(admin.ModelAdmin):
     def get_scopes(self, obj):
         return ", ".join([x.name for x in obj.scopes.all()])
 
-
     User = get_user_model()
     list_display = ('user', 'character_name', 'get_scopes')
     search_fields = ['user__%s' % User.USERNAME_FIELD, 'character_name', 'scopes__name']

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/apps.py

@@ -6,6 +6,6 @@ class EsiConfig(AppConfig):
     name = 'esi'
     verbose_name = 'EVE Swagger Interface (SSO v2)'
 
-    def ready(self):
+    def ready(self) -> None:
         super().ready()
         from esi import checks  # noqa

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/checks.py

@@ -4,7 +4,9 @@ from django.conf import settings
 
 @register(Tags.security)
 def check_sso_application_settings(*args, **kwargs):
+
     errors = []
+
     if (
         not hasattr(settings, "ESI_SSO_CLIENT_ID")
         or not hasattr(settings, "ESI_SSO_CLIENT_SECRET")
@@ -30,4 +32,25 @@ def check_sso_application_settings(*args, **kwargs):
                     id='esi.E001'
                 )
             )
+
+    # Check for ESI_USER_CONTACT_EMAIL
+    if hasattr(settings, "ESI_USER_CONTACT_EMAIL"):
+        # Check if ESI_USER_CONTACT_EMAIL is empty
+        if settings.ESI_USER_CONTACT_EMAIL == "":
+            errors.append(
+                Error(
+                    msg="'ESI_USER_CONTACT_EMAIL' is empty. A valid email is required as maintainer contact for CCP.",
+                    hint="",
+                    id="esi.E002",
+                )
+            )
+    # ESI_USER_CONTACT_EMAIL not found
+    else:
+        errors.append(
+            Error(
+                msg="No 'ESI_USER_CONTACT_EMAIL' found is settings. A valid email is required as maintainer contact for CCP.",
+                hint="",
+                id="esi.E003",
+            )
+        )
     return errors

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/clients.py

@@ -5,6 +5,7 @@ import logging
 from time import sleep
 from urllib import parse as urlparse
 from typing import Any, Union, Tuple
+import warnings
 
 from bravado.client import SwaggerClient
 from bravado import requests_client
@@ -20,7 +21,7 @@ from requests.adapters import HTTPAdapter
 from django.core.cache import cache
 
 from .errors import TokenExpiredError
-from . import app_settings, __version__, __title__
+from . import app_settings, __version__, __title__, __url__
 
 
 logger = logging.getLogger(__name__)
@@ -438,13 +439,9 @@ def read_spec(path, http_client=None):
 
 
 def esi_client_factory(
-    token=None,
-    datasource: str = None,
-    spec_file: str = None,
-    version: str = None,
-    app_info_text: str = None,
-    **kwargs
-) -> SwaggerClient:
+        token=None, datasource: str = None, spec_file: str = None, version: str = None,
+        app_info_text: str = None,  # Deprecate in favour of the following variables
+        ua_appname: str = None, ua_version: str = None, ua_url: str = None, **kwargs) -> SwaggerClient:
     """Generate a new ESI client.
 
     Args:
@@ -452,10 +449,9 @@ def esi_client_factory(
         datasource: Name of the ESI datasource to access.
         spec_file: Absolute path to a swagger spec file to load.
         version: Base ESI API version. Accepted values are 'legacy', 'latest',
-        app_info_text: Text identifying the application using ESI which will be \
-            included in the User-Agent header. Should contain name and version of the \
-            application using ESI. e.g. `"my-app v1.0.0"`. \
-            Note that spaces are used as delimiter.
+        ua_appname: Name of the App for generating a User-Agent,
+        ua_version: Version of the App for generating a User-Agent,
+        ua_url: (optional) URL To the Source Code or Documentation for generating a User-Agent,
         kwargs: Explicit resource versions to build, in the form Character='v4'. \
             Same values accepted as version.
 
@@ -466,15 +462,40 @@ def esi_client_factory(
     Returns:
         New ESI client
     """
+
+    if app_info_text is not None:
+        warnings.warn(
+            "The 'app_info_text' parameter is deprecated and will be removed in a future release. "
+            "Use 'ua_appname', 'ua_version', and `ua_url` to dynamically build a User-Agent instead",
+            DeprecationWarning,
+            stacklevel=2
+        )
+
+    if ua_appname is None or ua_version is None:
+        warnings.warn(
+            "Applications must define their own 'ua_appname' and 'ua_version' to generate a User-Agent",
+            DeprecationWarning,
+            stacklevel=2
+        )
+
     if app_settings.ESI_INFO_LOGGING_ENABLED:
         logger.info('Generating an ESI client...')
 
     client = RequestsClientPlus()
-    user_agent = (
-        str(app_info_text) if app_info_text else f"{__title__} v{__version__}"
-    )
-    if app_settings.ESI_USER_CONTACT_EMAIL:
-        user_agent += f" {app_settings.ESI_USER_CONTACT_EMAIL}"
+
+    if app_info_text:
+        # app_info_text (email@example) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi)
+        # Deprecated
+        user_agent = f"{app_info_text} ({app_settings.ESI_USER_CONTACT_EMAIL}) {__title__}/{__version__} (+{__url__})"
+    elif ua_appname is None or ua_version is None:
+        # Django-ESI/1.2.3 () (email@example; +https://gitlab.com/allianceauth/django-esi)
+        # Deprecated
+        user_agent = f"{__title__}/{__version__} ({app_settings.ESI_USER_CONTACT_EMAIL}; +{__url__})"
+    else:
+        # AppName/1.2.3 (email@example.com) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi)
+        # or AppName/1.2.3 (email@example.com; +https://gitlab.com/) Django-ESI/1.2.3 (+https://gitlab.com/allianceauth/django-esi) (+https://gitlab.com/allianceauth/django-esi)
+        # Preferred
+        user_agent = f"{ua_appname}/{ua_version} ({app_settings.ESI_USER_CONTACT_EMAIL}{f'; +{ua_url})' if ua_url else ')'} {__title__}/{__version__} (+{__url__})"
 
     client.user_agent = user_agent
 
@@ -535,10 +556,9 @@ class EsiClientProvider:
         datasource: Name of the ESI datasource to access.
         spec_file: Absolute path to a swagger spec file to load.
         version: Base ESI API version. Accepted values are 'legacy', 'latest',
-        app_info_text: Text identifying the application using ESI which will be \
-            included in the User-Agent header. Should contain name and version of \
-            the application using ESI. e.g. `"my-app v1.0.0"`. \
-            Note that spaces are used as delimiter.
+        ua_appname: Name of the App for generating a User-Agent,
+        ua_version: Version of the App for generating a User-Agent,
+        ua_url: (optional) URL To the Source Code or Documentation for generating a User-Agent,
         kwargs: Explicit resource versions to build, in the form Character='v4'. \
             Same values accepted as version.
 
@@ -550,30 +570,40 @@ class EsiClientProvider:
     _client = None
 
     def __init__(
-        self,
-        datasource=None,
-        spec_file=None,
-        version=None,
-        app_info_text=None,
-        **kwargs
-    ):
+            self, datasource=None, spec_file=None, version=None,
+            app_info_text=None,  # Deprecate in favour of the following variables
+            ua_appname: str = None, ua_version: str = None, ua_url: str = None, **kwargs) -> None:
         self._datasource = datasource
         self._spec_file = spec_file
         self._version = version
-        self._app_text = app_info_text
+        self._app_text = app_info_text  # Deprecate in favour of the following variables
+        self._ua_appname = ua_appname
+        self._ua_version = ua_version
+        self._ua_url = ua_url
         self._kwargs = kwargs
 
+        if app_info_text is not None:
+            warnings.warn(
+                "The 'app_info_text' parameter is deprecated and will be removed in a future release. "
+                "Use 'ua_appname', 'ua_version', and `ua_url` to dynamically build a User-Agent instead",
+                DeprecationWarning,
+                stacklevel=2
+            )
+
     @property
-    def client(self):
+    def client(self) -> SwaggerClient:
         if self._client is None:
             self._client = esi_client_factory(
                 datasource=self._datasource,
                 spec_file=self._spec_file,
                 version=self._version,
-                app_info_text=self._app_text,
+                app_info_text=self._app_text,  # Deprecate in favour of the following variables
+                ua_appname=self._ua_appname,
+                ua_version=self._ua_version,
+                ua_url=self._ua_url,
                 **self._kwargs,
             )
         return self._client
 
-    def __str__(self):
+    def __str__(self) -> str:
         return 'EsiClientProvider'

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/decorators.py

@@ -1,5 +1,6 @@
 import logging
 from functools import wraps
+from typing import Union
 
 from .models import Token, CallbackRedirect
 
@@ -7,7 +8,7 @@ from .models import Token, CallbackRedirect
 logger = logging.getLogger(__name__)
 
 
-def _check_callback(request):
+def _check_callback(request) -> Union[Token, None]:
     # ensure session installed in database
     if not request.session.exists(request.session.session_key):
         logger.debug("Creating new session for %s", request.user)

django_esi-7.0.0b1/esi/migrations/0013_squashed_0012_fix_token_type_choices.py

@@ -0,0 +1,57 @@
+# Generated by Django 4.2 on 2025-04-04 01:28
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+# Squashmigration imported a RunPython, not needed
+# Manually optimized
+
+
+class Migration(migrations.Migration):
+
+    replaces = [('esi', '0001_initial'), ('esi', '0002_scopes_20161208'), ('esi', '0003_hide_tokens_from_admin_site'), ('esi', '0004_remove_unique_access_token'), ('esi', '0005_remove_token_length_limit'), ('esi', '0006_remove_url_length_limit'), ('esi', '0007_fix_mysql_8_migration'), ('esi', '0008_nullable_refresh_token'), ('esi', '0009_set_old_tokens_to_sso_v1'), ('esi', '0010_set_new_tokens_to_sso_v2'), ('esi', '0011_add_token_indices'), ('esi', '0012_fix_token_type_choices')]
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Scope',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(help_text='The official EVE name for the scope.', max_length=100, unique=True)),
+                ('help_text', models.TextField(help_text='The official EVE description of the scope.')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Token',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('access_token', models.TextField(editable=False, help_text='The access token granted by SSO.')),
+                ('refresh_token', models.TextField(editable=False, help_text='A re-usable token to generate new access tokens upon expiry.', null=True)),
+                ('character_id', models.IntegerField(db_index=True, help_text='The ID of the EVE character who authenticated by SSO.')),
+                ('character_name', models.CharField(db_index=True, help_text='The name of the EVE character who authenticated by SSO.', max_length=100)),
+                ('token_type', models.CharField(choices=[('character', 'Character'), ('corporation', 'Corporation')], default='character', help_text='The applicable range of the token.', max_length=100)),
+                ('character_owner_hash', models.CharField(db_index=True, help_text='The unique string identifying this character and its owning EVE account. Changes if the owning account changes.', max_length=254)),
+                ('scopes', models.ManyToManyField(blank=True, help_text='The access scopes granted by this token.', to='esi.scope')),
+                ('user', models.ForeignKey(blank=True, help_text='The user to whom this token belongs.', null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+                ('sso_version', models.IntegerField(default=2, help_text='EVE SSO Version.')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='CallbackRedirect',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('url', models.TextField(default='/', help_text='The internal URL to redirect this callback towards.')),
+                ('session_key', models.CharField(help_text='Session key identifying the session this redirect was created for.', max_length=254, unique=True)),
+                ('state', models.CharField(help_text='OAuth2 state string representing this session.', max_length=128)),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('token', models.ForeignKey(blank=True, help_text='Token generated by a completed code exchange from callback processing.', null=True, on_delete=django.db.models.deletion.CASCADE, to='esi.token')),
+            ],
+        ),
+    ]

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/models.py

@@ -1,6 +1,7 @@
 import datetime
 import re
 import logging
+from typing import ClassVar
 
 from bravado.client import SwaggerClient
 from requests.auth import HTTPBasicAuth
@@ -54,7 +55,7 @@ class Scope(models.Model):
         except IndexError:
             return name
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.name
 
 
@@ -121,16 +122,16 @@ class Token(models.Model):
         default=2
     )
 
-    objects = TokenManager()
+    objects: ClassVar[TokenManager] = TokenManager()
 
-    def __str__(self):
+    def __str__(self) -> str:
         try:
             scopes = sorted(s.name for s in self.scopes.all())
         except ValueError:
             scopes = []
         return f'{self.character_name} - {", ".join(scopes)}'
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<{}(id={}): {}, {}>".format(
             self.__class__.__name__,
             self.pk,
@@ -248,7 +249,7 @@ class Token(models.Model):
             logger.debug("Not a refreshable token.")
             raise NotRefreshableTokenError()
 
-    def refresh_or_delete(self):
+    def refresh_or_delete(self) -> None:
         """Refresh this token or delete it if it can not be refreshed."""
         try:
             self.refresh()
@@ -345,10 +346,10 @@ class CallbackRedirect(models.Model):
         )
     )
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.session_key}: {self.url}"
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "<{}(pk={}): {} to {}>".format(
             self.__class__.__name__, self.pk,
             self.session_key, self.url

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/tasks.py

@@ -1,5 +1,6 @@
 from datetime import timedelta
 import logging
+from math import ceil
 
 from celery import shared_task
 
@@ -26,14 +27,15 @@ def cleanup_callbackredirect(max_age=300):
 
 
 @shared_task
-def cleanup_token():
+def cleanup_token() -> None:
     """
-    Delete expired :model:`esi.Token` models.
+    Delete Orphaned Tokens, then refresh or delete expired :model:`esi.Token` models.
     """
     orphaned_tokens = Token.objects.filter(user__isnull=True)
     if orphaned_tokens.exists():
         logger.info("Deleting %d orphaned tokens.", orphaned_tokens.count())
         orphaned_tokens.delete()
+
     expired_tokens = Token.objects.exclude(user__isnull=True).get_expired()
     if expired_tokens.exists():
         logger.info(
@@ -46,6 +48,31 @@ def cleanup_token():
             refresh_or_delete_token.apply_async(args=[token_pk], priority=8)
 
 
+@shared_task
+def cleanup_token_subset(fraction: int = 48) -> None:
+    """
+    Delete Orphaned Tokens, then refresh or delete a subset of expired :model:`esi.Token` models.
+
+    This task operates on 1/fraction of the oldest tokens and can be called on a more regular schedule
+    """
+    orphaned_tokens = Token.objects.filter(user__isnull=True)
+    if orphaned_tokens.exists():
+        logger.info("Deleting %d orphaned tokens.", orphaned_tokens.count())
+        orphaned_tokens.delete()
+
+    expired_tokens = Token.objects.exclude(user__isnull=True).get_expired()
+    expired_tokens_subset = expired_tokens.filter(
+        refresh_token__isnull=False
+    ).order_by("created")[:ceil(expired_tokens.count() / fraction)]
+
+    if expired_tokens.exists():
+        logger.info(
+            f"Triggering bulk refresh of subset/possible {expired_tokens_subset.count()}/{expired_tokens.count()} expired tokens."
+        )
+        for token_pk in expired_tokens_subset.values_list("pk", flat=True):
+            refresh_or_delete_token.apply_async(args=[token_pk], priority=8)
+
+
 @shared_task
 def refresh_or_delete_token(token_pk: int):
     token = Token.objects.get(pk=token_pk)

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/templates/esi/select_token.html

@@ -10,7 +10,7 @@
         <meta name="description" content="">
         <meta name="author" content="">
 
-        <title>{% trans "ESI Token Selection" %}</title>
+        <title>{% translate "ESI Token Selection" %}</title>
 
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.1/css/bootstrap.min.css" integrity="sha512-T584yQ/tdRR5QwOpfvDfVQUidzfgc2339Lc8uBDtcp/wYu80d7jwBgAxbyMh0a9YM9F8N3tdErpFI8iaGx6x5g==" crossorigin="anonymous" referrerpolicy="no-referrer" />
         <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.slim.min.js" integrity="sha512-6ORWJX/LrnSjBzwefdNUyLCMTIsGoNP6NftMy2UAm1JBm6PRZCO1d7OHBStWpVFZLO+RerTvqX/Z9mBFfCJZ4A==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
@@ -41,11 +41,11 @@
     </head>
     <body class="bg-dark">
         <div class="container-fluid mt-5">
-            <h3 class="text-light font-weight-light text-center">{% trans "Select Character" %}</h3><br>
+            <h3 class="text-light font-weight-light text-center">{% translate "Select Character" %}</h3><br>
             <div class="mt-2">
                 <div class="col-lg-10 offset-lg-1 col-md-12" style="padding-left: 0 !important; padding-right: 0 !important;">
                     <div class="card text-white bg-secondary">
-                        <div class="card-header text-center">{% trans "Scopes Requested" %}</div>
+                        <div class="card-header text-center">{% translate "Scopes Requested" %}</div>
                         <div class="card-body align-middle text-center">
                             {% for scope in scopes %}<span class="badge badge-dark">{{ scope|scope_friendly_name }}</span> {% endfor %}
                         </div>
@@ -58,7 +58,7 @@
                     {% if tokens|length > 14 %}
                         <form method="post">
                             <div class="card text-white bg-secondary m-2 sso-card">
-                                <div class="card-header text-center">{% trans "New Character" %}</div>
+                                <div class="card-header text-center">{% translate "New Character" %}</div>
                                 <div class="card-body text-center  d-none d-sm-block">
                                     <input type="image" formmethod="post" class="ra-avatar img-responsive character-image rounded-lg"
                                         src="https://images.evetech.net/characters/1/portrait?size=256">
@@ -68,7 +68,7 @@
                                         <input type="hidden" name="_add" value="True">
                                         <a href="#" type="submit" class="m-1">
                                             <input type="image" name="go" src="{% static 'esi\img\EVE_SSO_Login_Buttons_Small_Black.png'%}"
-                                                alt="{% trans "Add Token" %}">
+                                                alt="{% translate "Add Token" %}">
                                         </a>
                                 </div>
                             </div>
@@ -85,8 +85,8 @@
                                 </div>
                                 <div class="card-footer">
                                         <input type="hidden" name="_token" value="{{ token.pk }}">
-                                        <button class="btn btn-success w-100" type="submit" title="{% trans "Select" %}" formmethod="post">
-                                            {% trans "Select" %}
+                                        <button class="btn btn-success w-100" type="submit" title="{% translate "Select" %}" formmethod="post">
+                                            {% translate "Select" %}
                                         </button>
                                 </div>
                             </div>
@@ -95,7 +95,7 @@
                     <form method="post">
                         {% csrf_token %}
                         <div class="card text-white bg-secondary m-2 sso-card">
-                            <div class="card-header text-center">{% trans "New Character" %}</div>
+                            <div class="card-header text-center">{% translate "New Character" %}</div>
                             <div class="card-body text-center  d-none d-sm-block">
                                 <input type="image" formmethod="post" class="ra-avatar img-responsive character-image rounded-lg"
                                     src="https://images.evetech.net/characters/1/portrait?size=256">
@@ -104,7 +104,7 @@
                                     <input type="hidden" name="_add" value="True">
                                     <a href="#" type="submit" class="m-1">
                                         <input type="image" name="go" src="{% static 'esi\img\EVE_SSO_Login_Buttons_Small_Black.png'%}"
-                                            alt="{% trans "Add Token" %}">
+                                            alt="{% translate "Add Token" %}">
                                     </a>
                             </div>
                         </div>

{django_esi-6.0.0 → django_esi-7.0.0b1}/esi/tests/factories.py

@@ -43,5 +43,5 @@ class BravadoResponseStub:
         self.headers = headers if headers else dict()
         self.raw_bytes = raw_bytes
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.status_code} {self.reason}"