Include boto3-stubs in gazelle_python.yaml on type_checking_imports test

Author: amartani

gazelle/python/testdata/type_checking_imports/BUILD.out

@@ -14,13 +14,20 @@ py_library(
 py_library(
     name = "baz",
     srcs = ["baz.py"],
+    pyi_deps = [
+        "@gazelle_python_test//boto3",
+        "@gazelle_python_test//boto3_stubs",
+    ],
     visibility = ["//:__subpackages__"],
 )
 
 py_library(
     name = "foo",
     srcs = ["foo.py"],
-    pyi_deps = ["@gazelle_python_test//djangorestframework"],
+    pyi_deps = [
+        "@gazelle_python_test//boto3_stubs",
+        "@gazelle_python_test//djangorestframework",
+    ],
     visibility = ["//:__subpackages__"],
     deps = ["@gazelle_python_test//boto3"],
 )

gazelle/python/testdata/type_checking_imports/baz.py

@@ -12,4 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+# While this format is not official, it is supported by most type checkers and
+# is used in the wild to avoid importing the typing module.
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    # Both boto3 and boto3_stubs should be added to pyi_deps.
+    import boto3
+
 X = 1

gazelle/python/testdata/type_checking_imports/foo.py

@@ -14,6 +14,7 @@
 
 import typing
 
+# boto3 should be added to deps. boto3_stubs and djangorestframework should be added to pyi_deps.
 import boto3
 
 if typing.TYPE_CHECKING:

gazelle/python/testdata/type_checking_imports/gazelle_python.yaml

@@ -15,5 +15,6 @@
 manifest:
   modules_mapping:
     boto3: boto3
+    boto3_stubs: boto3_stubs
     rest_framework: djangorestframework
   pip_deps_repository_name: gazelle_python_test

gazelle/python/testdata/type_checking_imports_disabled/BUILD.out

@@ -17,6 +17,10 @@ py_library(
     name = "baz",
     srcs = ["baz.py"],
     visibility = ["//:__subpackages__"],
+    deps = [
+        "@gazelle_python_test//boto3",
+        "@gazelle_python_test//boto3_stubs",
+    ],
 )
 
 py_library(
@@ -25,6 +29,7 @@ py_library(
     visibility = ["//:__subpackages__"],
     deps = [
         "@gazelle_python_test//boto3",
+        "@gazelle_python_test//boto3_stubs",
         "@gazelle_python_test//djangorestframework",
     ],
 )

gazelle/python/testdata/type_checking_imports_disabled/baz.py

@@ -12,4 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+# While this format is not official, it is supported by most type checkers and
+# is used in the wild to avoid importing the typing module.
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    # Both boto3 and boto3_stubs should be added to pyi_deps.
+    import boto3
+
 X = 1

gazelle/python/testdata/type_checking_imports_disabled/foo.py

@@ -14,6 +14,7 @@
 
 import typing
 
+# boto3 should be added to deps. boto3_stubs and djangorestframework should be added to pyi_deps.
 import boto3
 
 if typing.TYPE_CHECKING:

gazelle/python/testdata/type_checking_imports_disabled/gazelle_python.yaml

@@ -15,5 +15,6 @@
 manifest:
   modules_mapping:
     boto3: boto3
+    boto3_stubs: boto3_stubs
     rest_framework: djangorestframework
   pip_deps_repository_name: gazelle_python_test