Refactor method definitions to include boto3 documentation links and streamline context manager methods

Author: vemel

mypy_boto3_builder/parsers/parse_collections.py

@@ -44,6 +44,7 @@ def parse_collection(
     )
     self_type = InternalImport(collection_record.name, stringify=True)
 
+    # FIXME: other collection methods use different anchor format. This will probably change.
     all_method = Method(
         name="all",
         arguments=(Argument.self(),),
@@ -52,10 +53,7 @@ def parse_collection(
             "Get all items from the collection, optionally"
             " with a custom page size and item count limit."
         ),
-    )
-    # FIXME: other collection methods use different anchor format. This will probably change.
-    all_method.set_boto3_doc_link(
-        f"{collection_record.boto3_doc_link_parent}#{service_name.class_name}.{collection_record.parent_name}.all"
+        boto3_doc_link=f"{collection_record.boto3_doc_link_parent}#{service_name.class_name}.{collection_record.parent_name}.all",
     )
 
     collection_record.methods.append(all_method)

mypy_boto3_builder/postprocessors/aiobotocore.py

@@ -180,28 +180,31 @@ def _make_async_sub_resources(self) -> None:
                 )
 
     def _add_contextmanager_methods(self) -> None:
-        aenter_method = Method(
-            name="__aenter__",
-            arguments=(Argument.self(),),
-            return_type=InternalImport(self.package.client.name),
-            is_async=True,
-            docstring=self.package.client.docstring,
-        )
-        aenter_method.set_boto3_doc_link(self.package.client.boto3_doc_link)
-        aexit_method = Method(
-            name="__aexit__",
-            arguments=(
-                Argument.self(),
-                Argument("exc_type", Type.Any),
-                Argument("exc_val", Type.Any),
-                Argument("exc_tb", Type.Any),
-            ),
-            return_type=Type.Any,
-            is_async=True,
-            docstring=self.package.client.docstring,
+        self.package.client.methods.extend(
+            (
+                Method(
+                    name="__aenter__",
+                    arguments=(Argument.self(),),
+                    return_type=InternalImport(self.package.client.name),
+                    is_async=True,
+                    docstring=self.package.client.docstring,
+                    boto3_doc_link=self.package.client.boto3_doc_link,
+                ),
+                Method(
+                    name="__aexit__",
+                    arguments=(
+                        Argument.self(),
+                        Argument("exc_type", Type.Any),
+                        Argument("exc_val", Type.Any),
+                        Argument("exc_tb", Type.Any),
+                    ),
+                    return_type=Type.Any,
+                    is_async=True,
+                    docstring=self.package.client.docstring,
+                    boto3_doc_link=self.package.client.boto3_doc_link,
+                ),
+            )
         )
-        aexit_method.set_boto3_doc_link(self.package.client.boto3_doc_link)
-        self.package.client.methods.extend((aenter_method, aexit_method))
 
     def _iterate_types_shallow(self) -> Iterator[FakeAnnotation]:
         yield from self.package.client.iterate_types()

mypy_boto3_builder/structures/client.py

@@ -109,7 +109,7 @@ def get_exceptions_property(self) -> Method:
         """
         Generate Client exceptions property.
         """
-        method = Method(
+        return Method(
             name="exceptions",
             decorators=[ExternalImport.from_class(property)],
             arguments=[
@@ -122,9 +122,8 @@ def get_exceptions_property(self) -> Method:
                 stringify=False,
             ),
             docstring=f"{self.name} exceptions.",
+            boto3_doc_link=self.boto3_doc_link,
         )
-        method.set_boto3_doc_link(self.boto3_doc_link)
-        return method
 
     def get_required_import_records(self) -> set[ImportRecord]:
         """

mypy_boto3_builder/structures/function.py

@@ -30,6 +30,7 @@ def __init__(
         body_lines: Iterable[str] = (),
         type_ignore: bool = False,
         is_async: bool = False,
+        boto3_doc_link: str = "",
     ) -> None:
         self.name = name
         self.arguments = list(arguments)
@@ -40,7 +41,7 @@ def __init__(
         self.type_ignore = type_ignore
         self.request_type_annotation: TypeTypedDict | None = None
         self.is_async = is_async
-        self._boto3_doc_link = ""
+        self._boto3_doc_link = boto3_doc_link
 
     @property
     def boto3_doc_link(self) -> str:

tests/structures/test_method.py

@@ -19,8 +19,13 @@ def setup_method(self) -> None:
             return_type=Type.none,
             body_lines=["line1", "line2"],
             docstring="docstring\n\nlong",
+            boto3_doc_link="boto3://doc.link",
         )
 
+    def test_set_boto3_doc_link(self) -> None:
+        self.method.set_boto3_doc_link("new")
+        assert self.method.boto3_doc_link == "new"
+
     def test_is_kw_only(self) -> None:
         assert self.method.is_kw_only() is False
 

tests/structures/test_package_url.py

@@ -0,0 +1,36 @@
+from mypy_boto3_builder.package_data import Boto3StubsPackageData
+from mypy_boto3_builder.structures.package_url import PackageURL
+
+
+class TestPackageURL:
+    package_url: PackageURL
+
+    def setup_method(self) -> None:
+        self.package_url = PackageURL("name", Boto3StubsPackageData)
+
+    def test_init(self) -> None:
+        assert self.package_url.pypi_name == "name"
+        assert self.package_url.data == Boto3StubsPackageData
+
+        assert self.package_url.pypi_badge == "https://img.shields.io/pypi/v/name.svg?color=blue"
+        assert (
+            self.package_url.pyversions_badge
+            == "https://img.shields.io/pypi/pyversions/name.svg?color=blue"
+        )
+        assert (
+            self.package_url.rtd_badge
+            == "https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue"
+        )
+        assert self.package_url.pepy_badge == "https://static.pepy.tech/badge/name"
+        assert (
+            self.package_url.montly_downloads_badge
+            == "https://img.shields.io/pypi/dm/name?color=blue"
+        )
+        assert self.package_url.pypi == "https://pypi.org/project/name/"
+        assert self.package_url.library_pypi == "https://pypi.org/project/boto3/"
+        assert self.package_url.stubs_pypi == "https://pypi.org/project/boto3-stubs/"
+        assert self.package_url.stubs_lite_pypi == "https://pypi.org/project/boto3-stubs-lite/"
+        assert self.package_url.stubs_full_pypi == "https://pypi.org/project/boto3-stubs-full/"
+        assert self.package_url.pepy == "https://pepy.tech/project/name"
+        assert self.package_url.pypistats == "https://pypistats.org/packages/name"
+        assert self.package_url.docs == "https://youtype.github.io/boto3_stubs_docs/"