otterapi 0.0.4__tar.gz → 0.0.5__tar.gz

{otterapi-0.0.4 → otterapi-0.0.5}/.gitignore

@@ -818,3 +818,6 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
+
+otter.yaml
+otter.yml

{otterapi-0.0.4 → otterapi-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otterapi
-Version: 0.0.4
+Version: 0.0.5
 Summary: A cute little companion that generates type-safe clients from OpenAPI documents.
 Project-URL: Source, https://github.com/danplischke/otter
 Author: Dan Plischke

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/cli.py

@@ -81,4 +81,4 @@ def version() -> None:
 
 
 if __name__ == '__main__':
-    generate('/Users/PLISCD/Downloads/otterapi.yml')
+    generate()

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/codegen/ast_utils.py

@@ -1,6 +1,9 @@
 import ast
+import keyword
 from collections.abc import Iterable
 
+PYTHON_KEYWORDS = set(keyword.kwlist)
+
 
 def _name(name: str) -> ast.Name:
     return ast.Name(id=name, ctx=ast.Load())

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/codegen/endpoints.py

@@ -244,14 +244,16 @@ def base_async_request_fn():
 
 def get_parameters(
     parameters: list[Parameter],
-) -> tuple[list[ast.arg], list[ast.arg], list[ast.expr]]:
+) -> tuple[list[ast.arg], list[ast.arg], list[ast.expr], dict[str, set[str]]]:
     args = []
     kwonlyargs = []
     kw_defaults = []
     imports = {}
 
     for param in parameters:
-        param_name = param.name
+        if param.name == 'user-id':
+            print()
+        param_name = param.name_sanitized
         param_type = param.type.annotation_ast if param.type else None
         param_required = param.required
 
@@ -294,7 +296,7 @@ def build_header_params(headers: list[Parameter]) -> ast.Dict | None:
 
     return ast.Dict(
         keys=[ast.Constant(value=header.name) for header in headers],
-        values=[_name(header.name) for header in headers],
+        values=[_name(header.name_sanitized) for header in headers],
     )
 
 
@@ -304,7 +306,7 @@ def build_query_params(queries: list[Parameter]) -> ast.Dict | None:
 
     return ast.Dict(
         keys=[ast.Constant(value=query.name) for query in queries],
-        values=[_name(query.name) for query in queries],
+        values=[_name(query.name_sanitized) for query in queries],
     )
 
 
