Improve and update code style

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

Author: pombredanne

docs/source/conf.py

@@ -34,7 +34,7 @@
     "sphinx_rtd_dark_mode",
     "sphinx.ext.extlinks",
     "sphinx_copybutton",
-
+]
 # Ensure there are no invalid URLs
 # Use -b linkcheck to check integrity of all external links
 nitpicky = True
@@ -77,3 +77,4 @@
 ]
 
 master_doc = "index"
+

pyproject.toml

@@ -124,7 +124,8 @@ select = [
     "I",  # isort
 #    "C9", # McCabe complexity
 ]
-ignore = ["D1", "D200", "D202", "D203", "D205", "D212", "D400", "D415", "I001"]
+ignore = ["D1", "D200", "D202", "D203", "D205", "D212", "D400", "D415", "I001",
+          "D413", "D417"]
 
 
 [tool.ruff.lint.isort]

requirements-dev.txt

@@ -0,0 +1,3 @@
+doc8==1.1.2
+pytest==7.1.1
+pytest-django==4.5.2

requirements.txt

@@ -1,4 +1,4 @@
-aboutcode.pipeline==0.1.0
+aboutcode.pipeline==0.2.1
 aiosignal==1.2.0
 alabaster==0.7.12
 asgiref==3.8.1
@@ -10,7 +10,6 @@ backcall==0.2.0
 bcrypt==3.2.0
 beautifulsoup4==4.10.0
 binaryornot==0.4.4
-black==22.3.0
 bleach==6.1.0
 boolean.py==4.0
 certifi==2024.7.4
@@ -34,7 +33,6 @@ django-filter==24.3
 django-recaptcha==4.0.0
 django-widget-tweaks==1.5.0
 djangorestframework==3.15.2
-doc8==0.11.1
 docopt==0.6.2
 docutils==0.17.1
 drf-spectacular==0.24.2
@@ -51,7 +49,6 @@ imagesize==1.3.0
 importlib-metadata==4.11.3
 iniconfig==1.1.1
 ipython==8.10.0
-isort==5.10.1
 itypes==1.2.0
 jedi==0.18.1
 Jinja2==3.1.6
@@ -80,7 +77,6 @@ psycopg2-binary==2.9.3
 ptyprocess==0.7.0
 pure-eval==0.2.2
 py==1.11.0
-pycodestyle==2.8.0
 pycparser==2.21
 Pygments==2.15.0
 PyNaCl==1.5.0
@@ -100,7 +96,7 @@ six==1.16.0
 smmap==5.0.0
 snowballstemmer==2.2.0
 soupsieve==2.3.2
-Sphinx==4.5.0
+Sphinx==5.02
 sphinxcontrib-applehelp==1.0.2
 sphinx-autobuild==2024.10.3
 sphinxcontrib-devhelp==1.0.2
@@ -110,7 +106,6 @@ sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.3
 sphinxcontrib-serializinghtml==1.1.5
 sphinx-rtd-theme==1.0.0
-sqlparse==0.5.0
 stack-data==0.2.0
 stevedore==3.5.0
 texttable==1.6.4

src/README.rst

@@ -41,7 +41,7 @@ class VulnerabilitySeverityAdmin(admin.ModelAdmin):
 
 class ApiUserCreationForm(forms.ModelForm):
     """
-    This helps have a simplified creation for API-only users in the admin
+    ApiUserCreationForm forms help the simplified creation of API-only users in the admin
     """
 
     class Meta:

tests/README.rst

@@ -288,9 +288,10 @@ def from_dict(cls, affected_pkg: dict):
 @dataclasses.dataclass(order=True)
 class AdvisoryData:
     """
-    This data class expresses the contract between data sources and the import runner.
+    AdvisoryData data class expresses the contract between data sources and the import runner.
 
     If a vulnerability_id is present then:
+
         summary or affected_packages or references must be present
     otherwise
         either affected_package or references should be present
@@ -427,16 +428,15 @@ class OvalImporter(Importer):
     @staticmethod
     def create_purl(pkg_name: str, pkg_data: Mapping) -> PackageURL:
         """
-        Helper method for creating different purls for subclasses without them reimplementing
-        get_data_from_xml_doc  method
-        Note: pkg_data must include 'type' of package
+        Return a purl. Helper method for creating different purls for subclasses without them
+        reimplementing get_data_from_xml_doc  method Note: pkg_data must include 'type' of package
         """
         return PackageURL(name=pkg_name, **pkg_data)
 
     @staticmethod
     def _collect_pkgs(parsed_oval_data: Mapping) -> Set:
         """
-        Helper method, used for loading the API. It expects data from
+        Collect packages. Helper method, used for loading the API. It expects data from
         OvalParser.get_data().
         """
         all_pkgs = set()
@@ -477,14 +477,16 @@ def get_data_from_xml_doc(
         self, xml_doc: ET.ElementTree, pkg_metadata={}
     ) -> Iterable[AdvisoryData]:
         """
+        Return an ietarble of AdvisoryData.
         The orchestration method of the OvalDataSource. This method breaks an
         OVAL xml ElementTree into a list of `Advisory`.
 
         Note: pkg_metadata is a mapping of Package URL data that MUST INCLUDE
         "type" key.
 
         Example value of pkg_metadata:
-                {"type":"deb","qualifiers":{"distro":"buster"} }
+
+        {"type":"deb","qualifiers":{"distro":"buster"} }
         """
         oval_parsed_data = OvalParser(self.translations, xml_doc)
         raw_data = oval_parsed_data.get_data()

vulnerabilities/admin.py

@@ -167,7 +167,7 @@ def get_weaknesses(cve_data):
     Args:
         cve_data (dict): The CVE data in a dictionary format.
 
-    Returns:
+    Return:
         List[int]: A list of unique CWE IDs.
 
     Examples:

vulnerabilities/importer.py

@@ -62,7 +62,7 @@ def parse_advisory_data(raw_data) -> AdvisoryData:
     Args:
         raw_data (dict): Raw JSON data containing advisory information.
 
-    Returns:
+    Return:
         AdvisoryData: Parsed advisory data as an AdvisoryData object.
 
     Example:
@@ -148,12 +148,12 @@ def parse_advisory_data(raw_data) -> AdvisoryData:
 
 def get_cwe_from_curl_advisory(raw_data):
     """
-    Extracts CWE IDs from the given raw_data and returns a list of CWE IDs.
+    Extract CWE IDs from the given raw_data and returns a list of CWE IDs.
 
-        >>> get_cwe_from_curl_advisory({"database_specific": {"CWE": {"id": "CWE-333"}}})
-        [333]
-        >>> get_cwe_from_curl_advisory({"database_specific": {"CWE": {"id": ""}}})
-        []
+    >>> get_cwe_from_curl_advisory({"database_specific": {"CWE": {"id": "CWE-333"}}})
+    [333]
+    >>> get_cwe_from_curl_advisory({"database_specific": {"CWE": {"id": ""}}})
+    []
     """
     weaknesses = []
     db = Database()