initial commit

Author: skshetry

.github/workflows/tests.yaml

@@ -0,0 +1,16 @@
+name: Tests
+on: push
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9', '3.10']
+    name: Python ${{ matrix.python-version }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - run: pip install -U nox pip wheel
+    - run: nox

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+  - hooks:
+      - id: black
+        language_version: python3
+    repo: https://github.com/ambv/black
+    rev: 21.11b1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=cachable
+    repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+  - hooks:
+      - id: isort
+        language_version: python3
+    repo: https://github.com/timothycrosley/isort
+    rev: 5.10.1
+  - hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-debugger
+          - flake8-string-format
+          - flake8-bandit
+    repo: https://gitlab.com/pycqa/flake8
+    rev: 3.9.2

README.md

@@ -1 +1 @@
-# pytest-test-utils
+# pytest-test-utils

noxfile.py

@@ -0,0 +1,28 @@
+"""Automation using nox.
+"""
+import nox
+
+nox.options.reuse_existing_virtualenvs = True
+nox.options.sessions = "lint", "tests"
+locations = "pytest_test_utils", "tests.py"
+
+
+@nox.session(python=["3.7", "3.8", "3.9", "3.10"])
+def tests(session: nox.Session) -> None:
+    session.install("-e", ".[dev]")
+    session.run("pytest")
+
+
+@nox.session
+def lint(session: nox.Session) -> None:
+    session.install("pre-commit")
+    session.install("-e", ".[dev]")
+
+    if session.posargs:
+        args = session.posargs + ["--all-files"]
+    else:
+        args = ["--all-files", "--show-diff-on-failure"]
+
+    session.run("pre-commit", "run", *args)
+    session.run("python", "-m", "mypy")
+    session.run("python", "-m", "pylint", *locations)

pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=48", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 79
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+line_length = 79
+
+[tool.mypy]
+# Error output
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+show_traceback = true
+pretty = true
+check_untyped_defs = true
+strict = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_unreachable = true
+files = ["pytest_test_utils"]
+
+[tool.pylint.message_control]
+enable = ["no-else-return"]
+disable = ["missing-function-docstring", "missing-module-docstring", "missing-class-docstring"]
+
+[tool.pytest.ini_options]
+testpaths = ["./tests.py"]

pytest_test_utils/__init__.py

@@ -0,0 +1,4 @@
+from ._any import ANY
+from .tmp_dir import TmpDir
+
+__all__ = ["ANY", "TmpDir"]

pytest_test_utils/_any.py

@@ -0,0 +1,12 @@
+from typing import Any, Type
+
+
+class ANY:
+    def __init__(self, expected_type: Type[object]) -> None:
+        self.expected_type: Type[object] = expected_type
+
+    def __repr__(self) -> str:
+        return "Any({self.expected_type.__name__})"
+
+    def __eq__(self, other: Any) -> bool:
+        return isinstance(other, self.expected_type)

pytest_test_utils/conftest.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+from typing import Iterator
+
+import pytest
+
+from .tmp_dir import TmpDir
+
+
+@pytest.fixture
+def tmp_dir(
+    tmp_path: Path, monkeypatch: pytest.MonkeyPatch
+) -> Iterator[TmpDir]:
+    tmp = TmpDir(tmp_path)
+    monkeypatch.chdir(tmp)
+    yield tmp

pytest_test_utils/pytest_plugin.py

@@ -0,0 +1,34 @@
+import os
+from contextlib import contextmanager
+from pathlib import Path
+
+
+class TmpDir(type(Path())):  # type: ignore
+    def gen(self, struct, text=""):
+        if isinstance(struct, (str, bytes, os.PathLike)):
+            struct = {struct: text}
+        for name, contents in struct.items():
+            path = self / os.fsdecode(name)
+
+            if isinstance(contents, dict):
+                if not contents:
+                    path.mkdir(parents=True, exist_ok=True)
+                else:
+                    path.gen(contents)
+            else:
+                path.parent.mkdir(parents=True, exist_ok=True)
+                if isinstance(contents, bytes):
+                    path.write_bytes(contents)
+                else:
+                    path.write_text(contents, encoding="utf-8")
+
+        return list(struct.keys())
+
+    @contextmanager
+    def chdir(self):
+        old = os.getcwd()
+        try:
+            os.chdir(self)
+            yield
+        finally:
+            os.chdir(old)

pytest_test_utils/tmp_dir.py

@@ -0,0 +1,18 @@
+import os
+from pathlib import Path
+from typing import Any, Dict, List, TypeVar, Union, overload
+
+T = TypeVar("T", str, bytes)
+Text = Union[str, bytes]
+AnyPath = Union[T, os.PathLike[T]]
+AnyStruct = Dict[AnyPath[T], Union[Text, Dict[AnyPath[T], Any]]]
+StrStruct = AnyStruct[str]
+BytesStruct = AnyStruct[bytes]
+
+class TmpDir(Path):
+    @overload
+    def gen(self, struct: AnyPath[T], text: Text = "") -> List[T]: ...
+    @overload
+    def gen(self, struct: BytesStruct, text: Text = "") -> List[bytes]: ...
+    @overload
+    def gen(self, struct: StrStruct, text: Text = "") -> List[str]: ...

pytest_test_utils/tmp_dir.pyi

@@ -0,0 +1,47 @@
+[metadata]
+name = pytest_test_utils
+version = 0.0.1
+license = Apache License 2.0
+license_file = LICENSE
+url = https://github.com/iterative/pytest-test-utils
+platforms=any
+authors = Saugat Pachhai
+maintainer_email = [email protected]
+classifiers =
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Framework :: Pytest
+
+[options]
+python_requires = >=3.7
+zip_safe = False
+packages = find:
+install_requires=
+    pytest
+
+[options.extras_require]
+dev =
+    pytest==6.2.5
+    pytest-sugar==0.9.4
+    pylint==2.11.1
+    mypy==0.910
+
+[options.entry_points]
+pytest11 =
+    pytest_test_utils = pytest_test_utils.pytest_plugin
+
+[flake8]
+ignore=
+    E203, # Whitespace before ':'
+    E266, # Too many leading '#' for block comment
+    W503, # Line break occurred before a binary operator
+    P1,  # unindexed parameters in the str.format, see:
+    # https://pypi.org/project/flake8-string-format/
+max_line_length = 79
+max-complexity = 15
+select = B,C,E,F,W,T4,B902,T,P
+show_source = true
+count = true

setup.cfg

@@ -0,0 +1,39 @@
+import os
+
+from pytest_test_utils import TmpDir
+
+
+def test_is_tmp_dir(tmp_dir: TmpDir) -> None:
+    assert isinstance(tmp_dir, TmpDir)
+
+
+def test_gen_str(tmp_dir: TmpDir) -> None:
+    assert tmp_dir.gen("foo", "lorem ipsum") == ["foo"]
+    assert (tmp_dir / "foo").read_text() == "lorem ipsum"
+
+
+def test_gen_bytes(tmp_dir: TmpDir) -> None:
+    assert tmp_dir.gen(b"foo", "lorem ipsum") == [b"foo"]
+    assert (tmp_dir / os.fsdecode(b"foo")).read_bytes() == b"lorem ipsum"
+
+
+def test_gen_dict_str(tmp_dir: TmpDir) -> None:
+    assert tmp_dir.gen({"file": "lorem", "dir": {"file": "ipsum"}}) == [
+        "file",
+        "dir",
+    ]
+    assert (tmp_dir / "file").read_text() == "lorem"
+    assert (tmp_dir / "dir").is_dir()
+    assert (tmp_dir / "dir" / "file").read_text() == "ipsum"
+
+
+def test_gen_dict_bytes(tmp_dir: TmpDir) -> None:
+    assert tmp_dir.gen({b"file": b"lorem", b"dir": {b"file": b"ipsum"}}) == [
+        b"file",
+        b"dir",
+    ]
+    assert (tmp_dir / os.fsdecode("file")).read_bytes() == b"lorem"
+    assert (tmp_dir / os.fsdecode("dir")).is_dir()
+    assert (
+        tmp_dir / os.fsdecode("dir") / os.fsdecode("file")
+    ).read_bytes() == b"ipsum"