Merge pull request #95 from TG1999/fix_purl_lookups

Fix purl lookups

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.10.2 (2022-09-12)
+-------------------
+
+- Add encode option in purl_lookups #94 
+  (`purl_to_lookups`, `without_empty_values` is moved from packageurl.contrib.django.models
+  to packageurl.contrib.django.utils)
+
 0.10.1 (2022-08-02)
 -------------------
 

src/packageurl/contrib/django/models.py

@@ -24,53 +24,46 @@
 # Visit https://github.com/package-url/packageurl-python for support and
 # download.
 
+import warnings
+
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.translation import gettext_lazy as _
 
 from packageurl import PackageURL
+from packageurl.contrib.django.utils import purl_to_lookups as _purl_to_lookups
+from packageurl.contrib.django.utils import without_empty_values as _without_empty_values
 
 
-def without_empty_values(input_dict):
-    """
-    Return a new dict not including empty value entries from `input_dict`.
-
-    `None`, empty string, empty list, and empty dict/set are cleaned.
-    `0` and `False` values are kept.
-    """
-    empty_values = ([], (), {}, "", None)
-
-    return {key: value for key, value in input_dict.items() if value not in empty_values}
-
-
-def purl_to_lookups(purl):
-    """
-    Return a lookups dict built from the provided `purl` string.
-    Those lookups can be used as QuerySet filters.
-    """
-    if not purl.startswith("pkg:"):
-        purl = "pkg:" + purl
+def purl_to_lookups(purl, encode=True):
+    warnings.warn(
+        "purl_to_lookups is deprecated and will be removed in a future version. "
+        "Use packageurl.contrib.django.utils.purl_to_lookups instead.",
+        DeprecationWarning,
+    )
+    return _purl_to_lookups(purl, encode)
 
-    try:
-        package_url = PackageURL.from_string(purl)
-    except ValueError:
-        return  # Not a valid PackageURL
 
-    package_url_dict = package_url.to_dict(encode=True)
-    return without_empty_values(package_url_dict)
+def without_empty_values(input_dict):
+    warnings.warn(
+        "without_empty_values is deprecated and will be removed in a future version. "
+        "Use packageurl.contrib.django.utils.without_empty_values instead.",
+        DeprecationWarning,
+    )
+    return _without_empty_values(input_dict)
 
 
 class PackageURLQuerySetMixin:
     """
     Add Package URL filtering method to a django.db.models.QuerySet.
     """
 
-    def for_package_url(self, purl_str):
+    def for_package_url(self, purl_str, encode=True):
         """
         Filter the QuerySet with the provided Package URL string.
         The purl string is validated and transformed into filtering lookups.
         """
-        lookups = purl_to_lookups(purl_str)
+        lookups = purl_to_lookups(purl_str=purl_str, encode=encode)
         if lookups:
             return self.filter(**lookups)
         return self.none()
@@ -150,7 +143,12 @@ def package_url(self):
         """
         try:
             purl = PackageURL(
-                self.type, self.namespace, self.name, self.version, self.qualifiers, self.subpath
+                self.type,
+                self.namespace,
+                self.name,
+                self.version,
+                self.qualifiers,
+                self.subpath,
             )
         except ValueError:
             return ""

src/packageurl/contrib/django/utils.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) the purl authors
+# SPDX-License-Identifier: MIT
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Visit https://github.com/package-url/packageurl-python for support and
+# download.
+
+
+from packageurl import PackageURL
+
+
+def purl_to_lookups(purl, encode=True):
+    """
+    Return a lookups dict built from the provided `purl` string.
+    Those lookups can be used as QuerySet filters.
+    """
+    if not purl.startswith("pkg:"):
+        purl = "pkg:" + purl
+
+    try:
+        package_url = PackageURL.from_string(purl)
+    except ValueError:
+        return  # Not a valid PackageURL
+
+    package_url_dict = package_url.to_dict(encode=encode)
+    return without_empty_values(package_url_dict)
+
+
+def without_empty_values(input_dict):
+    """
+    Return a new dict not including empty value entries from `input_dict`.
+
+    `None`, empty string, empty list, and empty dict/set are cleaned.
+    `0` and `False` values are kept.
+    """
+    empty_values = ([], (), {}, "", None)
+
+    return {key: value for key, value in input_dict.items() if value not in empty_values}

tests/contrib/test_utils.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) the purl authors
+# SPDX-License-Identifier: MIT
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Visit https://github.com/package-url/packageurl-python for support and
+# download.
+
+from packageurl.contrib.django.utils import purl_to_lookups
+
+
+def test_purl_to_lookups_without_encode():
+    assert purl_to_lookups(
+        "pkg:alpine/openssl@0?arch=aarch64&distroversion=edge&reponame=main",
+        encode=False,
+    ) == {
+        "type": "alpine",
+        "name": "openssl",
+        "version": "0",
+        "qualifiers": {
+            "arch": "aarch64",
+            "distroversion": "edge",
+            "reponame": "main",
+        },
+    }
+
+
+def test_purl_to_lookups_with_encode():
+    assert purl_to_lookups(
+        "pkg:alpine/openssl@0?arch=aarch64&distroversion=edge&reponame=main",
+        encode=True,
+    ) == {
+        "type": "alpine",
+        "name": "openssl",
+        "version": "0",
+        "qualifiers": "arch=aarch64&distroversion=edge&reponame=main",
+    }