fix: treat period as a delimiter in names (#546). Thanks @alexifm!

If a model was named protoname.v1.MessageName (as if generated from `protoc`), the processed name would be Protonamev1MessageName and the model filename would be protonamev_1_message_name.py. With the change, it's ProtonameV1MessageName and protoname_v1_message_name.py, respectively.

BREAKING CHANGE: Model names generated from OpenAPI names with periods (`.`) in them will be different.

Co-authored-by: Dylan Anthony <[email protected]>

Author: alexifm

end_to_end_tests/golden-record/my_test_api_client/models/__init__.py

@@ -23,6 +23,7 @@
 from .import_ import Import
 from .model_from_all_of import ModelFromAllOf
 from .model_name import ModelName
+from .model_reference_with_periods import ModelReferenceWithPeriods
 from .model_with_additional_properties_inlined import ModelWithAdditionalPropertiesInlined
 from .model_with_additional_properties_inlined_additional_property import (
     ModelWithAdditionalPropertiesInlinedAdditionalProperty,

end_to_end_tests/golden-record/my_test_api_client/models/model_reference_with_periods.py

@@ -0,0 +1,44 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+import attr
+
+T = TypeVar("T", bound="ModelReferenceWithPeriods")
+
+
+@attr.s(auto_attribs=True)
+class ModelReferenceWithPeriods:
+    """A Model with periods in its reference"""
+
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        model_reference_with_periods = cls()
+
+        model_reference_with_periods.additional_properties = d
+        return model_reference_with_periods
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

end_to_end_tests/openapi.json

@@ -1902,6 +1902,10 @@
       },
       "None":  {
         "type": "object"
+      },
+      "model.reference.with.Periods": {
+        "type": "object",
+        "description": "A Model with periods in its reference"
       }
     }
   }

openapi_python_client/utils.py

@@ -3,7 +3,7 @@
 from keyword import iskeyword
 from typing import Any, List
 
-DELIMITERS = " _-"
+DELIMITERS = r"\. _-"
 
 
 class PythonIdentifier(str):

tests/test_utils.py

@@ -47,6 +47,7 @@ def test_empty_is_prefixed(self):
         ("Response200Okay", ["Response", "200", "Okay"]),
         ("S3Config", ["S3", "Config"]),
         ("s3config", ["s3config"]),
+        ("fully.qualified.Name", ["fully", "qualified", "Name"]),
     ],
 )
 def test_split_words(before, after):
@@ -83,8 +84,8 @@ def test_kebab_case():
     assert utils.kebab_case("keep_alive") == "keep-alive"
 
 
-def test__sanitize():
-    assert utils.sanitize("something*~with lots_- of weird things}=") == "somethingwith lots_- of weird things"
+def test_sanitize():
+    assert utils.sanitize("some.thing*~with lots_- of weird things}=") == "some.thingwith lots_- of weird things"
 
 
 def test_no_string_escapes():