Refactor ClientParser and other parsers

vemel · vemel · commit 8ecaadb9e46c · 2025-01-30T20:22:30.000+03:00
diff --git a/mypy_boto3_builder/parsers/client.py b/mypy_boto3_builder/parsers/client.py
diff --git a/mypy_boto3_builder/parsers/client_parser.py b/mypy_boto3_builder/parsers/client_parser.py
@@ -0,0 +1,98 @@
+"""
+Parser for botocore Client, produces `structures.Client`.
+
+Copyright 2025 Vlad Emelianov
+"""
+
+from botocore.client import ClientMeta
+from botocore.errorfactory import ClientExceptionsFactory
+from botocore.exceptions import ClientError
+
+from mypy_boto3_builder.constants import CLIENT
+from mypy_boto3_builder.logger import get_logger
+from mypy_boto3_builder.parsers.shape_parser import ShapeParser
+from mypy_boto3_builder.service_name import ServiceName
+from mypy_boto3_builder.structures.attribute import Attribute
+from mypy_boto3_builder.structures.client import Client
+from mypy_boto3_builder.structures.method import Method
+from mypy_boto3_builder.type_annotations.external_import import ExternalImport
+from mypy_boto3_builder.type_annotations.type import Type
+from mypy_boto3_builder.type_annotations.type_subscript import TypeSubscript
+from mypy_boto3_builder.type_maps.service_stub_map import get_stub_method_map
+from mypy_boto3_builder.utils.strings import get_class_prefix
+
+
+class ClientParser:
+    """
+    Parser for botocore Client, produces `structures.Client`.
+
+    Arguments:
+        service_name -- Target service name.
+        shape_parser -- ShapeParser instance.
+    """
+
+    def __init__(
+        self,
+        service_name: ServiceName,
+        shape_parser: ShapeParser,
+    ) -> None:
+        self.name = CLIENT
+        self.alias = service_name.get_client_name()
+        self.service_name = service_name
+        self.shape_parser = shape_parser
+        self._logger = get_logger()
+
+    def _parse_method_map(self) -> dict[str, Method]:
+        shape_method_map = self.shape_parser.get_client_method_map()
+        stub_method_map = get_stub_method_map(self.service_name, self.name)
+        for method in stub_method_map.values():
+            self.shape_parser.create_request_type_annotation(
+                method=method,
+                name=f"{self.name}{get_class_prefix(method.name)}Request",
+            )
+        return {**shape_method_map, **stub_method_map}
+
+    def _parse_exception_class_attributes(self) -> list[Attribute]:
+        result: list[Attribute] = []
+        client_exceptions = ClientExceptionsFactory().create_client_exceptions(
+            self.shape_parser.service_model
+        )
+        for exception_class_name in dir(client_exceptions):
+            if exception_class_name.startswith("_"):
+                continue
+            if not exception_class_name[0].isupper():
+                continue
+            result.append(
+                Attribute(
+                    exception_class_name,
+                    TypeSubscript(
+                        Type.Type,
+                        [ExternalImport.from_class(ClientError, alias="BotocoreClientError")],
+                    ),
+                ),
+            )
+        return result
+
+    def parse(self) -> Client:
+        """
+        Parse botocore Client.
+
+        Returns:
+            Client structure.
+        """
+        self._logger.debug(f"Parsing {self.alias}", tags=self.alias)
+
+        result = Client(
+            name=self.alias,
+            service_name=self.service_name,
+        )
+
+        method_map = self._parse_method_map()
+        result.methods.append(result.get_exceptions_property())
+        result.methods.extend(method_map.values())
+
+        result.attributes.append(Attribute("meta", ExternalImport.from_class(ClientMeta)))
+
+        result.exceptions_class.attributes.extend(self._parse_exception_class_attributes())
+
+        return result
diff --git a/mypy_boto3_builder/parsers/resource_parser.py b/mypy_boto3_builder/parsers/resource_parser.py
@@ -1,5 +1,5 @@
 """
-Parser for Boto3 ServiceResource sub-resource, produces `structures.Resource`.
+Parser for botocore ServiceResource sub-resource, produces `structures.Resource`.
 
 Copyright 2024 Vlad Emelianov
 """
