#1262 - new safe type for maven namespaces

Author: alitheg

atr/models/api.py

@@ -108,7 +108,7 @@ class DistributionRecordArgs(schema.Strict):
     project: safe.ProjectKey = schema.example("example")
     version: safe.VersionKey = schema.example("0.0.1")
     platform: sql.DistributionPlatform = schema.example(sql.DistributionPlatform.ARTIFACT_HUB)
-    distribution_owner_namespace: safe.Alphanumeric | None = schema.default_example(None, "example")
+    distribution_owner_namespace: safe.OwnerNamespace | None = schema.default_example(None, "example")
     distribution_package: safe.Alphanumeric = schema.example("example")
     distribution_version: safe.VersionKey = schema.example("0.0.1")
     staging: bool = schema.example(False)
@@ -136,7 +136,7 @@ class DistributionRecordFromWorkflowArgs(schema.Strict):
     project: safe.ProjectKey = schema.example("example")
     version: safe.VersionKey = schema.example("0.0.1")
     platform: sql.DistributionPlatform = schema.example(sql.DistributionPlatform.ARTIFACT_HUB)
-    distribution_owner_namespace: safe.Alphanumeric | None = schema.default_example(None, "example")
+    distribution_owner_namespace: safe.OwnerNamespace | None = schema.default_example(None, "example")
     distribution_package: safe.Alphanumeric = schema.example("example")
     distribution_version: safe.VersionKey = schema.example("0.0.1")
     phase: TrustedWorkflowPhase = schema.Field(default="compose", json_schema_extra={"examples": ["compose", "finish"]})
@@ -479,7 +479,7 @@ class PublisherDistributionRecordArgs(schema.Strict):
     jwt: str = schema.example("eyJhbGciOiJIUzI1[...]mMjLiuyu5CSpyHI=")
     version: safe.VersionKey = schema.example("0.0.1")
     platform: sql.DistributionPlatform = schema.example(sql.DistributionPlatform.ARTIFACT_HUB)
-    distribution_owner_namespace: safe.Alphanumeric | None = schema.default_example(None, "example")
+    distribution_owner_namespace: safe.OwnerNamespace | None = schema.default_example(None, "example")
     distribution_package: safe.Alphanumeric = schema.example("example")
     distribution_version: safe.VersionKey = schema.example("0.0.1")
     staging: bool = schema.example(False)

atr/models/distribution.py

@@ -93,7 +93,7 @@ class PyPIResponse(schema.Subset):
 # Including all of the enum properties
 class Data(schema.Subset):
     platform: sql.DistributionPlatform
-    owner_namespace: safe.Alphanumeric | None = None
+    owner_namespace: safe.OwnerNamespace | None = None
     package: safe.Alphanumeric
     version: safe.VersionKey
     details: bool

atr/models/safe.py

@@ -29,6 +29,7 @@
 _ASF_UID_CHARS: Final = frozenset(string.ascii_lowercase + string.digits + "-_")
 _NUMERIC: Final = frozenset(string.digits)
 _PATH_CHARS: Final = frozenset(string.ascii_letters + string.digits + "-._+~/()")
+_OWNER_NAMESPACE_CHARS: Final = _ALPHANUM | frozenset(".")
 _VERSION_CHARS: Final = _ALPHANUM | frozenset(".+")
 
 
@@ -183,6 +184,12 @@ def _valid_chars(cls) -> frozenset[str]:
         return _ALPHANUM
 
 
+class OwnerNamespace(SafeType):
+    @classmethod
+    def _valid_chars(cls) -> frozenset[str]:
+        return _OWNER_NAMESPACE_CHARS
+
+
 class AsfUid(SafeType):
     """An ASF user ID validated to contain only lowercase letters, digits, hyphens, and underscores."""
 
@@ -327,6 +334,11 @@ def _strip_slashes_or_none(v: object) -> object:
     pydantic.BeforeValidator(_strip_slashes_or_none),
 ]
 
+type OptionalOwnerNamespace = Annotated[
+    OwnerNamespace | None,
+    pydantic.BeforeValidator(_strip_slashes_or_none),
+]
+
 type OptionalRelPath = Annotated[
     RelPath | None,
     pydantic.BeforeValidator(_strip_slashes_or_none),

atr/models/sql.py

@@ -1566,7 +1566,7 @@ def distribution_data(self, details: bool = False) -> "distribution.Data":
 
         return distribution.Data(
             platform=self.platform,
-            owner_namespace=safe.Alphanumeric(self.owner_namespace),
+            owner_namespace=safe.OwnerNamespace(self.owner_namespace),
             package=safe.Alphanumeric(self.package),
             version=safe.VersionKey(self.version),
             details=details,

atr/shared/distribution.py

@@ -131,7 +131,7 @@ class DistributionAutomateForm(form.Form):
     platform: form.Enum[DistributionPlatform] = form.label(
         "Platform", widget=form.Widget.SELECT, enum_filter_include=[DistributionPlatform.MAVEN.value]
     )
-    owner_namespace: safe.OptionalAlphanumeric = form.label(
+    owner_namespace: safe.OptionalOwnerNamespace = form.label(
         "Owner or Namespace",
         "Who owns or names the package (Maven groupId, npm @scope, Docker namespace, "
         "GitHub owner, ArtifactHub repo). Leave blank if not used.",
@@ -158,7 +158,7 @@ def validate_owner_namespace(self) -> DistributionAutomateForm:
 
 class DistributionRecordForm(form.Form):
     platform: form.Enum[DistributionPlatform] = form.label("Platform", widget=form.Widget.SELECT)
-    owner_namespace: safe.OptionalAlphanumeric = form.label(
+    owner_namespace: safe.OptionalOwnerNamespace = form.label(
         "Owner or Namespace",
         "Who owns or names the package (Maven groupId, npm @scope, Docker namespace, "
         "GitHub owner, ArtifactHub repo). Leave blank if not used.",

atr/storage/writers/distributions.py

@@ -97,7 +97,7 @@ async def automate(
         release_key: models.safe.ReleaseKey,
         platform: models.sql.DistributionPlatform,
         committee_key: str,
-        owner_namespace: models.safe.Alphanumeric | None,
+        owner_namespace: models.safe.OwnerNamespace | None,
         project_key: models.safe.ProjectKey,
         version_key: models.safe.VersionKey,
         phase: str,
@@ -148,7 +148,7 @@ async def record(
         self,
         release_key: models.safe.ReleaseKey,
         platform: models.sql.DistributionPlatform,
-        owner_namespace: models.safe.Alphanumeric | None,
+        owner_namespace: models.safe.OwnerNamespace | None,
         package: models.safe.Alphanumeric,
         version: models.safe.VersionKey,
         staging: bool,