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.

Attributes

THRESHOLD_LOGGER_HTTP_STATUS

Classes

IndexView	View that redirects to the index home page.
ListInDetailView	Helper view that combines a DetailView and a ListView.
SupportsGetContextData	For typing to provide super().get_context_data().
ParentSupportsGetContextData	For typing to provide super().get_context_data().
SortableTableMixin	Adds utility for sorting a ListView query by URL parameters.
SortableTableFromListMixin	Adds utility for sorting a ListView query by URL parameters.
ContextDataMixin
BaseBulkDeleteView	Base view for bulk deletion of objects.
PrimaryKeyListFromPrimaryKeyString
PrimaryKeyQuerysetFromUrlMixin
BulkDeleteView	Mixin for responding with a template and list of objects.
LoggedHttpResponse	Custom HttpResponse that logs and prints error messages automatically.

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(**kwargs)

Bases: django.views.generic.list.ListView

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'

get(*args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

get_queryset_for_object()

get_object()

Return type:

django.db.models.odel

get_context_data(**kwargs)

Get the context for this view.

class trustpoint.views.base.SupportsGetContextData

Bases: Protocol

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

get_context_data(**kwargs)

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: SortableTableMixin.T

get_queryset()

Return type:

django.db.models.QuerySet[Any]

get_context_data(*args, **kwargs)

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.

static _sort_list_of_dicts(list_of_dicts, sort_param)

Sorts a list of dictionaries by the given sort parameter.

Parameters:

• list_of_dicts (list[dict]) – List of dictionaries to sort.

• sort_param (str) – The parameter to sort by. Prefix with ‘-’ for descending order.

Returns:

The sorted list of dictionaries.

Return type:

list[dict]

get_queryset()

Return type:

list[dict[str, str]]

get_context_data(*args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

Return type:

dict[str, Any]

class trustpoint.views.base.ContextDataMixin

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

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

Bases: django.views.generic.edit.FormMixin, django.views.generic.list.BaseListView

Base view for bulk deletion of objects.

queryset: Any

get_queryset: collections.abc.Callable

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

success_url = 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 (form_class)

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

static get_pks_as_list(pks)

Parameters:

pks (str)

Return type:

list[str]

class trustpoint.views.base.PrimaryKeyQuerysetFromUrlMixin

Bases: PrimaryKeyListFromPrimaryKeyString

get_pks_path()

Return type:

str

get_queryset()

Return type:

None | django.db.models.QuerySet

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

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

Mixin for responding with a template and list of objects.

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)