rename BaseResourceModel to BaseModel

Author: jaymccon

python/rpdk/python/templates/models.py

@@ -15,8 +15,8 @@
 )
 
 from cloudformation_cli_python_lib.interface import (
+    BaseModel,
     BaseResourceHandlerRequest,
-    BaseResourceModel,
 )
 from cloudformation_cli_python_lib.recast import recast_object
 from cloudformation_cli_python_lib.utils import deserialize_list
@@ -39,7 +39,7 @@ class ResourceHandlerRequest(BaseResourceHandlerRequest):
 
 {% for model, properties in models.items() %}
 @dataclass
-class {{ model }}(BaseResourceModel):
+class {{ model }}(BaseModel):
     {% for name, type in properties.items() %}
     {{ name }}: Optional[{{ type|translate_type }}]
     {% endfor %}

src/cloudformation_cli_python_lib/callback.py

@@ -4,7 +4,7 @@
 from uuid import uuid4
 
 from .boto3_proxy import SessionProxy
-from .interface import BaseResourceModel, HandlerErrorCode, OperationStatus
+from .interface import BaseModel, HandlerErrorCode, OperationStatus
 from .utils import KitchenSinkEncoder
 
 LOG = logging.getLogger(__name__)
@@ -16,7 +16,7 @@ def report_progress(  # pylint: disable=too-many-arguments
     error_code: Optional[HandlerErrorCode],
     operation_status: OperationStatus,
     current_operation_status: Optional[OperationStatus],
-    resource_model: Optional[BaseResourceModel],
+    resource_model: Optional[BaseModel],
     status_message: str,
 ) -> None:
     client = session.client("cloudformation")

src/cloudformation_cli_python_lib/interface.py

@@ -57,7 +57,7 @@ class HandlerErrorCode(str, _AutoName):
     InternalFailure = auto()
 
 
-class BaseResourceModel:
+class BaseModel:
     def _serialize(self) -> Mapping[str, Any]:
         return {
             k: self._serialize_item(v)
@@ -68,7 +68,7 @@ def _serialize(self) -> Mapping[str, Any]:
     def _serialize_item(self, v: Any) -> Any:
         if isinstance(v, list):
             return self._serialize_list(v)
-        if isinstance(v, BaseResourceModel):
+        if isinstance(v, BaseModel):
             return v._serialize()  # pylint: disable=protected-access
         return v
 
@@ -77,8 +77,8 @@ def _serialize_list(self, src_list: List[Any]) -> List[Any]:
 
     @classmethod
     def _deserialize(
-        cls: Type["BaseResourceModel"], json_data: Optional[Mapping[str, Any]]
-    ) -> Optional["BaseResourceModel"]:
+        cls: Type["BaseModel"], json_data: Optional[Mapping[str, Any]]
+    ) -> Optional["BaseModel"]:
         raise NotImplementedError()
 
 
@@ -91,8 +91,8 @@ class ProgressEvent:
     message: str = ""
     callbackContext: Optional[MutableMapping[str, Any]] = None
     callbackDelaySeconds: int = 0
