Integrate traits-stubs into the traits package (#1714)

This PR (targeting Traits 7.0) integrates the separate traits-stubs package into the main traits package. This will remove the need to make a separate release of the traits-stubs package every time we release the traits package.

Notes:

* The stubs tests fail when run from an editable install, but are happy when run for a non-editable install
* This PR introduces a dependency on typing-extensions for Python 3.6 and Python 3.7

Closes #1254

.github/pull_request_template.md

@@ -2,4 +2,4 @@
 - [ ] Tests
 - [ ] Update API reference (`docs/source/traits_api_reference`)
 - [ ] Update User manual (`docs/source/traits_user_manual`)
-- [ ] Update type annotation hints in `traits-stubs`
+- [ ] Update type annotation hints in stub files

.github/workflows/run-traits-tests.yml

@@ -35,7 +35,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install .[test]
-        python -m pip install traits-stubs/[test]
     - name: Create clean test directory
       run: |
         mkdir testdir
@@ -44,8 +43,3 @@ jobs:
       with:
         working-directory: testdir
         run: python -m unittest discover -v traits
-    - name: Test Traits typing stubs
-      uses: GabrielBB/xvfb-action@v1
-      with:
-        working-directory: testdir
-        run: python -m unittest discover -v traits_stubs_tests

.gitignore

@@ -9,8 +9,6 @@
 *.egg-info/
 /build/
 /dist/
-/traits-stubs/build/
-/traits-stubs/dist/
 /docs/build/
 
 # Coverage artifacts

CHANGES.rst

@@ -11,6 +11,12 @@ TBD Release summary
 Detailed changes
 ~~~~~~~~~~~~~~~~
 
+Features
+~~~~~~~~
+* The traits package now ships with stub files directly, instead of requiring
+  those files to be installed via the separate ``traits-stubs`` package.
+  (#1714)
+
 Removals
 ~~~~~~~~
 * Remove deprecated ``rich_compare`` Trait metadata. (#1698)

MANIFEST.in

@@ -10,5 +10,6 @@ recursive-exclude docs *.pyc
 graft examples
 recursive-exclude examples *.pyc
 include traits/ctraits.c
+include traits/py.typed
 recursive-include traits *.py
 include traits/observation/_dsl_grammar.lark

etstool.py

@@ -188,15 +188,11 @@ def install(edm, runtime, environment, editable, source):
     # of TraitsUI from EDM installs Traits as a dependency, so we need
     # to explicitly uninstall it before re-installing from source.
     install_traits = _get_install_command_string(".", editable=editable)
-    install_stubs = _get_install_command_string(
-        "./traits-stubs/", editable=editable
-    )
     commands = [
         "{edm} environments create {environment} --force --version={runtime}",
         "{edm} --config edm.yaml install -y -e {environment} " + packages,
         "{edm} plumbing remove-package -e {environment} traits",
         install_traits,
-        install_stubs,
     ]
 
     if pypi_dependencies:
@@ -285,10 +281,6 @@ def test(edm, runtime, verbose, environment):
         "{edm} run -e {environment} -- coverage run -p -m "
         "unittest discover " + options + "traits",
     ]
-    commands += [
-        "{edm} run -e {environment} -- coverage run -p -m "
-        "unittest discover " + options + "traits_stubs_tests",
-    ]
 
     # We run in a tempdir to avoid accidentally picking up wrong traits
     # code from a local dir.  We need to ensure a good .coveragerc is in

pyproject.toml

@@ -10,6 +10,3 @@ target-version = ['py36']
 profile = 'black'
 line_length = 79
 order_by_type = 'False'
-
-[tool.pytest.ini_options]
-addopts = '--ignore=traits-stubs'

setup.py

@@ -287,6 +287,7 @@ def get_long_description():
         Topic :: Software Development
         Topic :: Software Development :: Libraries
         Topic :: Software Development :: User Interfaces
+        Typing :: Typed
         """.splitlines()
         if len(c.strip()) > 0
     ],
@@ -299,7 +300,11 @@ def get_long_description():
         "Documentation": "https://docs.enthought.com/traits",
         "Source Code": "https://github.com/enthought/traits",
     },
-    install_requires=[],
+    install_requires=[
+        # We need typing-extensions for SupportsIndex; once we no longer
+        # support Python < 3.8, we can drop this requirement.
+        'typing-extensions; python_version<"3.8"',
+    ],
     extras_require={
         "docs": [
             "enthought-sphinx-theme",
@@ -327,6 +332,10 @@ def get_long_description():
     },
     ext_modules=[setuptools.Extension("traits.ctraits", ["traits/ctraits.c"])],
     package_data={
+        "traits": [
+            "py.typed",
+            "*.pyi",
+        ],
         "traits.examples": [
             "introduction/*",
             "introduction/*/*",
@@ -336,6 +345,10 @@ def get_long_description():
             "test-data/historical-pickles/*.pkl",
             "test-data/historical-pickles/*.py",
         ],
+        "traits.stubs_tests": [
+            "examples/*.py",
+            "numpy_examples/*.py",
+        ],
     },
     entry_points={
         "etsdemo_data": [

traits/examples/introduction/1_validation.py

@@ -98,7 +98,7 @@ def __init__(self, filename, sample_id, date_acquired, operator,
 may be aware of, and using these classes already.
 
 As we will see, the capabilities of Traits are much greater than these type
-checking systems, however if you have the traits-stubs package installed,
+checking systems. However, Traits now ships with a selection of stub files, so
 most of your trait type declarations will be recognised and can be used with
 these new Python type systems.
 

traits-stubs/traits_stubs_tests/test_all.py → traits/stubs_tests/test_all.py

@@ -18,14 +18,14 @@
     requires_numpy_typing,
     requires_pkg_resources,
 )
-from traits_stubs_tests.util import MypyAssertions
+from traits.stubs_tests.util import MypyAssertions
 
 
 @requires_pkg_resources
 @requires_mypy
 class TestAnnotations(TestCase, MypyAssertions):
     def test_all(self, filename_suffix=""):
-        """ Run mypy for all files contained in traits_stubs_tests/examples
+        """ Run mypy for all files contained in traits.stubs_tests/examples
         directory.
 
         Lines with expected errors are marked inside these files.
@@ -37,15 +37,15 @@ def test_all(self, filename_suffix=""):
             Optional filename suffix filter.
         """
         examples_dir = Path(pkg_resources.resource_filename(
-            'traits_stubs_tests', 'examples'))
+            'traits.stubs_tests', 'examples'))
 
         for file_path in examples_dir.glob("*{}.py".format(filename_suffix)):
             with self.subTest(file_path=file_path):
                 self.assertRaisesMypyError(file_path)
 
     @requires_numpy_typing
     def test_numpy_examples(self):
-        """ Run mypy for files contained in traits_stubs_tests/numpy_examples
+        """ Run mypy for files contained in traits.stubs_tests/numpy_examples
         directory.
 
         Lines with expected errors are marked inside these files.
@@ -57,7 +57,7 @@ def test_numpy_examples(self):
             Optional filename suffix filter.
         """
         examples_dir = Path(pkg_resources.resource_filename(
-            'traits_stubs_tests', 'numpy_examples'))
+            'traits.stubs_tests', 'numpy_examples'))
 
         for file_path in examples_dir.glob("*.py"):
             with self.subTest(file_path=file_path):