geniespec 0.1.2.dev4__tar.gz → 0.1.2.dev5__tar.gz

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geniespec
-Version: 0.1.2.dev4
+Version: 0.1.2.dev5
 Summary: Generate API code from an api.yaml spec
 License-Expression: MIT
 Requires-Dist: jinja2>=3.1.6
@@ -68,6 +68,8 @@ resources:
 
 Fields use it like any other type (`type: ViewContent`, also inside `List` and `Mapping`). `python-server` generates a `ViewContentV1` pydantic discriminated union in `resources`; `typescript-client` generates a `ViewContentV1` union type and a `viewContentV1FromObject` function that builds the member class named by the discriminator (and throws for unknown values).
 
+`type: Uuid` is a string that must be a valid UUID. It works anywhere `String` does, including as a primary attribute in paths. `python-server` types it as `uuid.UUID`, so pydantic rejects other strings with a 400, internal methods get `uuid.UUID` objects and responses write them in the standard lowercase hyphenated form; `typescript-client` types it as `string`.
+
 ## Rate limits
 
 Name rate limits at the top level, then pick one per transition with `rateLimit`. `defaultRateLimit` applies to every transition that doesn't set one, and `rateLimit: none` turns it off for a transition, the same way `defaultAuthentication` and `authentication` work:

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/README.md

@@ -54,6 +54,8 @@ resources:
 
 Fields use it like any other type (`type: ViewContent`, also inside `List` and `Mapping`). `python-server` generates a `ViewContentV1` pydantic discriminated union in `resources`; `typescript-client` generates a `ViewContentV1` union type and a `viewContentV1FromObject` function that builds the member class named by the discriminator (and throws for unknown values).
 
+`type: Uuid` is a string that must be a valid UUID. It works anywhere `String` does, including as a primary attribute in paths. `python-server` types it as `uuid.UUID`, so pydantic rejects other strings with a 400, internal methods get `uuid.UUID` objects and responses write them in the standard lowercase hyphenated form; `typescript-client` types it as `string`.
+
 ## Rate limits
 
 Name rate limits at the top level, then pick one per transition with `rateLimit`. `defaultRateLimit` applies to every transition that doesn't set one, and `rateLimit: none` turns it off for a transition, the same way `defaultAuthentication` and `authentication` work:

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev4"
+version = "0.1.2.dev5"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev4"
+version = "0.1.2.dev5"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/api_schema.yaml

@@ -48,7 +48,7 @@ properties:
     type:
       - "null"
       - string
-    pattern: '^[a-z][a-z0-9-]*$'
+    pattern: '^[a-z][a-z0-9_-]*$'
   rateLimits:
     type: array
     items:
@@ -230,7 +230,7 @@ definitions:
         type:
           - "null"
           - string
-        pattern: '^[a-z][a-z0-9-]*$'
+        pattern: '^[a-z][a-z0-9_-]*$'
       rateLimit:
         type:
           - "null"
@@ -266,7 +266,7 @@ definitions:
         type:
           - "null"
           - string
-        pattern: '^[a-z][a-z0-9-]*$'
+        pattern: '^[a-z][a-z0-9_-]*$'
       rateLimit:
         type:
           - "null"

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/languages.py

@@ -73,6 +73,9 @@ class BaseLanguageDefinition:
     def string_type(self, isNullable: bool) -> str:
         raise NotImplementedError
 
+    def uuid_type(self, isNullable: bool) -> str:
+        raise NotImplementedError
+
     def enum_type(self, isNullable: bool, renderableType: RenderableType, apiVersion: Version, isLocalReference: bool) -> str:
         raise NotImplementedError
 
@@ -110,6 +113,8 @@ class BaseLanguageDefinition:
             return self.double_type(isNullable=isNullable)
         if yamlType == PrimitiveTypes.STRING:
             return self.string_type(isNullable=isNullable)
+        if yamlType == PrimitiveTypes.UUID:
+            return self.uuid_type(isNullable=isNullable)
         if yamlType == PrimitiveTypes.BOOLEAN:
             return self.boolean_type(isNullable=isNullable)
         if yamlType == PrimitiveTypes.DATETIME:
@@ -227,9 +232,9 @@ class BaseLanguageDefinition:
                 return output
             if component.attribute.isUnique and not component.attribute.isPrimary:
                 output.append(self.kebab_name(name=component.attribute.name))
-            if component.attribute.fieldType.rawType not in (PrimitiveTypes.INTEGER, PrimitiveTypes.LONG_INTEGER, PrimitiveTypes.STRING):
-                raise KibaException(message=f'ResourceEndpointComponent created with an invalid attribute type of {component.attribute.fieldType}. Valid types are: integer, long integer and string.')
-            output.append(self.path_parameter_segment(parameterName=self.identifier(name=component.attribute.name), isInteger=component.attribute.fieldType.rawType != PrimitiveTypes.STRING))
+            if component.attribute.fieldType.rawType not in (PrimitiveTypes.INTEGER, PrimitiveTypes.LONG_INTEGER, PrimitiveTypes.STRING, PrimitiveTypes.UUID):
+                raise KibaException(message=f'ResourceEndpointComponent created with an invalid attribute type of {component.attribute.fieldType}. Valid types are: integer, long integer, string and uuid.')
+            output.append(self.path_parameter_segment(parameterName=self.identifier(name=component.attribute.name), isInteger=component.attribute.fieldType.rawType in (PrimitiveTypes.INTEGER, PrimitiveTypes.LONG_INTEGER)))
             return output
         raise KibaException(message=f'Unsupported endpoint component: {type(component)}')
 
@@ -343,6 +348,9 @@ class PythonLanguageDefinition(BaseLanguageDefinition):
     def string_type(self, isNullable: bool) -> str:
         return 'str | None' if isNullable else 'str'
 