-    resourceModel: Optional[BaseResourceModel] = None
-    resourceModels: Optional[List[BaseResourceModel]] = None
+    resourceModel: Optional[BaseModel] = None
+    resourceModels: Optional[List[BaseModel]] = None
     nextToken: Optional[str] = None
 
     def _serialize(
@@ -132,7 +132,7 @@ def failed(
 class BaseResourceHandlerRequest:
     # pylint: disable=invalid-name
     clientRequestToken: str
-    desiredResourceState: Optional[BaseResourceModel]
-    previousResourceState: Optional[BaseResourceModel]
+    desiredResourceState: Optional[BaseModel]
+    previousResourceState: Optional[BaseModel]
     logicalResourceIdentifier: Optional[str]
     nextToken: Optional[str]

src/cloudformation_cli_python_lib/resource.py

@@ -20,7 +20,7 @@
 from .metrics import MetricsPublisherProxy
 from .scheduler import cleanup_cloudwatch_events, reschedule_after_minutes
 from .utils import (
-    BaseResourceModel,
+    BaseModel,
     Credentials,
     HandlerRequest,
     KitchenSinkEncoder,
@@ -60,11 +60,9 @@ def wrapper(self: Any, event: MutableMapping[str, Any], context: Any) -> Any:
 
 
 class Resource:
-    def __init__(
-        self, type_name: str, resouce_model_cls: Type[BaseResourceModel]
-    ) -> None:
+    def __init__(self, type_name: str, resouce_model_cls: Type[BaseModel]) -> None:
         self.type_name = type_name
-        self._model_cls: Type[BaseResourceModel] = resouce_model_cls
+        self._model_cls: Type[BaseModel] = resouce_model_cls
         self._handlers: MutableMapping[Action, HandlerSignature] = {}
 
     def handler(self, action: Action) -> Callable[[HandlerSignature], HandlerSignature]:

src/cloudformation_cli_python_lib/utils.py

@@ -15,7 +15,7 @@
 )
 
 from .exceptions import InvalidRequest
-from .interface import Action, BaseResourceHandlerRequest, BaseResourceModel
+from .interface import Action, BaseModel, BaseResourceHandlerRequest
 
 
 class KitchenSinkEncoder(json.JSONEncoder):
@@ -116,9 +116,7 @@ class UnmodelledRequest:
     logicalResourceIdentifier: Optional[str] = None
     nextToken: Optional[str] = None
 
-    def to_modelled(
-        self, model_cls: Type[BaseResourceModel]
-    ) -> BaseResourceHandlerRequest:
+    def to_modelled(self, model_cls: Type[BaseModel]) -> BaseResourceHandlerRequest:
         # pylint: disable=protected-access
         return BaseResourceHandlerRequest(
             clientRequestToken=self.clientRequestToken,

tests/lib/callback_test.py

@@ -5,7 +5,7 @@
 import boto3
 from cloudformation_cli_python_lib.callback import report_progress
 from cloudformation_cli_python_lib.interface import (
-    BaseResourceModel,
+    BaseModel,
     HandlerErrorCode,
     OperationStatus,
 )
@@ -47,7 +47,7 @@ def test_report_progress_full():
             HandlerErrorCode.InternalFailure,
             OperationStatus.FAILED,
             OperationStatus.IN_PROGRESS,
-            BaseResourceModel(),
+            BaseModel(),
             "test message",
         )
     session._cfn.record_handler_progress.assert_called_once_with(

tests/lib/interface_test.py

@@ -7,7 +7,7 @@
 import boto3
 import pytest
 from cloudformation_cli_python_lib.interface import (
-    BaseResourceModel,
+    BaseModel,
     HandlerErrorCode,
     OperationStatus,
     ProgressEvent,
@@ -35,18 +35,18 @@ def bearer_token():
 
 # don't call this TestModel, or pytest will try and execute it
 @dataclass
-class ResourceModel(BaseResourceModel):
+class ResourceModel(BaseModel):
     somekey: str
     someotherkey: str
 
 
 def test_base_resource_model__deserialize():
     with pytest.raises(NotImplementedError):
-        BaseResourceModel()._deserialize({})
+        BaseModel()._deserialize({})
 
 
 def test_base_resource_model__serialize():
-    brm = BaseResourceModel()
+    brm = BaseModel()
     assert brm._serialize() == brm.__dict__
 
 

tests/lib/resource_test.py

@@ -7,7 +7,7 @@
 from cloudformation_cli_python_lib.exceptions import InternalFailure, InvalidRequest
 from cloudformation_cli_python_lib.interface import (
     Action,
-    BaseResourceModel,
+    BaseModel,
     HandlerErrorCode,
     OperationStatus,
     ProgressEvent,
@@ -106,7 +106,7 @@ def test_entrypoint_success():
 
 def test_entrypoint_handler_raises():
     @dataclass
-    class ResourceModel(BaseResourceModel):
+    class ResourceModel(BaseModel):
         a_string: str
 
         @classmethod

tests/lib/sample_model.py

@@ -17,8 +17,8 @@
 )
 
 from cloudformation_cli_python_lib.interface import (
+    BaseModel,
     BaseResourceHandlerRequest,
-    BaseResourceModel,
 )
 from cloudformation_cli_python_lib.recast import recast_object
 from cloudformation_cli_python_lib.utils import deserialize_list
@@ -34,7 +34,7 @@ class ResourceHandlerRequest(BaseResourceHandlerRequest):
 
 
 @dataclass
-class ResourceModel(BaseResourceModel):
+class ResourceModel(BaseModel):
     ListListAny: Optional[Sequence[Sequence[Any]]]
     ListSetInt: Optional[Sequence[AbstractSet[int]]]
     ListListInt: Optional[Sequence[Sequence[int]]]
@@ -89,7 +89,7 @@ def _deserialize(
 
 
 @dataclass
-class NestedList(BaseResourceModel):
+class NestedList(BaseModel):
     NestedListInt: Optional[bool]
     NestedListList: Optional[Sequence[float]]
 
@@ -108,7 +108,7 @@ def _deserialize(
 
 
 @dataclass
-class AList(BaseResourceModel):
+class AList(BaseModel):
     DeeperBool: Optional[bool]
     DeeperList: Optional[Sequence[int]]
     DeeperDictInList: Optional["_DeeperDictInList"]
@@ -131,7 +131,7 @@ def _deserialize(
 
 
 @dataclass
-class DeeperDictInList(BaseResourceModel):
+class DeeperDictInList(BaseModel):
     DeepestBool: Optional[bool]
     DeepestList: Optional[Sequence[int]]
 
@@ -150,7 +150,7 @@ def _deserialize(
 
 
 @dataclass
-class ADict(BaseResourceModel):
+class ADict(BaseModel):
     DeepBool: Optional[bool]
     DeepList: Optional[Sequence[int]]
     DeepDict: Optional["_DeepDict"]
@@ -171,7 +171,7 @@ def _deserialize(
 
 
 @dataclass
-class DeepDict(BaseResourceModel):
+class DeepDict(BaseModel):
     DeeperBool: Optional[bool]
     DeeperList: Optional[Sequence[int]]
     DeeperDict: Optional["_DeeperDict"]
@@ -192,7 +192,7 @@ def _deserialize(
 
 
 @dataclass
-class DeeperDict(BaseResourceModel):
+class DeeperDict(BaseModel):
     DeepestBool: Optional[bool]
     DeepestList: Optional[Sequence[int]]
 
@@ -211,7 +211,7 @@ def _deserialize(
 
 
 @dataclass
-class SimpleResourceModel(BaseResourceModel):
+class SimpleResourceModel(BaseModel):
     AnInt: Optional[int]
     ABool: Optional[bool]
 

tests/lib/utils_test.py

@@ -4,7 +4,7 @@
 
 import pytest
 from cloudformation_cli_python_lib.exceptions import InvalidRequest
-from cloudformation_cli_python_lib.interface import BaseResourceModel
+from cloudformation_cli_python_lib.interface import BaseModel
 from cloudformation_cli_python_lib.utils import (
     HandlerRequest,
     KitchenSinkEncoder,
@@ -110,7 +110,7 @@ def test_handler_request_serde_roundtrip():
 
 
 def test_unmodelled_request_to_modelled():
-    model_cls = Mock(spec_set=BaseResourceModel)
+    model_cls = Mock(spec_set=BaseModel)
     model_cls._deserialize.side_effect = [sentinel.new, sentinel.old]
 
     unmodelled = UnmodelledRequest(
@@ -133,10 +133,10 @@ def test_unmodelled_request_to_modelled():
 
 
 def test_deserialize_list_empty():
-    assert deserialize_list(None, BaseResourceModel) is None
-    assert deserialize_list([], BaseResourceModel) is None
+    assert deserialize_list(None, BaseModel) is None
+    assert deserialize_list([], BaseModel) is None
 
 
 def test_deserialize_list_invalid():
     with pytest.raises(InvalidRequest):
-        deserialize_list([(1, 2)], BaseResourceModel)
+        deserialize_list([(1, 2)], BaseModel)