Add custom_get_name config option

.gitignore

@@ -7,3 +7,4 @@ __pycache__
 /dist
 /.github/changelog-generator-cache
 /tests/recursion.py
+/.vscode

jsonschema_gentypes/api.py

@@ -53,12 +53,14 @@ def __init__(
         self,
         resolver: RefResolver,
         additional_properties: configuration.AdditionalProperties = configuration.ADDITIONALPROPERTIES_ONLY_EXPLICIT,
+        custom_get_name: Optional[configuration.GetNameFunction] = None,
     ) -> None:
         """
         Initialize with a resolver.
         """
         self.resolver = resolver
         self.additional_properties = additional_properties
+        self.custom_get_name: Optional[configuration.GetNameFunction] = custom_get_name
         # types by reference
         self.ref_type: dict[str, Type] = {}
         self.root: Optional[TypeProxy] = None
@@ -170,13 +172,15 @@ def get_type(
             if description:
                 if not isinstance(the_type, NamedType):
                     if auto_alias:
-                        the_type = TypeAlias(get_name(schema_meta_data, proposed_name), the_type, description)
+                        the_type = TypeAlias(
+                            self.get_name(schema_meta_data, proposed_name), the_type, description
+                        )
                 the_type.set_comments(description)
 
         if "default" in schema_meta_data:
             the_type.add_depends_on(
                 Constant(
-                    f"{get_name(schema_meta_data, proposed_name, True)}_DEFAULT",
+                    f"{self.get_name(schema_meta_data, proposed_name, True)}_DEFAULT",
                     schema_meta_data["default"],
                     [f"Default value of the field path '{proposed_name}'"],
                 )
@@ -191,6 +195,22 @@ def get_type(
 
         return the_type
 
+    def get_name(
+        self,
+        schema: Optional[
+            Union[
+                jsonschema_draft_04.JSONSchemaD4,
+                jsonschema_draft_2019_09_meta_data.JSONSchemaItemD2019,
+            ]
+        ],
+        proposed_name: Optional[str] = None,
+        upper: bool = False,
+    ) -> str:
+        if self.custom_get_name:
+            return self.custom_get_name(schema, proposed_name, upper)
+        else:
+            return get_name(schema, proposed_name, upper)
+
     def resolve_ref(
         self,
         schema: Union[
@@ -342,7 +362,7 @@ def build_type(
                 "anyof",
             )
             if not isinstance(type_, NamedType):
-                type_ = TypeAlias(get_name(schema_meta_data, proposed_name), type_)
+                type_ = TypeAlias(self.get_name(schema_meta_data, proposed_name), type_)
             elif type_.comments():
                 type_.comments().append("")
             type_.comments().append("Aggregation type: anyOf")
@@ -394,7 +414,7 @@ def build_type(
             if len(schema_type) == 0:
                 return BuiltinType("None")
             inner_types = []
-            name = get_name(schema_meta_data, proposed_name)
+            name = self.get_name(schema_meta_data, proposed_name)
             has_title = "title" in schema_meta_data
             proposed_name = schema_meta_data.get("title", proposed_name)
 

jsonschema_gentypes/api_draft_04.py

@@ -55,7 +55,7 @@ def enum(
         )
 
         return TypeEnum(
-            get_name(schema_meta_data, proposed_name),
+            self.get_name(schema_meta_data, proposed_name),
             cast(list[Union[int, float, bool, str, None]], schema["enum"]),
             get_description(schema_meta_data),
         )
@@ -99,7 +99,7 @@ def object(
         )
 
         std_dict = None
-        name = get_name(schema_meta_data, proposed_name)
+        name = self.get_name(schema_meta_data, proposed_name)
         schema.setdefault("used", set()).add("additionalProperties")  # type: ignore[typeddict-item]
         additional_properties = cast(
             Union[jsonschema_draft_04.JSONSchemaD4, jsonschema_draft_2020_12_applicator.JSONSchemaD2020],
@@ -294,7 +294,9 @@ def any_of(
                     )
                     if not isinstance(type_, NamedType):
                         type_ = TypeAlias(
-                            get_name(combined_schema_meta_data, proposed_name + " " + sub_name), type_, []
+                            self.get_name(combined_schema_meta_data, proposed_name + " " + sub_name),
+                            type_,
+                            [],
                         )
 
                     additional_types.append(type_)
@@ -326,7 +328,9 @@ def any_of(
                     )
                     if not isinstance(type_, NamedType):
                         type_ = TypeAlias(
-                            get_name(combined_schema_meta_data, proposed_name + " " + sub_name), type_, []
+                            self.get_name(combined_schema_meta_data, proposed_name + " " + sub_name),
+                            type_,
+                            [],
                         )
                     additional_types.append(type_)
                 inner_types.append(type_)
@@ -495,7 +499,7 @@ def all_of(
                     )
                     if not isinstance(type_, NamedType):
                         type_ = TypeAlias(
-                            get_name(combined_schema_meta_data, f"{proposed_name} {sub_name}{index}"),
+                            self.get_name(combined_schema_meta_data, f"{proposed_name} {sub_name}{index}"),
                             type_,
                             [],
                         )
@@ -522,7 +526,7 @@ def all_of(
                     )
                     if not isinstance(type_, NamedType):
                         type_ = TypeAlias(
-                            get_name(combined_schema_meta_data, f"{proposed_name} {sub_name}{index}"),
+                            self.get_name(combined_schema_meta_data, f"{proposed_name} {sub_name}{index}"),
                             type_,
                             [],
                         )

jsonschema_gentypes/configuration.py

@@ -2,10 +2,12 @@
 Automatically generated file from a JSON schema.
 """
 
-from typing import Any, Literal, TypedDict, Union
+from typing import Any, Callable, Literal, Optional, TypedDict, Union
 
 from typing_extensions import Required
 
+from jsonschema_gentypes import jsonschema_draft_04, jsonschema_draft_2019_09_meta_data
+
 AdditionalProperties = Union[Literal["Always"], Literal["Only explicit"]]
 """
 Additional properties.
@@ -18,6 +20,21 @@
 """The values for the 'Additional properties' enum"""
 
 
+GetNameFunction = Callable[
+    [
+        Optional[
+            Union[
+                jsonschema_draft_04.JSONSchemaD4,
+                jsonschema_draft_2019_09_meta_data.JSONSchemaItemD2019,
+            ]
+        ],
+        Optional[str],
+        bool,
+    ],
+    str,
+]
+
+
 class ApiArguments(TypedDict, total=False):
     """
     API arguments.
@@ -26,6 +43,7 @@ class ApiArguments(TypedDict, total=False):
     """
 
     additional_properties: "AdditionalProperties"
+    custom_get_name: GetNameFunction
     """
     Additional properties.
 

tests/custom_get_name.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "definitions": {
+    "SubresourceUris": {
+      "type": "object",
+      "properties": {
+        "feedback": {
+          "type": "string"
+        }
+      },
+      "required": ["feedback"],
+      "title": "SubresourceUris"
+    }
+  },
+  "type": "object",
+  "properties": {
+    "subresource_uris": {
+      "$ref": "#/definitions/SubresourceUris"
+    }
+  },
+  "required": ["subresource_uris"],
+  "title": "ResponseType"
+}

tests/custom_get_name.py

@@ -0,0 +1,21 @@
+from typing import TypedDict
+
+from typing_extensions import Required
+
+
+class ResponseType(TypedDict, total=False):
+    """ResponseType."""
+
+    subresource_uris: Required["SubresourceUris"]
+    """
+    SubresourceUris.
+
+    Required property
+    """
+
+
+class SubresourceUris(TypedDict, total=False):
+    """SubresourceUris."""
+
+    feedback: Required[str]
+    """ Required property """

tests/test_custom_get_name.py

@@ -0,0 +1,78 @@
+from typing import Callable, Optional, Union
+
+from jsonschema_gentypes import jsonschema_draft_04, jsonschema_draft_2019_09_meta_data, normalize
+from jsonschema_gentypes.cli import process_config
+from jsonschema_gentypes.configuration import Configuration
+
+GetNameFunction = Callable[
+    [
+        Optional[
+            Union[
+                jsonschema_draft_04.JSONSchemaD4,
+                jsonschema_draft_2019_09_meta_data.JSONSchemaItemD2019,
+            ]
+        ],
+        Optional[str],
+        bool,
+    ],
+    str,
+]
+
+
+def custom_get_name(
+    schema: Optional[
+        Union[
+            jsonschema_draft_04.JSONSchemaD4,
+            jsonschema_draft_2019_09_meta_data.JSONSchemaItemD2019,
+        ]
+    ],
+    proposed_name: Optional[str] = None,
+    upper: bool = False,
+) -> str:
+    """
+    Custom get the name for an element.
+
+    Just capitalize first Letter, don't do `.title`
+
+    Parameter:
+        schema: the concerned schema
+        proposed_name: a name that we will use it the schema hasn't any title
+        upper: should we use an upper case (For constants)
+    """
+    # Get the base name
+    has_title = isinstance(schema, dict) and "title" in schema
+    name = schema["title"] if has_title else proposed_name  # type: ignore
+    assert name is not None
+    name = normalize(name)
+
+    prefix = "" if has_title else "_"
+    if upper:
+        # Upper case
+        name = name.upper()
+        # Remove spaces
+        return prefix + "".join(["_" if char.isspace() else char for char in name])
+    else:
+        # Title case
+        name = name[0].upper() + name[1:]
+        # Remove spaces
+        return prefix + "".join([char for char in name if not char.isspace()])
+
+
+def test_empty_array() -> None:
+    config: Configuration = Configuration(
+        generate=[
+            {
+                "source": "tests/custom_get_name.json",
+                "destination": "tests/custom_get_name.py",
+                "api_arguments": {"custom_get_name": custom_get_name},
+            }
+        ],
+    )
+    process_config(
+        config,
+        ["tests/custom_get_name.json"],
+    )
+
+    with open("tests/custom_get_name.py") as f:
+        content = f.read()
+        assert "class SubresourceUris" in content