Create public purl-validate UI #535

johnmhoran · 2024-09-03T23:46:35Z

Reference: #522

This preserves the initial demo version. Next: begin to implement latest feedback.

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

johnmhoran · 2024-10-01T03:54:53Z

@JonoYang I've run make valid and manually fixed several docstrings but yet again I get a GitHub check style failure, this time with no hint at how to correct and on code I did not add. A mystery.

JonoYang · 2024-10-01T16:57:50Z

@JonoYang I've run make valid and manually fixed several docstrings but yet again I get a GitHub check style failure, this time with no hint at how to correct and on code I did not add. A mystery.

In the CI output:

========================== Starting Command Output ===========================
/usr/bin/bash --noprofile --norc /home/vsts/work/_temp/f912951e-9d1e-41ba-8b0d-217e1a2dd861.sh
-> Run Ruff linter validation (pycodestyle, bandit, isort, and more)
packagedb/models.py:10:1: I001 [*] Import block is un-sorted or un-formatted
...

It's complaining that the import statements in packagedb/models.py are not sorted. You can run make valid to fix this

johnmhoran · 2024-10-01T17:05:07Z

@JonoYang Well, as I noted, I ran make valid before my last commit and push, so not clear why rerunning would help but I'll try that. What about make check? The RTD says nothing about make check but in the Makefile check refers inter alia to isort while valid does not. I will also run make check and see what happens.

johnmhoran · 2024-10-01T17:08:59Z

Rerunning make valid again made one sorting change, no idea why this was not corrected by the initial make valid run, so before running make check I'll commit and push and see if that satisfies the CI checks.

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

johnmhoran · 2024-10-01T17:28:43Z

. . . and all checks have now passed.

JonoYang

@johnmhoran Thanks for the PR! I've made a pass on the Python code portion.

JonoYang · 2024-10-14T17:33:03Z

packagedb/models.py

+            return serializer.data
+
+        qs = qs.filter(
+            models.Q(namespace=package_url.namespace)


I would move these if-else statements into their own variables for clarity.

JonoYang · 2024-10-14T17:34:22Z

packagedb/models.py

+        if print_to_console:
+            print(f"\nmodels.py PackageQuerySet search() qs.query = {qs.query}")
+            print(f"\nlist(qs): {list(qs)}")
+            for abc in list(qs):


I would use a variable name that describes what's in qs.

JonoYang · 2024-10-14T17:40:26Z

packagedb/models.py

+
+        return qs
+
+    def get_packageurl_from_string(self, query: str = None):


Is this method being used anywhere?

JonoYang · 2024-10-14T18:17:18Z

packagedb/models.py

@@ -81,6 +87,105 @@ def paginated(self, per_page=5000):
            page = paginator.page(page_number)
            yield from page.object_list

+    # Based on class PurlValidateResponseSerializer(Serializer).  Added here because when added to serializers.py and imported raises a circular import error.


Does this mean that the circular import happens when you add this code to serializers.py and then try to import it from somewhere like views.py?

@JonoYang Glad you asked about the custom serializer I created inside models.py.

This means that when I initially defined that new serializer in packagedb/serializers.py and tried to import it into models.py, where I am using the local one now, I got the circular import error. Maybe I don't need a serializer here?

I modeled my approach on what we do in the api.py PurlValidateViewSet() class with the PurlValidateResponseSerializer we import from packagedb.serializers. Essentially I'm trying to mimic in my purl-validate UI the dictionary that our validate endpoint returns -- 4 fields, and I added one or two more for my UI validation messaging (preventing an exception from being raised and interrupting the process). packagedb/serializers.py has numerous imports from packagedb/models, so that's the source of the circular import issue.

@JonoYang You can see the similar code structure I used and the validate endpoint used to handle an exception:

validate endpoint in api.py:

purl-validate UI in models.py:

JonoYang · 2024-10-14T18:18:15Z

packagedb/views.py

+        print(f"\nviews.py parse_purl() query = {query}")
+
+    purl_error_message = ""
+    purl_pkg_scheme_component = "AAA"


you can leave these as empty strings

JonoYang · 2024-10-14T18:20:26Z

packagedb/views.py

+            print(f"ValueError = {ValueError(msg)}")
+
+    # ==> namespace component ===
+    namespace_01 = ""


Avoid using numbers in variable names

JonoYang · 2024-10-14T18:29:46Z

packagedb/views.py

+            purl_error_message = "The input purl is valid."
+
+    # ==> type component ===
+    purl_type = "MISSING"


I feel like you can leave these as empty strings and then check if they exist using if purl_type or if not purl_type

johnmhoran added 5 commits September 3, 2024 16:24

Preserve initial demo version #522

e738b0e

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

Fix formatting #522

fc20a4f

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

Refactor initial UI and clean code #522

e680f5e

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

Run 'make valid' #522

7cbcc75

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

Fix docstrings 522

a4d18ca

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

Rerun 'make valid' #522

f5451a1

Reference: #522 Signed-off-by: John M. Horan <[email protected]>

JonoYang requested changes Oct 14, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create public purl-validate UI #535

Create public purl-validate UI #535

johnmhoran commented Sep 3, 2024

johnmhoran commented Oct 1, 2024

JonoYang commented Oct 1, 2024

johnmhoran commented Oct 1, 2024

johnmhoran commented Oct 1, 2024

johnmhoran commented Oct 1, 2024 •

edited

Loading

JonoYang left a comment

JonoYang Oct 14, 2024

JonoYang Oct 14, 2024

JonoYang Oct 14, 2024

JonoYang Oct 14, 2024

johnmhoran Oct 16, 2024

johnmhoran Oct 16, 2024

JonoYang Oct 14, 2024

JonoYang Oct 14, 2024

JonoYang Oct 14, 2024


		return qs

		def get_packageurl_from_string(self, query: str = None):

Create public purl-validate UI #535

Are you sure you want to change the base?

Create public purl-validate UI #535

Conversation

johnmhoran commented Sep 3, 2024

johnmhoran commented Oct 1, 2024

JonoYang commented Oct 1, 2024

johnmhoran commented Oct 1, 2024

johnmhoran commented Oct 1, 2024

johnmhoran commented Oct 1, 2024 • edited Loading

JonoYang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnmhoran commented Oct 1, 2024 •

edited

Loading