Region Condition

Region Condition Actions

class integreat_cms.cms.views.region_condition.region_condition_actions.RegionConditionResource(**kwargs)

Bases: ModelResource

A resources class that connects to the django-import-export library. It represents the to-be exported status of all regions.

DEFAULT_RESOURCE_FIELD

alias of Field

WIDGETS_MAP = {'AutoField': <class 'import_export.widgets.IntegerWidget'>, 'BigAutoField': <class 'import_export.widgets.IntegerWidget'>, 'BigIntegerField': <class 'import_export.widgets.IntegerWidget'>, 'BooleanField': <class 'import_export.widgets.BooleanWidget'>, 'CharField': <class 'import_export.widgets.CharWidget'>, 'DateField': <class 'import_export.widgets.DateWidget'>, 'DateTimeField': <class 'import_export.widgets.DateTimeWidget'>, 'DecimalField': <class 'import_export.widgets.DecimalWidget'>, 'DurationField': <class 'import_export.widgets.DurationWidget'>, 'FloatField': <class 'import_export.widgets.FloatWidget'>, 'ForeignKey': 'get_fk_widget', 'IntegerField': <class 'import_export.widgets.IntegerWidget'>, 'JSONField': <class 'import_export.widgets.JSONWidget'>, 'ManyToManyField': 'get_m2m_widget', 'NullBooleanField': <class 'import_export.widgets.BooleanWidget'>, 'OneToOneField': 'get_fk_widget', 'PositiveBigIntegerField': <class 'import_export.widgets.IntegerWidget'>, 'PositiveIntegerField': <class 'import_export.widgets.IntegerWidget'>, 'PositiveSmallIntegerField': <class 'import_export.widgets.IntegerWidget'>, 'SmallAutoField': <class 'import_export.widgets.IntegerWidget'>, 'SmallIntegerField': <class 'import_export.widgets.IntegerWidget'>, 'TimeField': <class 'import_export.widgets.TimeWidget'>}

__init__(**kwargs)

kwargs:

An optional dict of kwargs. Subclasses can use kwargs to pass dynamic values to enhance import / exports.

