admin

measurement.admin

Classes

Measurement

Bases: MeasurementBase

Class to store the measurements and their validation status.

This class holds the value of a given variable and station at a specific time, as well as auxiliary information such as maximum and minimum values, depth and direction, for vector quantities. All of these have a raw version where a backup of the original data is kept, should this change at any point.

Flags to monitor its validation status, if the data is active (and therefore can be used for reporting) and if it has actually been used for that is also included.

Attributes:

Name	Type	Description
depth	int	Depth of the measurement.
direction	Decimal	Direction of the measurement, useful for vector quantities.
raw_value	Decimal	Original value of the measurement.
raw_maximum	Decimal	Original maximum value of the measurement.
raw_minimum	Decimal	Original minimum value of the measurement.
raw_direction	Decimal	Original direction of the measurement.
raw_depth	int	Original depth of the measurement.
is_validated	bool	Flag to indicate if the measurement has been validated.
is_active	bool	Flag to indicate if the measurement is active. An inactive measurement is not used for reporting

Attributes

overwritten: bool property

Indicates if any of the values associated to the entry have been overwritten.

Returns:

Name	Type	Description
bool	bool	True if any raw field is different to the corresponding standard field.

raws: tuple[str, ...] property

Return the raw fields of the measurement.

Returns:

Type	Description
tuple[str, ...]	tuple[str]: Tuple with the names of the raw fields of the measurement.

Functions

clean()

Check consistency of validation, reporting and backs-up values.

Source code in measurement\models.py

def clean(self) -> None:
    """Check consistency of validation, reporting and backs-up values."""
    # Check consistency of validation
    if not self.is_validated and not self.is_active:
        raise ValidationError("Only validated entries can be declared as inactive.")

    # Backup values to raws, if needed
    for r in self.raws:
        value = getattr(self, r.removeprefix("raw_"))
        if value and not getattr(self, r):
            setattr(self, r, value)

MeasurementAdmin

Bases: MeasurementBaseAdmin

Admin class for the Measurement model.

MeasurementBaseAdmin

Bases: GuardedModelAdmin

Functions

formfield_for_foreignkey(db_field, request, **kwargs)

Limit the queryset for foreign key fields.

Source code in measurement\admin.py

def formfield_for_foreignkey(self, db_field, request, **kwargs):
    """Limit the queryset for foreign key fields."""
    if db_field.name == "station":
        kwargs["queryset"] = get_objects_for_user(
            request.user, "station.change_station"
        )
    elif db_field.name == "variable":
        kwargs["queryset"] = get_queryset(db_field, request.user)
    return super().formfield_for_foreignkey(db_field, request, **kwargs)

get_queryset(request)

Return a queryset of the objects that the user has view permissions for.

Source code in measurement\admin.py

def get_queryset(self, request):
    """Return a queryset of the objects that the user has view permissions for."""
    qs = super().get_queryset(request)
    stations = get_objects_for_user(request.user, "station.view_measurements")
    return qs.filter(station__in=stations)

has_add_permission(request)

Check if the user has the correct permission to add objects.

Source code in measurement\admin.py

def has_add_permission(self, request):
    """Check if the user has the correct permission to add objects."""
    return request.user.has_perm(
        f"{self.opts.app_label}.add_{self.opts.model_name}"
    )

has_change_permission(request, obj=None)

Check if the user has the correct permission to change the object.

Source code in measurement\admin.py

def has_change_permission(self, request, obj=None):
    """Check if the user has the correct permission to change the object."""
    if obj is not None:
        return request.user.has_perm("change_station", obj.station)
    return True

has_delete_permission(request, obj=None)

Check if the user has the correct permission to delete the object.

Source code in measurement\admin.py

def has_delete_permission(self, request, obj=None):
    """Check if the user has the correct permission to delete the object."""
    if obj is not None:
        return request.user.has_perm("delete_station", obj.station)
    return True

has_view_permission(request, obj=None)

Check if the user has the correct permission to view the object.

Source code in measurement\admin.py

def has_view_permission(self, request, obj=None):
    """Check if the user has the correct permission to view the object."""
    if obj is not None:
        return request.user.has_perm("view_measurements", obj.station)
    return True

Report

Bases: MeasurementBase

Holds the different reporting data.

It also keeps track of which data has already been used when creating the reports.

Attributes:

Name	Type	Description
report_type	str	Type of report. It can be hourly, daily or monthly.
completeness	Decimal	Completeness of the report. Eg. a daily report with 24 hourly measurements would have a completeness of 100%.

Functions

clean()

Validate that the report type and use of the data is consistent.

Source code in measurement\models.py

def clean(self) -> None:
    """Validate that the report type and use of the data is consistent."""
    if self.report_type == ReportType.HOURLY:
        self.time = self.time.replace(minute=0, second=0, microsecond=0)
    elif self.report_type == ReportType.DAILY:
        self.time = self.time.replace(hour=0, minute=0, second=0, microsecond=0)
    elif self.report_type == ReportType.MONTLY:
        self.time = self.time.replace(
            day=1, hour=0, minute=0, second=0, microsecond=0
        )

ReportAdmin

Bases: MeasurementBaseAdmin

Admin class for the Report model.

Functions

get_queryset(db_field, user)

Return a queryset based on the permissions of the user.

Returns queryset of public objects and objects that the user has change permisions for. For the case of Station objects, having the change permission is necessary to include the object in the queryset - being Public is not enough.

Parameters:

Name	Type	Description	Default
db_field	Field	Field to filter.	required
user	Model	User to check permissions for.	required

Returns:

Type	Description
QuerySet	model.QuerySet: Queryset of objects that the user has permissions for.

Source code in management\permissions.py

def get_queryset(db_field: model.Field, user: model.Model) -> model.QuerySet:
    """Return a queryset based on the permissions of the user.

    Returns queryset of public objects and objects that the user has change permisions
    for. For the case of `Station` objects, having the `change` permission is
    necessary to include the object in the queryset - being `Public` is not enough.

    Args:
        db_field (model.Field): Field to filter.
        user (model.Model): User to check permissions for.

    Returns:
        model.QuerySet: Queryset of objects that the user has permissions for.
    """
    app_name = db_field.related_model._meta.app_label
    model_name = db_field.related_model._meta.model_name
    user_objects = get_objects_for_user(user, f"{app_name}.change_{model_name}")
    public_objects = (
        db_field.related_model.objects.none()
        if model_name == "station"
        else db_field.related_model.objects.filter(visibility="public")
    )
    return user_objects | public_objects