Add py.typed and enable mypy in pre-commit (#102)

Add `py.typed` to the distribution, enabling users to use `LazyDataDir` in type annotations.

In addition enable type checking via `mypy` in the `pre-commit` configuration.

Author: nicoddemus

.pre-commit-config.yaml

@@ -48,3 +48,8 @@ repos:
             - flake8-typing-imports==1.14.0
             - flake8-builtins==2.1.0
             - flake8-bugbear==23.1.20
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.16.0
+    hooks:
+    -   id: mypy
+        files: ^(src/|tests/)

CHANGELOG.rst

@@ -1,6 +1,13 @@
 pytest-datadir
 ==============
 
+UNRELEASED
+----------
+
+*UNRELEASED
+
+- ``py.typed`` was added to the distribution, enabling users to use ``LazyDataDir`` in type annotations.
+
 1.7.1
 -----
 

pyproject.toml

@@ -57,3 +57,21 @@ where = ["src"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
+
+[tool.setuptools.package-data]
+"pytest_datadir" = ["py.typed"]
+
+[tool.mypy]
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_defs = true
+ignore_missing_imports = true
+no_implicit_optional = true
+pretty = true
+show_error_codes = true
+strict_equality = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unreachable = true
+warn_unused_configs = true
+warn_unused_ignores = true

src/pytest_datadir/plugin.py

@@ -7,7 +7,7 @@
 import pytest
 
 
-def _win32_longpath(path):
+def _win32_longpath(path: str) -> str:
     """
     Helper function to add the long path prefix for Windows, so that shutil.copytree
      won't fail while working with paths with 255+ chars.
@@ -33,7 +33,7 @@ def _win32_longpath(path):
 
 
 @pytest.fixture
-def shared_datadir(request, tmp_path):
+def shared_datadir(request: pytest.FixtureRequest, tmp_path: Path) -> Path:
     original_shared_path = os.path.join(request.fspath.dirname, "data")
     temp_path = tmp_path / "data"
     shutil.copytree(
@@ -43,12 +43,12 @@ def shared_datadir(request, tmp_path):
 
 
 @pytest.fixture(scope="module")
-def original_datadir(request):
-    return request.path.parent / request.path.stem
+def original_datadir(request: pytest.FixtureRequest) -> Path:
+    return Path(request.path).with_suffix("")
 
 
 @pytest.fixture
-def datadir(original_datadir, tmp_path):
+def datadir(original_datadir: Path, tmp_path: Path) -> Path:
     result = tmp_path / original_datadir.stem
     if original_datadir.is_dir():
         shutil.copytree(

src/pytest_datadir/py.typed

@@ -2,10 +2,11 @@
 from pathlib import Path
 
 import pytest
+from pytest_datadir.plugin import LazyDataDir
 
 
 @pytest.fixture(autouse=True, scope="module")
-def create_long_file_path():
+def create_long_file_path() -> None:
     """
     Create a very long file name to ensure datadir can copy it correctly.
 
@@ -21,7 +22,7 @@ def create_long_file_path():
         os.chdir(old_cwd)
 
 
-def test_read_hello(datadir):
+def test_read_hello(datadir: Path) -> None:
     assert set(os.listdir(str(datadir))) == {
         "local_directory",
         "hello.txt",
@@ -33,7 +34,12 @@ def test_read_hello(datadir):
     assert contents == "Hello, world!\n"
 
 
-def test_change_test_files(datadir, original_datadir, shared_datadir, request):
+def test_change_test_files(
+    datadir: Path,
+    original_datadir: Path,
+    shared_datadir: Path,
+    request: pytest.FixtureRequest,
+) -> None:
     filename = datadir / "hello.txt"
     with filename.open("w") as fp:
         fp.write("Modified text!\n")
@@ -53,14 +59,14 @@ def test_change_test_files(datadir, original_datadir, shared_datadir, request):
         assert fp.read().strip() == "8000"
 
 
-def test_read_spam_from_other_dir(shared_datadir):
+def test_read_spam_from_other_dir(shared_datadir: Path) -> None:
     filename = shared_datadir / "spam.txt"
     with filename.open() as fp:
         contents = fp.read()
     assert contents == "eggs\n"
 
 
-def test_file_override(shared_datadir, datadir):
+def test_file_override(shared_datadir: Path, datadir: Path) -> None:
     """The same file is in the module dir and global data.
     Shared files are kept in a different temp directory"""
     shared_filepath = shared_datadir / "over.txt"
@@ -70,7 +76,7 @@ def test_file_override(shared_datadir, datadir):
     assert shared_filepath != private_filepath
 
 
-def test_local_directory(datadir):
+def test_local_directory(datadir: Path) -> None:
     directory = datadir / "local_directory"
     assert directory.is_dir()
     filename = directory / "file.txt"
@@ -80,7 +86,7 @@ def test_local_directory(datadir):
     assert contents.strip() == "local contents"
 
 
-def test_shared_directory(shared_datadir):
+def test_shared_directory(shared_datadir: Path) -> None:
     assert shared_datadir.is_dir()
     filename = shared_datadir / "shared_directory" / "file.txt"
     assert filename.is_file()
@@ -89,7 +95,7 @@ def test_shared_directory(shared_datadir):
     assert contents.strip() == "global contents"
 
 
-def test_lazy_copy(lazy_datadir):
+def test_lazy_copy(lazy_datadir: LazyDataDir) -> None:
     # The temporary directory starts empty.
     assert {x.name for x in lazy_datadir.tmp_path.iterdir()} == set()
 
@@ -123,7 +129,7 @@ def test_lazy_copy(lazy_datadir):
     }
 
 
-def test_lazy_copy_sub_directory(lazy_datadir):
+def test_lazy_copy_sub_directory(lazy_datadir: LazyDataDir) -> None:
     """Copy via file by using a sub-directory (#99)."""
     # The temporary directory starts empty.
     assert {x.name for x in lazy_datadir.tmp_path.iterdir()} == set()

tests/test_hello.py

@@ -1,2 +1,5 @@
-def test_missing_data_dir_starts_empty(datadir):
+from pathlib import Path
+
+
+def test_missing_data_dir_starts_empty(datadir: Path) -> None:
     assert list(datadir.iterdir()) == []

tests/test_nonexistent.py

@@ -1,10 +1,11 @@
 import sys
+from pathlib import Path
 
 import pytest
 from pytest_datadir.plugin import _win32_longpath
 
 
-def test_win32_longpath_idempotent(datadir):
+def test_win32_longpath_idempotent(datadir: Path) -> None:
     """Double application should not prepend twice."""
     first = _win32_longpath(str(datadir))
     second = _win32_longpath(first)
@@ -14,7 +15,7 @@ def test_win32_longpath_idempotent(datadir):
 @pytest.mark.skipif(
     not sys.platform.startswith("win"), reason="Only makes sense on Windows"
 )
-def test_win32_longpath_unc(datadir):
+def test_win32_longpath_unc(datadir: Path) -> None:
     unc_path = r"\\ComputerName\SharedFolder\Resource"
     longpath = _win32_longpath(unc_path)
     assert longpath.startswith("\\\\?\\UNC\\")