zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-06-11 23:14:49 +02:00
Code Issues Projects Releases Packages Wiki Activity

Linting

Browse source
This commit is contained in:
zandercymatics 2023-12-27 10:53:47 -07:00
parent 65f7122a58
commit e3e9eb8dbb
No known key found for this signature in database
GPG key ID: FF4636ABEC9682B7
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/registrar/views/utility/mixins.py
View file

@ -1,6 +1,5 @@
"""Permissions-related mixin classes."""
from typing import List, Tuple
from django.contrib.auth.mixins import PermissionRequiredMixin
from registrar.models import (
@ -22,7 +21,7 @@ class OrderableFieldsMixin:
"""
custom_sort_name_prefix = "get_sortable_"
orderable_fk_fields = [] # type: ignore
orderable_fk_fields = [] # type: ignore
def __new__(cls, *args, **kwargs):
"""
@ -63,7 +62,8 @@ class OrderableFieldsMixin:
@classmethod
def _create_orderable_field_method(cls, field, sort_field):
"""
This class method is a factory for creating dynamic methods that will be attached to the ModelAdmin subclass.
This class method is a factory for creating dynamic methods that will be attached
to the ModelAdmin subclass.
It is used to customize how fk fields are ordered.
In essence, this function will more or less generate code that looks like this,
@ -90,9 +90,12 @@ class OrderableFieldsMixin:
```
Parameters:
cls: The class that this method is being called on. In the context of this mixin, it would be the ModelAdmin subclass.
field: A string representing the name of the attribute that the dynamic method will fetch from the model instance.
sort_field: A string or list of strings representing the field(s) to sort by (ex: "name" or "creator")
cls: The class that this method is being called on. In the context of this mixin,
it would be the ModelAdmin subclass.
field: A string representing the name of the attribute that
the dynamic method will fetch from the model instance.
sort_field: A string or list of strings representing the
field(s) to sort by (ex: "name" or "creator")
Returns:
method: The dynamically created method.
@ -101,7 +104,8 @@ class OrderableFieldsMixin:
__name__: A string representing the name of the method. This is set to "get_{field}".
admin_order_field: A string or list of strings representing the field(s) that
Django should sort by when the column is clicked in the admin interface.
short_description: A string used as the column header in the admin interface. Will replace underscores with spaces.
short_description: A string used as the column header in the admin interface.
Will replace underscores with spaces.
"""
def method(obj):