Release Notes

Release Notes Context Mixin

class integreat_cms.cms.views.release_notes.release_notes_context_mixin.ReleaseNotesContextMixin

Bases: ContextMixin

This mixin provides the release notes context (see ContextMixin)

__init__() → None

Return type:

None

extra_context = None

get_context_data(**kwargs: Any) → dict[str, Any]

Extend context by release notes

Parameters:

**kwargs (Any) – The supplied keyword arguments

Returns:

The context dictionary

Return type:

dict[str, Any]

get_entries(version: Path | PosixPath) → dict[str, str]

Get all entries of one version

Returns:

The entry dict

Parameters:

version (Path | PosixPath) –

Return type:

dict[str, str]

get_release_notes() → dict[str, dict[str, dict[str, str]]]

Get all release notes

Returns:

The release note dict

Return type:

dict[str, dict[str, dict[str, str]]]

get_versions(year: Path | PosixPath) → dict[str, dict[str, str]]

Get all versions of one year

Returns:

The version dict

Parameters:

year (Path | PosixPath) –

Return type:

dict[str, dict[str, str]]

only_latest_release = False

Whether only the latest release notes should be included

Release Notes View

class integreat_cms.cms.views.release_notes.release_notes_view.ReleaseNotesView

Bases: TemplateView, ReleaseNotesContextMixin

View for retrieving the release notes

__init__() → None

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

Return type:

None

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = None

get(request, *args, **kwargs)

get_context_data(**kwargs: Any) → dict[str, Any]

Extend context by release notes

Parameters:

**kwargs (Any) – The supplied keyword arguments

Returns:

The context dictionary

Return type:

dict[str, Any]

get_entries(version: Path | PosixPath) → dict[str, str]

Get all entries of one version

Returns:

The entry dict

Parameters:

version (Path | PosixPath) –

Return type:

dict[str, str]

get_release_notes() → dict[str, dict[str, dict[str, str]]]

Get all release notes

Returns:

The release note dict

Return type:

dict[str, dict[str, dict[str, str]]]

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

get_versions(year: Path | PosixPath) → dict[str, dict[str, str]]

Get all versions of one year

Returns:

The version dict

Parameters:

year (Path | PosixPath) –

Return type:

dict[str, dict[str, str]]

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

only_latest_release = False

Whether only the latest release notes should be included

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'release_notes/release_notes.html'

The template to render (see TemplateResponseMixin)

view_is_async = False