@@ -24,12 +24,12 @@
 
 class ResourceParser:
     """
-    Parser for Boto3 ServiceResource sub-resource, produces `structures.Resource`.
+    Parser for botocore ServiceResource sub-resource, produces `structures.Resource`.
 
     Arguments:
         name -- Resource name.
         service_name -- Target service name.
-        shape_parser - ShapeParser instance.
+        shape_parser -- ShapeParser instance.
     """
 
     def __init__(
@@ -120,10 +120,7 @@ def _parse_collections(self) -> list[Collection]:
 
     def parse(self) -> ResourceRecord:
         """
-        Parse boto3 sub Resource data.
-
-        Arguments:
-            resource -- Original boto3 resource.
+        Parse botocore sub Resource data.
 
         Returns:
             Resource structure.
diff --git a/mypy_boto3_builder/parsers/service_package_parser.py b/mypy_boto3_builder/parsers/service_package_parser.py
@@ -8,7 +8,7 @@
 
 from mypy_boto3_builder.logger import get_logger
 from mypy_boto3_builder.package_data import BasePackageData
-from mypy_boto3_builder.parsers.client import parse_client
+from mypy_boto3_builder.parsers.client_parser import ClientParser
 from mypy_boto3_builder.parsers.service_resource_parser import ServiceResourceParser
 from mypy_boto3_builder.parsers.shape_parser import ShapeParser
 from mypy_boto3_builder.service_name import ServiceName, ServiceNameCatalog
@@ -79,11 +79,15 @@ def parse(self) -> ServicePackage:
         return result
 
     def _parse_service_package(self) -> ServicePackage:
-        client = parse_client(self.service_name, self.shape_parser)
         service_resource_parser = ServiceResourceParser(
             self.service_name,
             self.shape_parser,
         )
+        client_parser = ClientParser(
+            self.service_name,
+            self.shape_parser,
+        )
+        client = client_parser.parse()
         service_resource = service_resource_parser.parse_service_resource()
 
         return ServicePackage(
diff --git a/mypy_boto3_builder/parsers/service_resource_parser.py b/mypy_boto3_builder/parsers/service_resource_parser.py
@@ -1,5 +1,5 @@
 """
-Parser for Boto3 ServiceResource, produces `structures.ServiceResource`.
+Parser for botocore ServiceResource, produces `structures.ServiceResource`.
 
 Copyright 2024 Vlad Emelianov
 """
@@ -21,11 +21,11 @@
 
 class ServiceResourceParser(ResourceParser):
     """
-    Parser for boto3 ServiceResource data.
+    Parser for botocore ServiceResource, produces `structures.ServiceResource`.
 
     Arguments:
         service_name -- Target service name.
-        shape_parser - ShapeParser instance.
+        shape_parser -- ShapeParser instance.
     """
 
     def __init__(
@@ -38,6 +38,7 @@ def __init__(
             service_name=service_name,
             shape_parser=shape_parser,
         )
+        self.alias = self.service_name.get_service_resource_name()
 
     def _get_meta_attribute(self, name: str) -> Attribute:
         return Attribute(
@@ -65,24 +66,23 @@ def _get_resource_model(self) -> ResourceModel:
 
     def parse_service_resource(self) -> ServiceResource | None:
         """
-        Parse main boto3 ServiceResource.
+        Parse main botocore ServiceResource.
         """
         if not self.shape_parser.has_service_resource():
             return None
 
-        name = self.service_name.get_service_resource_name()
-        self._logger.debug(f"Parsing {name}", tags=name)
+        self._logger.debug(f"Parsing {self.alias}", tags=self.alias)
         result = ServiceResource(
-            name=name,
+            name=self.alias,
             service_name=self.service_name,
         )
         meta_attribute = self._get_meta_attribute(result.resource_meta_class.name)
 
-        self._logger.debug(f"Parsing {name} methods", tags=name)
+        self._logger.debug(f"Parsing {self.alias} methods", tags=self.alias)
         method_map = self._parse_method_map()
         result.methods.extend(list(method_map.values()))
 
-        self._logger.debug(f"Parsing {name} attributes and collections", tags=name)
+        self._logger.debug(f"Parsing {self.alias} attributes and collections", tags=self.alias)
         collections = self._parse_collections()
         result.attributes.append(meta_attribute)
         result.attributes.extend(self._parse_attributes(collections))
diff --git a/tests/parsers/test_service_package.py b/tests/parsers/test_service_package.py
@@ -5,7 +5,7 @@
 
 
 class TestServicePackageParser:
-    @patch("mypy_boto3_builder.parsers.client.ClientExceptionsFactory")
+    @patch("mypy_boto3_builder.parsers.client_parser.ClientExceptionsFactory")
     def test_parse(
         self,
         ClientExceptionsFactoryMock: MagicMock,
@@ -14,12 +14,23 @@ def test_parse(
         service_name_mock = MagicMock()
         botocore_session_mock().resource.return_value = None
         service_name_mock.boto3_name = "s3"
-        ClientExceptionsFactoryMock.create_client_exceptions.return_value = []
+
+        class FakeExceptions:
+            _internal = True
+            __magic = True
+            skip_lowecase = True
+            RealException = True
+            RealExceptionToo = True
+
+        ClientExceptionsFactoryMock().create_client_exceptions.return_value = FakeExceptions()
 
         parser = ServicePackageParser(
             service_name_mock,
             package_data=Boto3StubsPackageData(),
             version="1.2.3",
         )
         result = parser.parse()
+        assert len(result.client.exceptions_class.attributes) == 2
+        assert result.client.exceptions_class.attributes[0].name == "RealException"
+        assert result.client.exceptions_class.attributes[1].name == "RealExceptionToo"
         assert result.service_name == service_name_mock