after_delete_instance(instance, row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

after_export(queryset, dataset, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• queryset – The queryset for export.

• dataset – A tablib.Dataset.

• **kwargs – Metadata which may be associated with the export.

after_import(dataset, result, **kwargs)

Reset the SQL sequences after new objects are imported

after_import_instance(instance, new, row_number=None, **kwargs)

after_import_row(row, row_result, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• row – A dict containing key / value data for the row to be imported.

• row_result – A RowResult instance. References the persisted instance as an attribute.

• **kwargs – See import_row()

after_init_instance(instance, new, row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• instance – A new or existing model instance.

• new – a boolean flag indicating whether instance is new or existing.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

after_save_instance(instance, row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

before_delete_instance(instance, row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

before_export(queryset, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• queryset – The queryset for export.

• **kwargs – Metadata which may be associated with the export.

before_import(dataset, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• dataset – A tablib.Dataset.

• **kwargs – See import_row()

before_import_row(row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

before_save_instance(instance, row, **kwargs)

Override to add additional logic. Does nothing by default.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

bulk_create(using_transactions, dry_run, raise_errors, batch_size=None, result=None)

Creates objects by calling bulk_create.

bulk_delete(using_transactions, dry_run, raise_errors, result=None)

Deletes objects by filtering on a list of instances to be deleted, then calling delete() on the entire queryset.

bulk_update(using_transactions, dry_run, raise_errors, batch_size=None, result=None)

Updates objects by calling bulk_update.

static dehydrate_name(region: Region) → str

Parameters:

region (Region) – The region

Returns:

The name of a region

Return type:

str

static dehydrate_num_broken_links(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of broken links

Return type:

int

static dehydrate_num_languages_besides_root_language(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of languages besides the root language

Return type:

int

static dehydrate_num_low_hix_pages(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of page translations with low hix value

Return type:

int

static dehydrate_num_outdated_pages(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of outdated pages

Return type:

int

static dehydrate_num_pages(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of pages in this region

Return type:

int

static dehydrate_num_pages_with_missing_or_outdated_translation(region: Region) → int

Parameters:

region (Region) – The region

Returns:

The number of pages with at least one missing or outdated translation

Return type:

int

delete_instance(instance, row, **kwargs)

Calls instance.delete() as long as dry_run is not set. If use_bulk then instances are appended to a list for bulk import.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

do_instance_save(instance, is_create)

A method specifically to provide a single overridable hook for the instance save operation. For example, this can be overridden to implement update_or_create().

Parameters:

• instance – The model instance to be saved.

• is_create – A boolean flag to indicate whether this is a new object to be created, or an existing object to be updated.

export(queryset=None, **kwargs)

Exports a resource.

Parameters:

queryset – The queryset for export (optional).

Returns:

A tablib.Dataset.

export_field(field, instance, **kwargs)

export_resource(instance, selected_fields=None, **kwargs)

classmethod field_from_django_field(field_name, django_field, readonly)

Returns a Resource Field instance for the given Django model field.

fields = {'name': <import_export.fields.Field: Region>, 'num_broken_links': <import_export.fields.Field: Number of broken links>, 'num_languages_besides_root_language': <import_export.fields.Field: Number of active languages besides default language>, 'num_low_hix_pages': <import_export.fields.Field: Number of low hix pages>, 'num_outdated_pages': <import_export.fields.Field: Number of outdated pages>, 'num_pages': <import_export.fields.Field: Number of pages>, 'num_pages_with_missing_or_outdated_translation': <import_export.fields.Field: Number of pages with at least one missing or outdated translation>, 'translation_budget': <import_export.fields.Field: MT budget>}

filter_export(queryset, **kwargs)

Override to filter an export queryset.

Parameters:

• queryset – The queryset for export.

• **kwargs – Metadata which may be associated with the export.

Returns:

The filtered queryset.

for_delete(row, instance)

Returns True if row importing should delete instance.

Default implementation returns False. Override this method to handle deletion.

Parameters:

• row – A dict containing key / value data for the row to be imported.

• instance – A new or existing model instance.

get_bulk_update_fields()

Returns the fields to be included in calls to bulk_update(). import_id_fields are removed because id fields cannot be supplied to bulk_update().

get_chunk_size()

classmethod get_db_connection_name()

classmethod get_diff_class()

Returns the class used to display the diff for an imported instance.

get_diff_headers()

Diff representation headers.

classmethod get_display_name()

classmethod get_error_result_class()

Returns the class used to store an error resulting from an import.

get_export_fields(selected_fields=None)

get_export_headers(selected_fields=None)

get_export_order()

get_field_name(field)

Returns the field name for a given field.

get_fields(**kwargs)

classmethod get_fk_widget(field)

Prepare widget for fk and o2o fields

get_import_fields()

get_import_id_fields()

get_import_order()

get_instance(*args: Any, **kwargs: Any) → Any

See import_export.resources.Resource.get_instance()

Parameters:

• args (Any)

• kwargs (Any)

Return type:

Any

classmethod get_m2m_widget(field)

Prepare widget for m2m field

get_or_init_instance(instance_loader, row)

Either fetches an already existing instance or initializes a new one.

get_queryset()

Returns a queryset of all objects for this model. Override this if you want to limit the returned queryset.

classmethod get_result_class()

Returns the class used to store the result of an import.

classmethod get_row_result_class()

Returns the class used to store the result of a row import.

get_use_transactions()

get_user_visible_fields()

handle_import_error(result, error, raise_errors=False)

import_data(*args: Any, **kwargs: Any) → Any

See import_export.resources.Resource.import_data()

Parameters:

• args (Any)

• kwargs (Any)

Return type:

Any

import_data_inner(dataset, dry_run, raise_errors, using_transactions, collect_failed_rows, **kwargs)

import_field(field, instance, row, is_m2m=False, **kwargs)

Handles persistence of the field data.

Parameters:

• field – A import_export.fields.Field instance.

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• is_m2m – A boolean value indicating whether or not this is a many-to-many field.

• **kwargs – See import_row()

import_instance(instance, row, **kwargs)

Traverses every field in this Resource and calls import_field(). If import_field() results in a ValueError being raised for one of more fields, those errors are captured and reraised as a single, multi-field ValidationError.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

import_obj(obj, data, dry_run, **kwargs)

import_row(*args: Any, **kwargs: Any) → Any

See import_export.resources.Resource.import_row()

Parameters:

• args (Any)

• kwargs (Any)

Return type:

Any

init_instance(row=None)

Initializes a new Django model.

iter_queryset(queryset)

save_instance(*args: Any, **kwargs: Any) → Any

See import_export.resources.Resource.save_instance()

Parameters:

• args (Any)

• kwargs (Any)

Return type:

Any

save_m2m(instance, row, **kwargs)

Saves m2m fields.

Model instance need to have a primary key value before a many-to-many relationship can be used.

Parameters:

• instance – A new or existing model instance.

• row – A dict containing key / value data for the row to be imported.

• **kwargs – See import_row()

skip_row(instance, original, row, import_validation_errors=None)

Returns True if row importing should be skipped.

Default implementation returns False unless skip_unchanged == True and skip_diff == False.

If skip_diff is True, then no comparisons can be made because original will be None.

When left unspecified, skip_diff and skip_unchanged both default to False, and rows are never skipped.

By default, rows are not skipped if validation errors have been detected during import. You can change this behavior and choose to ignore validation errors by overriding this method.

Override this method to handle skipping rows meeting certain conditions.

Use super if you want to preserve default handling while overriding

class YourResource(ModelResource):
    def skip_row(self, instance, original,
                 row, import_validation_errors=None):
        # Add code here
        return super().skip_row(instance, original, row,
                                import_validation_errors=import_validation_errors)

Parameters:

• instance – A new or updated model instance.

• original – The original persisted model instance.

• row – A dict containing key / value data for the row to be imported.

• import_validation_errors – A dict containing key / value data for any identified validation errors.

validate_instance(instance, import_validation_errors=None, validate_unique=True)

Takes any validation errors that were raised by import_instance(), and combines them with validation errors raised by the instance’s full_clean() method. The combined errors are then re-raised as single, multi-field ValidationError.

If the clean_model_instances option is False, the instances’s full_clean() method is not called, and only the errors raised by import_instance() are re-raised.

classmethod widget_from_django_field(f, default=<class 'import_export.widgets.Widget'>)

Returns the widget that would likely be associated with each Django type.

Includes mapping of Postgres Array field. In the case that psycopg2 is not installed, we consume the error and process the field regardless.

classmethod widget_kwargs_for_field(field_name, django_field)

Returns widget kwargs for given field_name.

integreat_cms.cms.views.region_condition.region_condition_actions.export_region_conditions(request: HttpRequest, file_format: str) → HttpResponse

Creates a data export summarizing the condition of all regions

Parameters:

• request (HttpRequest) – The current request

• file_format (str) – The file format to export

Returns:

A response containing the export data

Return type:

HttpResponse

Region Condition View

class integreat_cms.cms.views.region_condition.region_condition_view.RegionConditionView(**kwargs)

Bases: TemplateView, FilterSortMixin, PaginationMixin

View to analyze the condition of all regions

__init__(**kwargs)

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

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

default_page_size = 16

dispatch(request, *args, **kwargs)

extra_context = {'current_menu_item': 'region_condition'}

filter_form_class = None

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Render region list

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

get_context_data(**kwargs)

get_filter_form() → ObjectSearchForm | None

Return type:

ObjectSearchForm | None

get_filtered_sorted_queryset(queryset: QuerySet) → QuerySet

Parameters:

queryset (QuerySet)

Return type:

QuerySet

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.

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

http_method_not_allowed(request, *args, **kwargs)

max_page_size = 500

model

alias of Region

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

paginate_queryset(queryset: QuerySet) → Page

Parameters:

queryset (QuerySet)

Return type:

Page

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.

request

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

property sort_fields: list[str]

Extract only sortable field names from table_fields. A field is sortable if its first element is not None.

table_fields = []

template_engine = None

template_name = 'region_condition/region_condition.html'

The template to render (see TemplateResponseMixin)

view_is_async = False