@@ -332,7 +334,7 @@ def build_path_params(
             # Add the formatted value for the parameter
             values.append(
                 ast.FormattedValue(
-                    value=_name(path_param.name),
+                    value=_name(path_param.name_sanitized),
                     conversion=-1,  # No conversion (default)
                 )
             )
@@ -353,7 +355,7 @@ def build_body_params(body: Parameter | None) -> ast.expr | None:
 
     if body.type.type == 'model' or body.type.type == 'root_model':
         return _call(
-            func=_attr(_name(body.name), 'model_dump'),
+            func=_attr(_name(body.name_sanitized), 'model_dump'),
             args=[],
         )
 

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/codegen/generator.py

@@ -16,7 +16,11 @@ from otterapi.codegen.ast_utils import _all, _assign, _call, _name, _union_expr
 from otterapi.codegen.endpoints import async_request_fn, request_fn
 from otterapi.codegen.openapi_processor import OpenAPIProcessor
 from otterapi.codegen.type_generator import Endpoint, Parameter, Type, TypeGen
-from otterapi.codegen.utils import is_url, sanitize_identifier
+from otterapi.codegen.utils import (
+    is_url,
+    sanitize_identifier,
+    sanitize_parameter_field_name,
+)
 from otterapi.config import DocumentConfig
 
 HTTP_METHODS = [method.value.lower() for method in http.HTTPMethod]
@@ -89,6 +93,7 @@ class Codegen(OpenAPIProcessor):
             params.append(
                 Parameter(
                     name=param.name,
+                    name_sanitized=sanitize_parameter_field_name(param.name),
                     location=param.param_in,  # query, path, header, cookie
                     required=param.required or False,
                     type=param_type,
@@ -114,6 +119,7 @@ class Codegen(OpenAPIProcessor):
                         params.append(
                             Parameter(
                                 name='body',
+                                name_sanitized='body',
                                 location='body',
                                 required=body.required or False,
                                 type=body_type,

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/codegen/type_generator.py

@@ -10,7 +10,7 @@ from pydantic import BaseModel, Field, RootModel
 
 from otterapi.codegen.ast_utils import _call, _name, _subscript, _union_expr
 from otterapi.codegen.openapi_processor import OpenAPIProcessor
-from otterapi.codegen.utils import sanitize_identifier
+from otterapi.codegen.utils import sanitize_identifier, sanitize_parameter_field_name
 
 _PRIMITIVE_TYPE_MAP = {
     ('string', None): str,
@@ -126,6 +126,7 @@ class Type:
 @dataclasses.dataclass
 class Parameter:
     name: str
+    name_sanitized: str
     location: str  # query, path, header, cookie, body
     required: bool
     type: Type | None = None
@@ -261,18 +262,38 @@ class TypeGen(OpenAPIProcessor):
         if hasattr(field_schema, 'ref'):
             field_schema, _ = self._resolve_reference(field_schema)
 
+        field_keywords = list()
+
+        sanitized_field_name = sanitize_parameter_field_name(field_name)
+
         value = None
         if field_schema.default is not None and isinstance(
             field_schema.default, (str, int, float, bool)
         ):
-            value = _call(
-                _name(Field.__name__),
-                keywords=[
-                    ast.keyword(arg='default', value=ast.Constant(field_schema.default))
-                ],
+            field_keywords.append(
+                ast.keyword(arg='default', value=ast.Constant(field_schema.default))
             )
         elif field_schema.default is None and not field_schema.required:
-            value = ast.Constant(None)
+            field_keywords.append(ast.keyword(arg='default', value=ast.Constant(None)))
+
+        if sanitized_field_name != field_name:
+            field_keywords.append(
+                ast.keyword(
+                    arg='alias',
+                    value=ast.Constant(field_name),  # original name before adding _
+                )
+            )
+            field_name = sanitized_field_name
+
+        if field_keywords:
+            value = _call(
+                func=_name(Field.__name__),
+                keywords=field_keywords,
+            )
+
+            field_type.add_implementation_import(
+                module=Field.__module__, name=Field.__name__
+            )
 
         return ast.AnnAssign(
             target=_name(field_name),
@@ -498,7 +519,7 @@ class TypeGen(OpenAPIProcessor):
             type_ = self._create_array_type(
                 schema=schema, name=schema_name, base_name=base_name
             )
-        elif schema.type == DataType.OBJECT or schema.type == None:
+        elif schema.type == DataType.OBJECT or schema.type is None:
             type_ = self._create_object_type(
                 schema, name=schema_name, base_name=base_name
             )

{otterapi-0.0.4 → otterapi-0.0.5}/otterapi/codegen/utils.py

@@ -24,6 +24,33 @@ def remove_accents(input_str):
     return ''.join(c for c in nfkd_form if not unicodedata.combining(c))
 
 
+def sanitize_name_python_keywords(name: str) -> str:
+    import keyword
+
+    if name in keyword.kwlist:
+        return f'{name}_'
+    return name
+
+
+def sanitize_parameter_field_name(name: str) -> str:
+    """Sanitize parameter or field names to be valid Python identifiers.
+
+    - Replace spaces and hyphens with underscores
+    - Remove other invalid characters
+    - Ensure it doesn't start with a digit
+    """
+    if not name:
+        raise ValueError('Name cannot be empty')
+
+    sanitized = sanitize_name_python_keywords(name)
+    sanitized = re.sub(r'[-\s]+', '_', remove_accents(sanitized))
+    sanitized = re.sub(r'[^A-Za-z0-9_]', '', sanitized)
+
+    if sanitized and sanitized[0].isdigit():
+        sanitized = '_' + sanitized
+    return sanitized
+
+
 def sanitize_identifier(name: str) -> str:
     """Convert a string into a valid Python identifier.
 

{otterapi-0.0.4 → otterapi-0.0.5}/pyproject.toml

@@ -76,17 +76,17 @@ exclude = [".venv", "venv", "build", "dist", "__pycache__", ".eggs"]
 extend-select = [
     "Q",
     "RUF100",
-    "RUF018", # https://docs.astral.sh/ruff/rules/assignment-in-assert/
-    "C90",
+    "RUF018", # https://docs.astral.sh/ruff/rules/assignment-in-assert,
     "UP",
     "I",
-    "D",
     "TID251",
 ]
 flake8-quotes = { inline-quotes = "single", multiline-quotes = "double" }
 mccabe = { max-complexity = 15 }
 ignore = [
     "D100", # ignore missing docstring in module
+    "D101", # ignore missing in public class TODO: fix later
+    "D103", # ignore missing in public function TODO: fix later
     "D102", # ignore missing docstring in public method
     "D104", # ignore missing docstring in public package
     "D105", # ignore missing docstring in magic methods