add mypy (#1109) (#1110)

(cherry picked from commit 5b182c6)

Signed-off-by: Michael Carlstrom <[email protected]>
Co-authored-by: Michael Carlstrom <[email protected]>

Author: mergify[bot]

ros2pkg/ros2pkg/api/create.py

@@ -169,6 +169,11 @@ def populate_ament_python(package, package_directory, source_directory, python_n
                           source_directory,
                           '__init__.py',
                           {})
+    _create_template_file('ament_python',
+                          'py.typed.em',
+                          source_directory,
+                          'py.typed',
+                          {})
 
     test_directory = _create_folder('test', package_directory)
     _create_template_file('ament_python',
@@ -181,6 +186,11 @@ def populate_ament_python(package, package_directory, source_directory, python_n
                           test_directory,
                           'test_flake8.py',
                           {})
+    _create_template_file('ament_python',
+                          'test_mypy.py.em',
+                          test_directory,
+                          'test_mypy.py',
+                          {})
     _create_template_file('ament_python',
                           'test_pep257.py.em',
                           test_directory,

ros2pkg/ros2pkg/resource/ament_python/main.py.em

@@ -1,4 +1,4 @@
-def main():
+def main() -> None:
     print('Hi from @project_name.')
 
 

ros2pkg/ros2pkg/resource/ament_python/py.typed.em

@@ -11,6 +11,7 @@ setup(
             ['resource/' + package_name]),
         ('share/' + package_name, ['package.xml']),
     ],
+    package_data={'': ['py.typed']},
     install_requires=['setuptools'],
     zip_safe=True,
     maintainer='@maintainer_name',

ros2pkg/ros2pkg/resource/ament_python/setup.py.em

@@ -20,6 +20,6 @@ import pytest
 @@pytest.mark.skip(reason='No copyright header has been placed in the generated source file.')
 @@pytest.mark.copyright
 @@pytest.mark.linter
-def test_copyright():
+def test_copyright() -> None:
     rc = main(argv=['.', 'test'])
     assert rc == 0, 'Found errors'

ros2pkg/ros2pkg/resource/ament_python/test_copyright.py.em

@@ -18,7 +18,7 @@ import pytest
 
 @@pytest.mark.flake8
 @@pytest.mark.linter
-def test_flake8():
+def test_flake8() -> None:
     rc, errors = main_with_errors(argv=[])
     assert rc == 0, \
         'Found %d code style errors / warnings:\n' % len(errors) + \

ros2pkg/ros2pkg/resource/ament_python/test_flake8.py.em

@@ -0,0 +1,23 @@
+# Copyright 2025 Open Source Robotics Foundation, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from ament_mypy.main import main
+import pytest
+
+
+@@pytest.mark.mypy
+@@pytest.mark.linter
+def test_mypy() -> None:
+    rc = main(argv=[])
+    assert rc == 0, 'Found type errors!'

ros2pkg/ros2pkg/resource/ament_python/test_mypy.py.em

@@ -18,6 +18,6 @@ import pytest
 
 @@pytest.mark.linter
 @@pytest.mark.pep257
-def test_pep257():
+def test_pep257() -> None:
     rc = main(argv=['.', 'test'])
     assert rc == 0, 'Found code style errors / warnings'

ros2pkg/ros2pkg/resource/ament_python/test_pep257.py.em

@@ -145,7 +145,7 @@ def get_git_config(key: str) -> Optional[str]:
         if args.build_type == 'ament_cmake':
             test_dependencies = ['ament_lint_auto', 'ament_lint_common']
         if args.build_type == 'ament_python':
-            test_dependencies = ['ament_copyright', 'ament_flake8', 'ament_pep257',
+            test_dependencies = ['ament_copyright', 'ament_flake8', 'ament_mypy', 'ament_pep257',
                                  'ament_xmllint', 'python3-pytest']
 
         if args.build_type == 'ament_python' and args.package_name == 'test':