Skip to content

Commit

Permalink
Remove deprecated reserved_resources_record filter
Browse files Browse the repository at this point in the history
fixes: #5415
  • Loading branch information
gerrod3 authored and dralley committed Jun 3, 2024
1 parent 778108a commit 26a5b52
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 44 deletions.
1 change: 1 addition & 0 deletions CHANGES/5415.removal
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed task's ``reserved_resources_record`` filter. Please use ``reserved_resources`` instead.
38 changes: 1 addition & 37 deletions pulpcore/app/viewsets/custom_filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@
from collections import defaultdict
from itertools import chain
from gettext import gettext as _
from urllib.parse import urlparse

from django.urls import Resolver404, resolve
from django.urls import resolve
from django.db.models import ObjectDoesNotExist
from django_filters import BaseInFilter, CharFilter, Filter
from rest_framework import serializers
from rest_framework.serializers import ValidationError as DRFValidationError

from pulpcore.app.models import ContentArtifact, RepositoryVersion, Publication
from pulpcore.app.viewsets import NamedModelViewSet
from pulpcore.app.loggers import deprecation_logger


class ReservedResourcesFilter(Filter):
Expand Down Expand Up @@ -68,40 +66,6 @@ class ReservedResourcesInFilter(BaseInFilter, ReservedResourcesFilter):
"""


class ReservedResourcesRecordFilter(Filter):
"""
Enables a user to filter tasks by a reserved resource href.
Warning: This filter is badly documented and not fully functional, but we need to keep it for
compatibility reasons. Use ``ReservedResourcesFilter`` instead.
"""

def filter(self, qs, value):
"""
Args:
qs (django.db.models.query.QuerySet): The Queryset to filter
value (string): href containing a reference to a reserved resource
Returns:
django.db.models.query.QuerySet: Queryset filtered by the reserved resource
"""

if value is None:
# a value was not supplied by a user
return qs

deprecation_logger.warning(
"This filter is deprecated. Please use reserved_resources(__in) instead."
)

try:
resolve(urlparse(value).path)
except Resolver404:
raise serializers.ValidationError(detail=_("URI not valid: {u}").format(u=value))

return qs.filter(reserved_resources_record__contains=[value])


class CreatedResourcesFilter(Filter):
"""
Filter used to get tasks by created resources.
Expand Down
7 changes: 0 additions & 7 deletions pulpcore/app/viewsets/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,13 @@
from pulpcore.app.viewsets.custom_filters import (
ReservedResourcesFilter,
ReservedResourcesInFilter,
ReservedResourcesRecordFilter,
CreatedResourcesFilter,
)
from pulpcore.constants import TASK_INCOMPLETE_STATES, TASK_STATES
from pulpcore.tasking.tasks import dispatch, cancel_task


class TaskFilter(BaseFilterSet):
# This filter is deprecated and badly documented, but we need to keep it for compatibility
# reasons
reserved_resources_record = ReservedResourcesRecordFilter(
help_text=_("Deprecated, will be removed in pulpcore 3.55. Use reserved_resources instead.")
)
created_resources = CreatedResourcesFilter()
# Non model field filters
reserved_resources = ReservedResourcesFilter(exclusive=True, shared=True)
Expand All @@ -70,7 +64,6 @@ class Meta:
"parent_task": ["exact"],
"child_tasks": ["exact"],
"task_group": ["exact"],
"reserved_resources_record": ["exact"],
"created_resources": ["exact"],
}

Expand Down

0 comments on commit 26a5b52

Please sign in to comment.