Add ability to filter objects with EMPTY purls in PackageURLFilter #92

Signed-off-by: Thomas Druez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.10.1 (unreleased)
+-------------------
+
+- Add ability to filter objects with EMPTY purls in PackageURLFilter #92
+
 0.10.0 (2022-06-27)
 -------------------
 

src/packageurl/contrib/django/filters.py

@@ -29,18 +29,34 @@
 
 class PackageURLFilter(django_filters.CharFilter):
     """
-    Filter by a Package URL string.
-    Empty values are not applied to the QuerySet.
+    Filter by an exact Package URL string.
+    The special "EMPTY" value allows to retrieve objects with empty
+    Package URL.
 
-    This filter depends on a `for_package_url` method available on the Model
-    Manager, see for example `PackageURLQuerySetMixin`.
+    This filter depends on a `for_package_url` and `empty_package_url`
+    methods to be available on the Model Manager,
+    see for example `PackageURLQuerySetMixin`.
     """
 
+    is_empty = "EMPTY"
+    help_text = (
+        "Match Package URL. "
+        'Use "EMPTY" as value to retrieve objects with empty Package URL.'
+    )
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("help_text", self.help_text)
+        super().__init__(*args, **kwargs)
+
     def filter(self, qs, value):
-        empty_values = ([], (), {}, "", None)
-        if value in empty_values:
+        none_values = ([], (), {}, "", None)
+        if value in none_values:
             return qs
 
         if self.distinct:
             qs = qs.distinct()
+
+        if value == self.is_empty:
+            return qs.empty_package_url()
+
         return qs.for_package_url(value)

src/packageurl/contrib/django/models.py

@@ -75,6 +75,12 @@ def for_package_url(self, purl_str):
             return self.filter(**lookups)
         return self.none()
 
+    def empty_package_url(self):
+        """
+        Return objects with empty Package URL.
+        """
+        return self.filter(models.Q(type="") | models.Q(name=""))
+
 
 class PackageURLQuerySet(PackageURLQuerySetMixin, models.QuerySet):
     pass