+    def uuid_type(self, isNullable: bool) -> str:
+        return 'uuid.UUID | None' if isNullable else 'uuid.UUID'
+
     def enum_type(self, isNullable: bool, renderableType: RenderableType, apiVersion: Version, isLocalReference: bool) -> str:
         if renderableType.className is None:
             typeName = self.enum_literal(values=renderableType.enumValues)
@@ -423,6 +431,18 @@ class PythonLanguageDefinition(BaseLanguageDefinition):
             return PythonLanguageDefinition._contains_json(renderableType=renderableType.keyType) or PythonLanguageDefinition._contains_json(renderableType=renderableType.valueType)
         return renderableType.rawType == PrimitiveTypes.JSON
 
+    @staticmethod
+    def _contains_uuid(renderableType: RenderableType) -> bool:
+        if isinstance(renderableType, MappingRenderableType):
+            return PythonLanguageDefinition._contains_uuid(renderableType=renderableType.keyType) or PythonLanguageDefinition._contains_uuid(renderableType=renderableType.valueType)
+        return renderableType.rawType == PrimitiveTypes.UUID
+
+    def requires_uuid(self, api: RenderableApi) -> bool:
+        fieldTypes = [attribute.fieldType for resource in api.resources for attribute in [*resource.attributes, *resource.independentAttributes]]
+        fieldTypes += [parameter.fieldType for operation in api.operations for parameter in operation.parameters] + [field.fieldType for operation in api.operations for field in operation.responseFields or []]
+        fieldTypes += [field.fieldType for exception in api.exceptions for field in exception.fields]
+        return any(self._contains_uuid(renderableType=fieldType) for fieldType in fieldTypes)
+
     def resources_require_json(self, api: RenderableApi) -> bool:
         return any(self._contains_json(renderableType=attribute.fieldType) for resource in api.resources for attribute in resource.attributes)
 
@@ -562,6 +582,9 @@ class TypeScriptLanguageDefinition(BaseLanguageDefinition):
     def string_type(self, isNullable: bool) -> str:
         return self._nullable(typeName='string', isNullable=isNullable)
 
+    def uuid_type(self, isNullable: bool) -> str:
+        return self._nullable(typeName='string', isNullable=isNullable)
+
     def enum_type(self, isNullable: bool, renderableType: RenderableType, apiVersion: Version, isLocalReference: bool) -> str:
         if renderableType.className is None:
             return self._nullable(typeName=f'({self.enum_union(values=renderableType.enumValues)})', isNullable=isNullable)
@@ -680,7 +703,7 @@ class TypeScriptLanguageDefinition(BaseLanguageDefinition):
             return f'{parserName if isLocalReference else f"Resources.{parserName}"}({value} as RawObject)'
         if renderableType.rawType == 'class' and renderableType.className is not None:
             return f'{self.type(renderableType=renderableType, apiVersion=apiVersion, isLocalReference=isLocalReference)}.fromObject({value} as RawObject)'
-        if renderableType.rawType == PrimitiveTypes.STRING:
+        if renderableType.rawType in (PrimitiveTypes.STRING, PrimitiveTypes.UUID):
             return f'String({value})'
         if renderableType.rawType in (PrimitiveTypes.INTEGER, PrimitiveTypes.LONG_INTEGER, PrimitiveTypes.FLOAT, PrimitiveTypes.DOUBLE):
             return f'Number({value})'

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/templates/python-server/{service}/v{version}/endpoints.py.j2

@@ -4,6 +4,9 @@ import datetime
 {% if target.requires_optional_field_default(api=api) or target.operations_require_typing(api=api) %}
 import typing
 {% endif %}
+{% if target.requires_uuid(api=api) %}
+import uuid
+{% endif %}
 
 {% if target.operations_require_json(api=api) %}
 import pydantic

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/templates/python-server/{service}/v{version}/exceptions.py.j2

@@ -2,6 +2,9 @@
 from __future__ import annotations
 import collections.abc
 import typing
+{% if target.requires_uuid(api=api) %}
+import uuid
+{% endif %}
 {% if target.exceptions_require_json(api=api) %}
 import pydantic
 {% endif %}

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/templates/python-server/{service}/v{version}/internal.py.j2

@@ -5,6 +5,9 @@ import collections.abc
 {% if target.operations_require_typing(api=api) %}
 import typing
 {% endif %}
+{% if target.requires_uuid(api=api) %}
+import uuid
+{% endif %}
 
 {% if target.operations_require_json(api=api) %}
 import pydantic

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/templates/python-server/{service}/v{version}/resources.py.j2

@@ -6,6 +6,9 @@ import datetime
 {% if target.resources_require_typing(api=api) %}
 import typing
 {% endif %}
+{% if target.requires_uuid(api=api) %}
+import uuid
+{% endif %}
 
 {% if target.resources_require_json(api=api) or api.oneOfs %}
 import pydantic

{geniespec-0.1.2.dev4 → geniespec-0.1.2.dev5}/src/geniespec/types.py

@@ -12,11 +12,12 @@ class PrimitiveTypes:
     FLOAT = 'Float'
     DOUBLE = 'Double'
     STRING = 'String'
+    UUID = 'Uuid'
     BOOLEAN = 'Boolean'
     DATETIME = 'Datetime'
     DATE = 'Date'
     JSON = 'Json'
-    ALL: ClassVar[list[str]] = [LONG_INTEGER, INTEGER, FLOAT, DOUBLE, STRING, BOOLEAN, DATETIME, DATE, JSON]
+    ALL: ClassVar[list[str]] = [LONG_INTEGER, INTEGER, FLOAT, DOUBLE, STRING, UUID, BOOLEAN, DATETIME, DATE, JSON]
 
 
 class FieldSources: