Sanitize api names

Author: daniel-m-dd

.generator/conftest.py

@@ -337,7 +337,8 @@ def undo_operations():
 def api(context, api_version, specs, name):
     """Return an API instance."""
     assert name in {tag["name"].replace(" ", "") for tag in specs[api_version]["tags"]}
-    context["api_instance"] = {"name": name}
+    sanitized_name = name.replace("-", "")
+    context["api_instance"] = {"name": sanitized_name}
 
 
 @given(parsers.parse('operation "{name}" enabled'))

.generator/src/generator/cli.py

@@ -36,6 +36,7 @@ def cli(specs, output):
     env.filters["parameters"] = openapi.parameters
     env.filters["return_type"] = openapi.return_type
     env.filters["safe_snake_case"] = formatter.safe_snake_case
+    env.filters["class_name"] = formatter.class_name
     env.filters["docstring"] = formatter.docstring
 
     env.globals["enumerate"] = enumerate

.generator/src/generator/formatter.py

@@ -91,6 +91,26 @@ def snake_case(value):
     return PATTERN_DOUBLE_UNDERSCORE.sub("_", s1)
 
 
+def class_name(value):
+    """
+    Convert a string into a valid Python API class name by:
+    1. Removing all non-alphanumeric characters 
+    2. Appending 'Api' suffix
+
+    Args:
+        value (str): The input string to convert
+
+    Returns:
+        str: A valid Python class name ending in 'Api'
+
+    Example:
+        >>> class_name("On-Call")
+        'OnCallApi'
+    """
+    value = re.sub(r'[^a-zA-Z0-9]', '', value)
+    return value + "Api"
+
+
 def safe_snake_case(value):
     for token, replacement in EDGE_CASES.items():
         value = value.replace(token, replacement)

.generator/src/generator/templates/api.j2

@@ -22,7 +22,7 @@ from {{ package }}.model_utils import (
 from {{ package }}.{{ version }}.model.{{ model|safe_snake_case }} import {{ model }}
 {%- endfor %}
 
-{% set classname = name.replace(" ", "") + "Api" %}
+{% set classname = name|class_name %}
 class {{ classname }}:
     """
     {{ description|docstring|indent(4) }}

.generator/src/generator/templates/apis.j2

@@ -1,12 +1,12 @@
 {%- for api in apis %}
-{%- set classname = api.replace(" ", "") + "Api" %}
+{%- set classname = api|class_name %}
 from {{ package }}.{{ version }}.api.{{ classname|safe_snake_case }} import {{ classname }}
 {%- endfor %}
 
 
 __all__ = [
 {%- for api in apis %}
-{%- set classname = api.replace(" ", "") + "Api" %}
+{%- set classname = api|class_name %}
     "{{ classname }}",
 {%- endfor %}
 ]

tests/conftest.py

@@ -383,14 +383,19 @@ def client(configuration):
     with ApiClient(configuration) as api_client:
         yield api_client
 
+def _api_name(value):
+    value = re.sub(r'[^a-zA-Z0-9]', '', value)
+    return value + "Api"
+
+
 
 @given(parsers.parse('an instance of "{name}" API'))
 def api(context, package_name, client, name):
     """Return an API instance."""
     module_name = snake_case(name)
     package = importlib.import_module(f"{package_name}.api.{module_name}_api")
     context["api"] = {
-        "api": getattr(package, name + "Api")(client),
+        "api": getattr(package, _api_name(name))(client),
         "package": package_name,
         "calls": [],
     }
@@ -479,7 +484,7 @@ def wrapper(context, undo):
 
         package = importlib.import_module(f"{package_name}.api.{module_name}_api")
         with ApiClient(configuration) as client:
-            api = getattr(package, name + "Api")(client)
+            api = getattr(package, _api_name(name))(client)
             operation_method = getattr(api, operation_name)
             params_map = getattr(api, f"_{operation_name}_endpoint").params_map
 
@@ -565,7 +570,7 @@ def cleanup(api, version, operation_id, response, request, client=client):
             undo_name = undo_tag.replace(" ", "")
             undo_module_name = snake_case(undo_tag)
             undo_package = importlib.import_module(f"{package_name}.api.{undo_module_name}_api")
-            api = getattr(undo_package, undo_name + "Api")(client)
+            api = getattr(undo_package, _api_name(undo_tag))(client)
 
         operation_name = snake_case(operation["operationId"])
         method = getattr(api, operation_name)