feat: PEP 794 support (#271)

Author: henryiii

src/validate_pyproject/extra_validations.py

@@ -3,8 +3,10 @@
 JSON Schema library).
 """
 
+import collections
+import itertools
 from inspect import cleandoc
-from typing import Mapping, TypeVar
+from typing import Generator, Iterable, Mapping, TypeVar
 
 from .error_reporting import ValidationError
 
@@ -30,6 +32,24 @@ class IncludedDependencyGroupMustExist(ValidationError):
     _URL = "https://peps.python.org/pep-0735/"
 
 
+class ImportNameCollision(ValidationError):
+    _DESC = """According to PEP 794:
+
+    All import-names and import-namespaces items must be unique.
+    """
+    __doc__ = _DESC
+    _URL = "https://peps.python.org/pep-0794/"
+
+
+class ImportNameMissing(ValidationError):
+    _DESC = """According to PEP 794:
+
+    An import name must have all parents listed.
+    """
+    __doc__ = _DESC
+    _URL = "https://peps.python.org/pep-0794/"
+
+
 def validate_project_dynamic(pyproject: T) -> T:
     project_table = pyproject.get("project", {})
     dynamic = project_table.get("dynamic", [])
@@ -78,4 +98,54 @@ def validate_include_depenency(pyproject: T) -> T:
     return pyproject
 
 
-EXTRA_VALIDATIONS = (validate_project_dynamic, validate_include_depenency)
+def _remove_private(items: Iterable[str]) -> Generator[str, None, None]:
+    for item in items:
+        yield item.partition(";")[0].rstrip()
+
+
+def validate_import_name_issues(pyproject: T) -> T:
+    project = pyproject.get("project", {})
+    import_names = collections.Counter(_remove_private(project.get("import-names", [])))
+    import_namespaces = collections.Counter(
+        _remove_private(project.get("import-namespaces", []))
+    )
+
+    duplicated = [k for k, v in (import_names + import_namespaces).items() if v > 1]
+
+    if duplicated:
+        raise ImportNameCollision(
+            message="Duplicated names are not allowed in import-names/import-namespaces",
+            value=duplicated,
+            name="data.project.importnames(paces)",
+            definition={
+                "description": cleandoc(ImportNameCollision._DESC),
+                "see": ImportNameCollision._URL,
+            },
+            rule="PEP 794",
+        )
+
+    names = frozenset(import_names + import_namespaces)
+    for name in names:
+        for parent in itertools.accumulate(
+            name.split(".")[:-1], lambda a, b: f"{a}.{b}"
+        ):
+            if parent not in names:
+                raise ImportNameMissing(
+                    message="All parents of an import name must also be listed in import-namespace/import-names",
+                    value=name,
+                    name="data.project.importnames(paces)",
+                    definition={
+                        "description": cleandoc(ImportNameMissing._DESC),
+                        "see": ImportNameMissing._URL,
+                    },
+                    rule="PEP 794",
+                )
+
+    return pyproject
+
+
+EXTRA_VALIDATIONS = (
+    validate_project_dynamic,
+    validate_include_depenency,
+    validate_import_name_issues,
+)

src/validate_pyproject/formats.py

@@ -8,6 +8,7 @@
 """
 
 import builtins
+import keyword
 import logging
 import os
 import re
@@ -400,3 +401,27 @@ def SPDX(value: str) -> bool:
 
     def SPDX(value: str) -> bool:
         return True
+
+
+VALID_IMPORT_NAME = re.compile(
+    r"""
+    ^                                  # start of string
+        [A-Za-z_][A-Za-z_0-9]+         # a valid Python identifier
+        (?:\.[A-Za-z_][A-Za-z_0-9]*)*  # optionally followed by .identifier's
+    (?:\s*;\s*private)?                # optionally followed by ; private
+    $                                  # end of string
+    """,
+    re.VERBOSE,
+)
+
+
+def import_name(value: str) -> bool:
+    """This is a valid import name. It has to be series of python identifiers
+    (not keywords), separated by dots, optionally followed by a semicolon and
+    the keyword "private".
+    """
+    if VALID_IMPORT_NAME.match(value) is None:
+        return False
+
+    idents, _, _ = value.partition(";")
+    return all(not keyword.iskeyword(ident) for ident in idents.rstrip().split("."))

src/validate_pyproject/project_metadata.schema.json

@@ -233,6 +233,22 @@
         }
       }
     },
+    "import-names": {
+      "description": "Lists import names which a project, when installed, would exclusively provide.",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "import-name"
+      }
+    },
+    "import-namespaces": {
+      "description": "Lists import names that, when installed, would be provided by the project, but not exclusively.",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "import-name"
+      }
+    },
     "dynamic": {
       "type": "array",
       "$$description": [
@@ -256,7 +272,9 @@
           "gui-scripts",
           "entry-points",
           "dependencies",
-          "optional-dependencies"
+          "optional-dependencies",
+          "import-names",
+          "import-namespaces"
         ]
       }
     }

tests/examples/pdm/pyproject.toml

@@ -11,6 +11,8 @@ requires-python = ">=3.9"
 readme = "README.md"
 keywords = ["packaging", "PEP 517", "build"]
 dynamic = ["version"]
+import-names = ["pdm.backend"]
+import-namespaces = ["pdm"]
 
 classifiers = [
     "Development Status :: 5 - Production/Stable",

tests/examples/simple/import_names.toml

@@ -0,0 +1,5 @@
+[project]
+name = "hi"
+version = "1.0.0"
+import-names = ["one", "one.two", "two; private"]
+import-namespaces = ["_other ; private"]

tests/examples/trampolim/pyproject.toml

@@ -23,7 +23,7 @@ classifiers = [
   'Development Status :: 4 - Beta',
   'Programming Language :: Python'
 ]
-
+import-namespaces = ["trampolim"]
 dependencies = [
   'tomli>=1.0.0',
   'packaging',

tests/invalid-examples/simple/pep794-dup.errors.txt

@@ -0,0 +1 @@
+Duplicated names are not allowed in import-names/import-namespaces

tests/invalid-examples/simple/pep794-dup.toml

@@ -0,0 +1,5 @@
+[project]
+name = "hi"
+version = "1.0.0"
+import-names = ["one"]
+import-namespaces = ["one; private"]

tests/invalid-examples/simple/pep794-keyword.errors.txt

@@ -0,0 +1 @@
+project.import-namespaces[0]` must be import-name

tests/invalid-examples/simple/pep794-keyword.toml

@@ -0,0 +1,4 @@
+[project]
+name = "hi"
+version = "1.0.0"
+import-namespaces = ["class"]