Skip to content

dataset_allowed_actions#

DatasetAllowedActionsSerializer#

Bases: Serializer

List what the current logged in user is allowed to do with the dataset.

Helps other services determine what actions should be available for the user without having to reimplement Metax authorization logic. Checks AccessPolicy rules without making an actual request by faking the required view and request objects.

Expects object to be a dataset, so set source="*" when used as a dataset serializer field.

Source code in src/apps/core/serializers/dataset_allowed_actions.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class DatasetAllowedActionsSerializer(serializers.Serializer):
    """List what the current logged in user is allowed to do with the dataset.

    Helps other services determine what actions should be available for
    the user without having to reimplement Metax authorization logic.
    Checks AccessPolicy rules without making an actual request
    by faking the required view and request objects.

    Expects object to be a dataset, so set source="*" when used as a
    dataset serializer field.
    """

    update = serializers.SerializerMethodField()
    download = serializers.SerializerMethodField()

    @property
    def access_policy(self):
        """Get access_policy from viewset while avoiding circular import errors."""
        from apps.core.views import DatasetViewSet

        return DatasetViewSet.access_policy

    def get_update(self, obj: Dataset):
        return self.access_policy().query_object_permission(
            user=self.context["request"].user, object=obj, action="update"
        )

    def get_download(self, obj: Dataset):
        return self.access_policy().query_object_permission(
            user=self.context["request"].user, object=obj, action="<op:download>"
        )

access_policy property #

Get access_policy from viewset while avoiding circular import errors.

DatasetAllowedActionsQueryParamsSerializer#

Bases: Serializer

Source code in src/apps/core/serializers/dataset_allowed_actions.py 
50
51
52
53
54
class DatasetAllowedActionsQueryParamsSerializer(serializers.Serializer):
    include_allowed_actions = serializers.BooleanField(
        help_text=_("Include allowed actions for current user. Fairdata internal use."),
        required=False,
    )