trustpoint.views.base

Contains some global views that are not specific to a single app.

This module contains some general redirect and error views (e.g. 404) as well as specific mixins and view classes which can be used within the apps.

Module Contents

class trustpoint.views.base.IndexView(**kwargs)

Bases: django.views.generic.base.RedirectView

View that redirects to the index home page.

permanent: bool = False

pattern_name: str = 'home:dashboard'

class trustpoint.views.base.ListInDetailView

Bases: django.views.generic.list.ListView[Any]

Helper view that combines a DetailView and a ListView.

This is useful for displaying a list within a DetailView. Note that ‘model’ and ‘context_object_name’ refer to the ListView. Use ‘detail_model’ and ‘detail_context_object_name’ for the DetailView.

detail_context_object_name = 'object'

detail_model: type[django.db.models.Model]

get(*args, **kwargs)

Handle GET requests.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

get_queryset_for_object()

Get the queryset for the detail object.

Return type:

django.db.models.QuerySet[Any, Any]

get_object()

Get the detail object from the URL pk parameter.

Return type:

django.db.models.Model

get_context_data(**kwargs)

Add the detail object to the context.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.SupportsGetContextData

Bases: Protocol

For typing to provide super().get_context_data().

get_context_data(**kwargs)

Get the context data.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.ParentSupportsGetContextData

Bases: SupportsGetContextData, Protocol

For typing to provide super().get_context_data().

class trustpoint.views.base.SortableTableMixin

Adds utility for sorting a ListView query by URL parameters.

default_sort_param must be set in the view to specify default sorting order.

default_sort_param: str

request: django.http.HttpRequest

model: type[SortableTableMixin.T]

queryset: django.db.models.QuerySet[Any, Any] | None

get_queryset()

Get the queryset and apply sorting based on URL parameters.

Return type:

django.db.models.QuerySet[Any, Any]

get_context_data(*args, **kwargs)

Add sorting information to the context.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.SortableTableFromListMixin

Adds utility for sorting a ListView query by URL parameters.

default_sort_param must be set in the view to specify default sorting order. Use instead of SortableTableMixin when you have a list of dicts instead of a Django queryset.

default_sort_param: str

request: django.http.HttpRequest

model: type[django.db.models.Model]

queryset: list[dict[str, str]] | None

get_queryset()

Get the queryset and apply sorting based on URL parameters.

Return type:

list[dict[str, str]]

get_context_data(*args, **kwargs)

Add sorting information to the context.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.ContextDataMixin

Mixin to add context data from attributes prefixed with ‘context_’.

get_context_data(**kwargs)

Adds attributes prefixed with context_ to the context_data if it does not exist.

Note

If another succeeding class in the MRO has another get_context_data method, this method will be called after setting the attributes to the context_data.

Example

Lets consider context_page_category. Then the attribute page_category with the value of context_page_category is added to the context_data if page_category does not already exist in the context_data.

Example

The following Mixin will add ‘page_category’: ‘pki’, and ‘page_name’: ‘endpoint_profiles’

to the context data.

class EndpointProfilesExtraContextMixin(ContextDataMixin):

“””Mixin which adds context_data for the PKI -> Endpoint Profiles pages.”””

context_page_category = ‘pki’ context_page_name = ‘endpoint_profiles’

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.BaseBulkDeleteView

Bases: django.views.generic.edit.FormMixin[django.forms.Form], django.views.generic.list.BaseListView[Any]

Base view for bulk deletion of objects.

queryset: Any

get_queryset: collections.abc.Callable[Ellipsis, django.db.models.QuerySet[Any, Any]]

success_url: str | django_stubs_ext.StrPromise | None = None

form_class

post(*_args, **_kwargs)

Handles POST requests to the BulkDeleteView.

Parameters:

• _args (tuple[Any])

• _kwargs (dict[str, Any])

Return type:

django.http.HttpResponse

form_valid(_form)

Delete the selected objects on valid form.

Parameters:

_form (django.forms.Form)

Return type:

django.http.HttpResponse

get_success_url()

Returns the URL to redirect to after a successful deletion.

Return type:

str

class trustpoint.views.base.PrimaryKeyListFromPrimaryKeyString

Utility class to parse primary keys from a URL string.

static get_pks_as_list(pks)

Parse a slash-separated list of primary keys from a URL string.

Parameters:

pks (str)

Return type:

list[str]

class trustpoint.views.base.PrimaryKeyQuerysetFromUrlMixin

Bases: PrimaryKeyListFromPrimaryKeyString

Mixin to retrieve a queryset based on primary keys provided in the URL.

kwargs: dict[str, Any]

model: type[django.db.models.Model]

queryset: django.db.models.QuerySet[Any, Any] | None

get_pks_path()

Retrieve the primary key path from the URL parameters.

Return type:

str

get_queryset()

Retrieve a queryset based on primary keys provided in the URL.

Return type:

django.db.models.QuerySet[Any, Any]

class trustpoint.views.base.BulkDeleteView

Bases: django.views.generic.list.MultipleObjectTemplateResponseMixin, PrimaryKeyQuerysetFromUrlMixin, BaseBulkDeleteView

View for bulk deletion of objects.

model: type[django.db.models.Model]

get_queryset()

Return queryset for bulk delete. If no pks provided, return empty queryset.

Return type:

django.db.models.QuerySet[Any, Any]

trustpoint.views.base.THRESHOLD_LOGGER_HTTP_STATUS: int = 400

class trustpoint.views.base.LoggedHttpResponse(content=b'', status=None, *args, **kwargs)

Bases: django.http.HttpResponse, trustpoint.logger.LoggerMixin

Custom HttpResponse that logs and prints error messages automatically.

Parameters:

• content (str | bytes)

• status (int | None)

• args (Any)

• kwargs (Any)