ferrosoft.apps.emiflow.views package

Submodules

ferrosoft.apps.emiflow.views.file_import module

class ferrosoft.apps.emiflow.views.file_import.FileImportIndex(**kwargs)

Bases: LoginRequiredMixin, PlatformActivityMixin, JobFromTemplateBaseView

activity_title = 'File import'

Activity title should be a very short label e.g. indicating the current model being operated on.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

template_name = 'emiflow/file_import/index.html'

ferrosoft.apps.emiflow.views.index module

class ferrosoft.apps.emiflow.views.index.EmiflowIndexView(**kwargs)

Bases: LoginRequiredMixin, PlatformActivityMixin, TemplateView

activity_title = 'Emiflow'

Activity title should be a very short label e.g. indicating the current model being operated on.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

template_name = 'emiflow/index.html'

ferrosoft.apps.emiflow.views.index.emiflow_stats(request)

ferrosoft.apps.emiflow.views.index.empty(request, *args, **kwargs)

ferrosoft.apps.emiflow.views.intensity module

class ferrosoft.apps.emiflow.views.intensity.EmissionIntensityCreateView(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Intensity'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emissionintensity_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of EmissionIntensityForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'define_emission_intensity'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of EmissionIntensity

permission_required = ['emiflow.add_emissionintensity']

template_name = 'emiflow/emission_intensity/create.html'

class ferrosoft.apps.emiflow.views.intensity.EmissionIntensityUpdateView(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Intensity'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emissionintensity_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:emissionintensity_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:emissionintensity_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of EmissionIntensityForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'define_emission_intensity'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of EmissionIntensity

permission_required = ['emiflow.change_emissionintensity']

plural = 'Emission Intensities'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:emissionintensity_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Emission Intensity'

Singular may be used by templates to display the model name.

template_name = 'emiflow/emission_intensity/update.html'

ferrosoft.apps.emiflow.views.intensity.intensity_create_url(owner_type, owner_id, energy_carrier_id=None, emitter_epitype=None)

Get URL to intensity create form.

Parameters:

• owner_type (IntensityCapableEntity) – Type of entity for which to create the intensity.

• owner_id (UUID) – ID of entity for which to create the intensity.

• energy_carrier_id (UUID | None) – ID of energy carrier with which to constrain emission factors.

Returns: URL of intensity create form.

ferrosoft.apps.emiflow.views.lifecycle module

class ferrosoft.apps.emiflow.views.lifecycle.LCCValueCreate(*args, **kwargs)

Bases: DependentCreateView

abstract = True

activity_title = 'Related Emissions'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

static related_links()

The type of the None singleton.

related_links_default: bool = False

Whether to include a curated set of default related links in the context.

class ferrosoft.apps.emiflow.views.lifecycle.LifecycleCategoryCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

fields = ['name']

help_topic: str | None = 'lifecycle_categories'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of LifecycleCategory

permission_required = ['emiflow.add_lifecyclecategory']

class ferrosoft.apps.emiflow.views.lifecycle.LifecycleCategoryDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_valid(form)

Perform the delete, falling back to the form when on_delete=RESTRICT fires.

get(request, *args, **kwargs)

help_topic: str | None = 'lifecycle_categories'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of LifecycleCategory

permission_required = ['emiflow.delete_lifecyclecategory']

class ferrosoft.apps.emiflow.views.lifecycle.LifecycleCategoryList(**kwargs)

Bases: ListView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_create'

List view displays a button to create a new object if create_view is not None.

help_topic: str | None = 'lifecycle_categories'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of LifecycleCategory

ordering = ['name']

permission_required = ['emiflow.view_lifecyclecategory']

plural = 'Lifecycle Categories'

Plural may be used by templates to display the model name.

singular = 'Lifecycle Category'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.lifecycle.LifecycleCategoryUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_create'

List view displays a button to create a new object if create_view is not None.

delete_view(*args, **kwargs)

The type of the None singleton.

fields = ['name']

help_topic: str | None = 'lifecycle_categories'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of LifecycleCategory

permission_required = ['emiflow.change_lifecyclecategory']

plural = 'Lifecycle Categories'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:lifecyclecategory_index'

Name of read view to link to in related links widget.

singular = 'Lifecycle Category'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.lifecycle.TransportLCCValueCreate(*args, **kwargs)

Bases: LCCValueCreate

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category Value'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportlccvalue_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TransportLCCValueForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_success_url()

Redirect to the parent’s absolute URL after a successful create.

help_topic: str | None = 'transport_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportLCCValue

parent_model

alias of TransportChain

permission_required = ['emiflow.add_transportlccvalue']

class ferrosoft.apps.emiflow.views.lifecycle.TransportLCCValueDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Related Emissions'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'transport_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportLCCValue

permission_required = ['emiflow.delete_transportlccvalue']

class ferrosoft.apps.emiflow.views.lifecycle.TransportLCCValueUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Related Emissions'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:transportlccvalue_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:transportlccvalue_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TransportLCCValueForm

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'transport_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportLCCValue

permission_required = ['emiflow.change_transportlccvalue']

plural = 'Lifecycle Category Values'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:transportlccvalue_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Lifecycle Category Value'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.lifecycle.TreatmentLCCValueCreate(*args, **kwargs)

Bases: LCCValueCreate

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Lifecycle Category Value'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatmentlccvalue_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TreatmentLCCValueForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_success_url()

Redirect to the parent’s absolute URL after a successful create.

help_topic: str | None = 'treatment_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentLCCValue

parent_model

alias of Treatment

permission_required = ['emiflow.add_treatmentlccvalue']

class ferrosoft.apps.emiflow.views.lifecycle.TreatmentLCCValueDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Related Emissions'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'treatment_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentLCCValue

permission_required = ['emiflow.delete_treatmentlccvalue']

class ferrosoft.apps.emiflow.views.lifecycle.TreatmentLCCValueUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Related Emissions'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentlccvalue_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:treatmentlccvalue_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentLCCValueForm

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'treatment_related_emissions'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentLCCValue

permission_required = ['emiflow.change_treatmentlccvalue']

plural = 'Lifecycle Category Values'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentlccvalue_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Lifecycle Category Value'

Singular may be used by templates to display the model name.

ferrosoft.apps.emiflow.views.reporting module

class ferrosoft.apps.emiflow.views.reporting.ReportCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:report_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of ReportForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'new_report'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Report

permission_required = ['emiflow.add_report']

class ferrosoft.apps.emiflow.views.reporting.ReportDelete(*args, **kwargs)

Bases: FeatureRequiredMixin, DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:report_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

feature_required: str | None = 'reporting'

help_topic: str | None = 'reports'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Report

permission_required = ['emiflow.delete_report']

class ferrosoft.apps.emiflow.views.reporting.ReportRead(**kwargs)

Bases: FeatureRequiredMixin, TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:report_create'

List view displays a button to create a new object if create_view is not None.

feature_required: str | None = 'reporting'

filterset_class

alias of ReportFilter

help_topic: str | None = 'reports'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Report

ordering = '-reference'

permission_required = ['emiflow.view_report']

plural = 'Reports'

Plural may be used by templates to display the model name.

singular = 'Report'

Singular may be used by templates to display the model name.

table_class

alias of ReportTable

template_name = 'emiflow/report/index.html'

class ferrosoft.apps.emiflow.views.reporting.ReportSelectionView(*args, **kwargs)

Bases: FeatureRequiredMixin, TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Booking Record'

Activity title should be a very short label e.g. indicating the current model being operated on.

enable_filter_display: bool = False

Whether to display filters off-canvas (applicable to read views).

feature_required: str | None = 'reporting'

filterset_class

alias of EmissionBookingRecordFilter

get(request, *args, **kwargs)

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_filterset(filterset_class)

Returns an instance of the filterset to be used in this view.

get_queryset()

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.

get_report()

Return type:

Report

help_topic: str | None = 'report_selection'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of EmissionBookingRecord

ordering = '-booking_date'

permission_required = ['emiflow.view_emissionbookingrecord']

plural = 'emission booking records'

Plural may be used by templates to display the model name.

post(request, *args, **kwargs)

singular = 'emission booking record'

Singular may be used by templates to display the model name.

table_class

alias of EmissionBookingRecordTable

template_name = 'emiflow/report/selection.html'

class ferrosoft.apps.emiflow.views.reporting.ReportTemplateCreate(**kwargs)

Bases: FeatureRequiredMixin, CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report Template'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

feature_required: str | None = 'report_ci'

form_class

alias of ReportTemplateForm

form_template = 'emiflow/report_template/form.html'

Template to be included instead of generic form display.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'report_templates'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of ReportTemplate

multipart_form = True

Whether to use multipart/form-data enctype.

permission_required = ['emiflow.add_reporttemplate']

template_name = 'emiflow/report_template/create.html'

class ferrosoft.apps.emiflow.views.reporting.ReportTemplateDelete(*args, **kwargs)

Bases: FeatureRequiredMixin, DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report Template'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

feature_required: str | None = 'report_ci'

help_topic: str | None = 'report_templates'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of ReportTemplate

permission_required = ['emiflow.delete_reporttemplate']

class ferrosoft.apps.emiflow.views.reporting.ReportTemplateIndex(**kwargs)

Bases: FeatureRequiredMixin, ListView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report Template'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_create'

List view displays a button to create a new object if create_view is not None.

feature_required: str | None = 'report_ci'

help_topic: str | None = 'report_templates'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of ReportTemplate

ordering = ['name']

permission_required = ['emiflow.view_reporttemplate']

plural = 'Report Templates'

Plural may be used by templates to display the model name.

singular = 'Report Template'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.reporting.ReportTemplateUpdate(**kwargs)

Bases: FeatureRequiredMixin, UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report Template'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_delete'

Update view displays a button to delete the object if delete_view is not None.

feature_required: str | None = 'report_ci'

form_class

alias of ReportTemplateForm

form_template = 'emiflow/report_template/form.html'

Template to be included instead of generic form display.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'report_templates'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of ReportTemplate

multipart_form = True

Whether to use multipart/form-data enctype.

permission_required = ['emiflow.change_reporttemplate']

plural = 'Report Templates'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:reporttemplate_index'

Name of read view to link to in related links widget.

singular = 'Report Template'

Singular may be used by templates to display the model name.

template_name = 'emiflow/report_template/update.html'

class ferrosoft.apps.emiflow.views.reporting.ReportUpdate(**kwargs)

Bases: FeatureRequiredMixin, UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Report'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:report_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:report_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:report_delete'

Update view displays a button to delete the object if delete_view is not None.

feature_required: str | None = 'reporting'

form_class

alias of ReportForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'new_report'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Report

permission_required = ['emiflow.change_report']

plural = 'Reports'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:report_index'

Name of read view to link to in related links widget.

static related_links()

The type of the None singleton.

singular = 'Report'

Singular may be used by templates to display the model name.

template_name = 'emiflow/report/update.html'

async ferrosoft.apps.emiflow.views.reporting.report_document(request, report_pk)

Ajax view displaying report document.

Contents of report document is specific to report type. Therefore, rendering of document is offloaded to a view function defined in DOCUMENT_VIEWS.

ferrosoft.apps.emiflow.views.reporting.report_document_output(request)

ferrosoft.apps.emiflow.views.reporting.report_download(request, file_pk)

Return type:

HttpResponse

async ferrosoft.apps.emiflow.views.reporting.run_document_generator(request: HttpRequest, generator: DocumentGenerator, tenant: Tenant) → HttpResponse

Return type:

HttpResponse

ferrosoft.apps.emiflow.views.settings module

class ferrosoft.apps.emiflow.views.settings.BusinessCentralSettingsUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Business Central Settings'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:businesscentralsettings_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:businesscentralsettings_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:businesscentralsettings_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of BusinessCentralSettingsForm

get_object(queryset=None)

Return the object the view is displaying.

Require self.queryset and a pk or slug argument in the URLconf. Subclasses can override this to return any object.

model

alias of BusinessCentralSettings

permission_required = ['emiflow.change_businesscentralsettings']

plural = 'Business Central Settings'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:businesscentralsettings_index'

Name of read view to link to in related links widget.

singular = 'Business Central Settings'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.settings.EmissionFactorCreateView(*args, **kwargs)

Bases: DependentCreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Factor'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

form_class

alias of EmissionFactorForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

model

alias of EmissionFactor

parent_model

alias of EnergyCarrier

permission_required = ['emiflow.add_emissionfactor']

class ferrosoft.apps.emiflow.views.settings.EmissionFactorDeleteView(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Factor'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

model

alias of EmissionFactor

permission_required = ['emiflow.delete_emissionfactor']

class ferrosoft.apps.emiflow.views.settings.EmissionFactorUpdateView(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emission Factor'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:emissionfactor_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:emissionfactor_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of EmissionFactorForm

get_success_url()

Return the URL to redirect to after processing a valid form.

model

alias of EmissionFactor

permission_required = ['emiflow.change_emissionfactor']

plural = 'Emission factors'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:emissionfactor_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Emission factor'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.settings.EmitterCopyView(*args, **kwargs)

Bases: CopyView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Copy Emitter'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emitter_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of EmitterForm

model

alias of Emitter

permission_required = ['emiflow.add_emitter']

static prepare_copy(source, target, **kwargs)

class ferrosoft.apps.emiflow.views.settings.EmitterCreateView(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emitter'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emitter_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of EmitterForm

help_topic: str | None = 'emitters'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Emitter

permission_required = ['emiflow.add_emitter']

class ferrosoft.apps.emiflow.views.settings.EmitterDeleteView(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emitter'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emitter_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

help_topic: str | None = 'emitters'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Emitter

permission_required = ['emiflow.delete_emitter']

class ferrosoft.apps.emiflow.views.settings.EmitterTableView(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emitter'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:emitter_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of EmitterFilter

help_topic: str | None = 'emitters'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Emitter

ordering = 'name'

permission_required = ['emiflow.view_emitter']

plural = 'Emitters'

Plural may be used by templates to display the model name.

singular = 'Emitter'

Singular may be used by templates to display the model name.

table_class

alias of EmitterTable

class ferrosoft.apps.emiflow.views.settings.EmitterUpdateView(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Emitter'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:emitter_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

copy_view: str | Callable[[...], str] | None = 'emiflow:emitter_copy'

Update view displays a button to copy the object if copy_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:emitter_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:emitter_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of EmitterForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'emitters'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Emitter

permission_required = ['emiflow.change_emitter']

plural = 'Emitters'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:emitter_index'

Name of read view to link to in related links widget.

related_links()

The type of the None singleton.

singular = 'Emitter'

Singular may be used by templates to display the model name.

template_name = 'emiflow/emitter/update.html'

class ferrosoft.apps.emiflow.views.settings.EnergyCarrierCopyView(*args, **kwargs)

Bases: CopyView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Copy Energy carrier'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of EnergyCarrierForm

model

alias of EnergyCarrier

permission_required = ['emiflow.add_energycarrier']

static prepare_copy(source, target, **kwargs)

class ferrosoft.apps.emiflow.views.settings.EnergyCarrierCreateView(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Energy Carrier'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of EnergyCarrierForm

model

alias of EnergyCarrier

permission_required = ['emiflow.add_energycarrier']

class ferrosoft.apps.emiflow.views.settings.EnergyCarrierDeleteView(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Energy Carrier'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

model

alias of EnergyCarrier

permission_required = ['emiflow.delete_energycarrier']

class ferrosoft.apps.emiflow.views.settings.EnergyCarrierTableView(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Energy Carrier'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of EnergyCarrierFilter

model

alias of EnergyCarrier

ordering = 'name'

permission_required = ['emiflow.view_energycarrier']

plural = 'Energy carriers'

Plural may be used by templates to display the model name.

singular = 'Energy carrier'

Singular may be used by templates to display the model name.

table_class

alias of EnergyCarrierTable

class ferrosoft.apps.emiflow.views.settings.EnergyCarrierUpdateView(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Energy Carrier'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

copy_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_copy'

Update view displays a button to copy the object if copy_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of EnergyCarrierForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

model

alias of EnergyCarrier

permission_required = ['emiflow.change_energycarrier']

plural = 'Energy carriers'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:energycarrier_index'

Name of read view to link to in related links widget.

singular = 'Energy carrier'

Singular may be used by templates to display the model name.

template_name = 'emiflow/energy_carrier/update.html'

class ferrosoft.apps.emiflow.views.settings.SettingsIndex(**kwargs)

Bases: LoginRequiredMixin, PlatformActivityMixin, TemplateView

activity_title = 'Settings'

Activity title should be a very short label e.g. indicating the current model being operated on.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

template_name = 'emiflow/settings/index.html'

class ferrosoft.apps.emiflow.views.settings.SettingsPage(title, subtitle, view)

Bases: object

subtitle: str

title: str

view: str

ferrosoft.apps.emiflow.views.settings.settings_transport_defaults(request)

ferrosoft.apps.emiflow.views.transport module

class ferrosoft.apps.emiflow.views.transport.FreightItemCreate(*args, **kwargs)

Bases: DependentCreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Freight Item'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:freightitem_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of FreightItemForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'freight_items'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of FreightItem

parent_model

alias of TransportChain

permission_required = ['emiflow.add_freightitem']

class ferrosoft.apps.emiflow.views.transport.FreightItemDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Freight Item'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:freightitem_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'freight_items'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of FreightItem

permission_required = ['emiflow.delete_freightitem']

class ferrosoft.apps.emiflow.views.transport.FreightItemUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Freight Item'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:freightitem_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:freightitem_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:freightitem_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of FreightItemForm

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'freight_items'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of FreightItem

permission_required = ['emiflow.change_freightitem']

plural = 'Freight items'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:freightitem_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Freight item'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.transport.TransportChainElementCreate(*args, **kwargs)

Bases: DependentCreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain Element'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

enable_missing_parent = True

epitype_query = 'e'

form_class

alias of TransportChainElementForm

form_valid(form)

If the form is valid, save the associated model.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_template_names()

Return a list of template names to be used for the request. May not be called if render_to_response() is overridden. Return a list containing template_name, if set on the value. Otherwise, return a list containing:

• the contents of the template_name_field field on the object instance that the view is operating upon (if available)

• <app_label>/<model_name><template_name_suffix>.html

help_topic: str | None = 'transport_chain_elements'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChainElement

parent_model = <ferrosoft.apps.emiflow.models.transport.TransportChainManagerPrefetched object>

permission_required = ['emiflow.add_transportchainelement']

class ferrosoft.apps.emiflow.views.transport.TransportChainElementDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain Element'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportchainelement_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'transport_chain_elements'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChainElement

permission_required = ['emiflow.delete_transportchainelement']

class ferrosoft.apps.emiflow.views.transport.TransportChainElementUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain Element'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:transportchainelement_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:transportchainelement_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TransportChainElementForm

form_valid(form)

If the form is valid, save the associated model.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_success_url()

Return the URL to redirect to after processing a valid form.

get_template_names()

Return a list of template names to be used for the request. May not be called if render_to_response() is overridden. Return a list containing template_name, if set on the value. Otherwise, return a list containing:

• the contents of the template_name_field field on the object instance that the view is operating upon (if available)

• <app_label>/<model_name><template_name_suffix>.html

help_topic: str | None = 'transport_chain_elements'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChainElement

permission_required = ['emiflow.change_transportchainelement']

plural = 'Transport chain elements'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:transportchainelement_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Transport chain element'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.transport.TransportCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain'

Activity title should be a very short label e.g. indicating the current model being operated on.

static cancel_view()

The type of the None singleton.

form_class

alias of TransportChainForm

form_template = 'emiflow/transport/form.html'

Template to be included instead of generic form display.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'new_transport'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChain

permission_required = ['emiflow.add_transportchain']

template_name = 'emiflow/transport/create.html'

class ferrosoft.apps.emiflow.views.transport.TransportDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportchain_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_valid(form)

Perform the delete, falling back to the form when on_delete=RESTRICT fires.

help_topic: str | None = 'transports'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChain

permission_required = ['emiflow.delete_transportchain']

class ferrosoft.apps.emiflow.views.transport.TransportIndexView(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:transportchain_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of TransportChainFilter

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'transports'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChain

ordering = '-reference'

permission_required = ['emiflow.view_transportchain']

plural = 'Transport chains'

Plural may be used by templates to display the model name.

queryset = <ferrosoft.apps.emiflow.models.transport.TransportChainManagerPrefetched object>

singular = 'Transport chain'

Singular may be used by templates to display the model name.

table_class

alias of TransportChainTable

template_name = 'emiflow/transport/index.html'

class ferrosoft.apps.emiflow.views.transport.TransportOperationCopy(*args, **kwargs)

Bases: CopyView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Copy Transport Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TransportOperationForm

model

alias of TransportOperation

permission_required = ['emiflow.add_transportoperation']

static prepare_copy(source, target, **kwargs)

class ferrosoft.apps.emiflow.views.transport.TransportOperationCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TransportOperationForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'new_transport_operation'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportOperation

permission_required = ['emiflow.add_transportoperation']

static related_links()

The type of the None singleton.

class ferrosoft.apps.emiflow.views.transport.TransportOperationDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

help_topic: str | None = 'transport_operations'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportOperation

permission_required = ['emiflow.delete_transportoperation']

class ferrosoft.apps.emiflow.views.transport.TransportOperationRead(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of TransportOperationFilter

help_topic: str | None = 'transport_operations'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportOperation

ordering = '-reference'

permission_required = ['emiflow.view_transportoperation']

plural = 'Transport Operations'

Plural may be used by templates to display the model name.

singular = 'Transport Operation'

Singular may be used by templates to display the model name.

table_class

alias of TransportOperationTable

class ferrosoft.apps.emiflow.views.transport.TransportOperationUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

copy_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_copy'

Update view displays a button to copy the object if copy_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TransportOperationForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'new_transport_operation'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportOperation

permission_required = ['emiflow.change_transportoperation']

plural = 'Transport Operations'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:transportoperation_index'

Name of read view to link to in related links widget.

static related_links()

The type of the None singleton.

singular = 'Transport Operation'

Singular may be used by templates to display the model name.

template_name = 'emiflow/transportoperation/update.html'

class ferrosoft.apps.emiflow.views.transport.TransportUpdate(*args, **kwargs)

Bases: UpdateView

class TransportDetailView(**kwargs)

Bases: DetailView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain'

Activity title should be a very short label e.g. indicating the current model being operated on.

get(request, *args, **kwargs)

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_queryset()

Return the QuerySet that will be used to look up the object.

This method is called by the default implementation of get_object() and may not be called if get_object() is overridden.

help_topic: str | None = 'transports'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChain

permission_required = ['emiflow.view_transportchain']

plural = 'Transport chains'

Plural may be used by templates to display the model name.

singular = 'Transport chain'

Singular may be used by templates to display the model name.

template_name = 'emiflow/transport/detail.html'

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Transport Chain'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:transportchain_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:transportchain_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:transportchain_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TransportChainForm

form_template = 'emiflow/transport/form.html'

Template to be included instead of generic form display.

get(request, *args, **kwargs)

Handle GET requests: instantiate a blank version of the form.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

get_queryset()

Return the QuerySet that will be used to look up the object.

This method is called by the default implementation of get_object() and may not be called if get_object() is overridden.

help_topic: str | None = 'new_transport'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TransportChain

permission_required = ['emiflow.change_transportchain']

plural = 'Transport chains'

Plural may be used by templates to display the model name.

post(request, *args, **kwargs)

Handle POST requests: instantiate a form instance with the passed POST variables and then check if it’s valid.

read_view: str | Callable[[...], str] | None = 'emiflow:transportchain_index'

Name of read view to link to in related links widget.

singular = 'Transport chain'

Singular may be used by templates to display the model name.

template_name = 'emiflow/transport/update.html'

ferrosoft.apps.emiflow.views.treatment module

class ferrosoft.apps.emiflow.views.treatment.AllocationEditView(**kwargs)

Bases: LoginRequiredMixin, PlatformActivityMixin, DetailView

activity_title = 'Emission Allocation'

Activity title should be a very short label e.g. indicating the current model being operated on.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

Return type:

dict[str, Any]

help_topic: str | None = 'treatment_operation_allocation'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperation

post(request, *args, **kwargs)

template_name = 'emiflow/treatmentoperation/allocation.html'

class ferrosoft.apps.emiflow.views.treatment.TreatmentCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatment_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TreatmentForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

Return type:

dict[str, Any]

help_topic: str | None = 'new_treatment'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Treatment

permission_required = ['emiflow.add_treatment']

class ferrosoft.apps.emiflow.views.treatment.TreatmentDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatment_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

model

alias of Treatment

permission_required = ['emiflow.delete_treatment']

class ferrosoft.apps.emiflow.views.treatment.TreatmentInputLineUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Input Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentinputline_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = None

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentInputLineForm

get_success_url()

Return the URL to redirect to after processing a valid form.

Return type:

str

help_topic: str | None = 'treatment_input_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentInputLine

permission_required = ['emiflow.change_treatmentinputline']

plural = 'Material Input Lines'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentinputline_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Material Input Line'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationCopy(*args, **kwargs)

Bases: CopyView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Copy Treatment Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TreatmentOperationForm

model

alias of TreatmentOperation

permission_required = ['emiflow.add_treatmentoperation']

static prepare_copy(source, target, **kwargs)

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

form_class

alias of TreatmentOperationForm

form_template = 'emiflow/treatmentoperation/form.html'

Template to be included instead of generic form display.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

help_topic: str | None = 'new_treatment_operation'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperation

permission_required = ['emiflow.add_treatmentoperation']

static related_links()

The type of the None singleton.

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

help_topic: str | None = 'treatment_operations'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperation

permission_required = ['emiflow.delete_treatmentoperation']

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationInputLineCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Input Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

form_class

alias of TreatmentOperationInputLineForm

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'treatment_operation_input_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationInputLine

permission_required = ['emiflow.add_treatmentoperationinputline']

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationInputLineDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Input Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'treatment_operation_input_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationInputLine

permission_required = ['emiflow.delete_treatmentoperationinputline']

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationInputLineUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Input Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationinputline_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationinputline_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentOperationInputLineForm

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'treatment_operation_input_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationInputLine

permission_required = ['emiflow.change_treatmentoperationinputline']

plural = 'Material Input Lines'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationinputline_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Material Input Line'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationOutputLineCreate(**kwargs)

Bases: CreateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Output Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

form_class

alias of TreatmentOperationOutputLineForm

get_form_kwargs(*args, **kwargs)

Return the keyword arguments for instantiating the form.

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'treatment_operation_output_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationOutputLine

permission_required = ['emiflow.add_treatmentoperationoutputline']

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationOutputLineDelete(*args, **kwargs)

Bases: DeleteView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Output Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

get_success_url()

Redirect to the conventional <app>:<model>_index list view.

help_topic: str | None = 'treatment_operation_output_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationOutputLine

permission_required = ['emiflow.delete_treatmentoperationoutputline']

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationOutputLineUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Output Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationoutputline_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationoutputline_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentOperationOutputLineForm

get_success_url()

Return the URL to redirect to after processing a valid form.

help_topic: str | None = 'treatment_operation_output_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperationOutputLine

permission_required = ['emiflow.change_treatmentoperationoutputline']

plural = 'Material Output Lines'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperationoutputline_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Material Output Line'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationRead(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of TreatmentOperationFilter

help_topic: str | None = 'treatment_operations'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperation

ordering = '-reference'

permission_required = ['emiflow.view_treatmentoperation']

plural = 'Treatment Operations'

Plural may be used by templates to display the model name.

singular = 'Treatment Operation'

Singular may be used by templates to display the model name.

table_class

alias of TreatmentOperationTable

class ferrosoft.apps.emiflow.views.treatment.TreatmentOperationUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment Operation'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

copy_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_copy'

Update view displays a button to copy the object if copy_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentOperationForm

form_template = 'emiflow/treatmentoperation/form.html'

Template to be included instead of generic form display.

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'new_treatment_operation'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOperation

permission_required = ['emiflow.change_treatmentoperation']

plural = 'Treatment Operations'

Plural may be used by templates to display the model name.

post(request, *args, **kwargs)

Handle POST requests: instantiate a form instance with the passed POST variables and then check if it’s valid.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentoperation_index'

Name of read view to link to in related links widget.

static related_links()

The type of the None singleton.

singular = 'Treatment Operation'

Singular may be used by templates to display the model name.

template_name = 'emiflow/treatmentoperation/update.html'

class ferrosoft.apps.emiflow.views.treatment.TreatmentOutputLineUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Material Output Line'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view()

The type of the None singleton.

create_view: str | Callable[[...], str] | None = 'emiflow:treatmentoutputline_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = None

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentOutputLineForm

get_success_url()

Return the URL to redirect to after processing a valid form.

Return type:

str

help_topic: str | None = 'treatment_output_material'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of TreatmentOutputLine

permission_required = ['emiflow.change_treatmentoutputline']

plural = 'Material Output Lines'

Plural may be used by templates to display the model name.

read_view: str | Callable[[...], str] | None = 'emiflow:treatmentoutputline_index'

Name of read view to link to in related links widget.

related_links_default: bool = False

Show default related links, if enabled.

singular = 'Material Output Line'

Singular may be used by templates to display the model name.

class ferrosoft.apps.emiflow.views.treatment.TreatmentRead(**kwargs)

Bases: TableView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment'

Activity title should be a very short label e.g. indicating the current model being operated on.

create_view: str | Callable[[...], str] | None = 'emiflow:treatment_create'

List view displays a button to create a new object if create_view is not None.

filterset_class

alias of TreatmentFilter

help_topic: str | None = 'treatments'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Treatment

ordering = '-reference'

permission_required = ['emiflow.view_treatment']

plural = 'Treatments'

Plural may be used by templates to display the model name.

singular = 'Treatment'

Singular may be used by templates to display the model name.

table_class

alias of TreatmentTable

template_name = 'emiflow/treatment/index.html'

class ferrosoft.apps.emiflow.views.treatment.TreatmentUpdate(**kwargs)

Bases: UpdateView

activity_app = 'emiflow'

Django identifier of the app the activity belongs to. If it is None, the app is derived from template_name.

activity_title = 'Treatment'

Activity title should be a very short label e.g. indicating the current model being operated on.

cancel_view: str | Callable[[...], str] | None = 'emiflow:treatment_index'

Create, Update and Delete views display a button to cancel the operation if cancel_view is not None.

create_view: str | Callable[[...], str] | None = 'emiflow:treatment_create'

List view displays a button to create a new object if create_view is not None.

delete_view: str | Callable[[...], str] | None = 'emiflow:treatment_delete'

Update view displays a button to delete the object if delete_view is not None.

form_class

alias of TreatmentForm

get_context_data(**kwargs)

Inject activity metadata (title, app, container, help URL) into the context.

Raises:

RuntimeError – If neither activity_app nor a string template_name is defined and the app label cannot be inferred.

help_topic: str | None = 'new_treatment'

ID of help topic passed to get_help_url. Resulting URL is added to template context as help_url.

model

alias of Treatment

permission_required = ['emiflow.change_treatment']

plural = 'Treatments'

Plural may be used by templates to display the model name.

post(request, *args, **kwargs)

Handle POST requests: instantiate a form instance with the passed POST variables and then check if it’s valid.

read_view: str | Callable[[...], str] | None = 'emiflow:treatment_index'

Name of read view to link to in related links widget.

singular = 'Treatment'

Singular may be used by templates to display the model name.

template_name = 'emiflow/treatment/update.html'