Clean up lint and move tests out of source (#299)

jupyter · Nov 5, 2023 · 3ab6a7b · 3ab6a7b
1 parent f7c0019
commit 3ab6a7b
Show file tree

Hide file tree

Showing 38 changed files with 49 additions and 79 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Run Linters
         run: |
           hatch run typing:test
-          hatch run lint:style
+          hatch run lint:build
           pipx run interrogate -v .
           pipx run doc8 --max-line-length=200
 
@@ -41,13 +41,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
-        exclude:
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.8", "3.11"]
+        include:
           - os: windows-latest
-            python-version: 3.8
-          - os: windows-latest
-            python-version: 3.9
+            python-version: "3.9"
+          - os: ubuntu-latest
+            python-version: "pypy-3.8"
+          - os: ubuntu-latest
+            python-version: "3.12"
+          - os: macos-latest
+            python-version: "3.10"
     steps:
       - name: Checkout
         uses: actions/checkout@v4

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -57,6 +57,21 @@ repos:
       - id: rst-directive-colons
       - id: rst-inline-touching-normal
 
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.6.1"
+    hooks:
+      - id: mypy
+        files: "^nbclient"
+        stages: [manual]
+        args: ["--install-types", "--non-interactive"]
+        additional_dependencies:
+          [
+            "traitlets>=5.13",
+            "jupyter_core>=5.3.2",
+            "jupyter_client",
+            "nbformat",
+          ]
+
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.1.3
     hooks:

diff --git a/docs/index.rst b/docs/index.rst
@@ -64,7 +64,6 @@ this documentation section will help you.
    :caption: Table of Contents
 
    reference/index.rst
-   reference/nbclient.tests.rst
 
 Indices and tables
 ------------------

diff --git a/docs/reference/nbclient.rst b/docs/reference/nbclient.rst
@@ -4,10 +4,6 @@ nbclient package
 Subpackages
 -----------
 
-.. toctree::
-
-   nbclient.tests
-
 Submodules
 ----------
 

diff --git a/docs/reference/nbclient.tests.rst b/docs/reference/nbclient.tests.rst
diff --git a/nbclient/cli.py b/nbclient/cli.py
@@ -47,7 +47,7 @@ class NbClientApp(JupyterApp):
     flags = nbclient_flags
 
     description = "An application used to execute notebook files (*.ipynb)"
-    notebooks = List([], help="Path of notebooks to convert").tag(config=True)
+    notebooks = List(Unicode(), help="Path of notebooks to convert").tag(config=True)
     timeout = Integer(
         None,
         allow_none=True,

diff --git a/nbclient/client.py b/nbclient/client.py
@@ -494,9 +494,9 @@ def create_kernel_manager(self) -> KernelManager:
                 self.kernel_name = kn
 
         if not self.kernel_name:
-            self.km = self.kernel_manager_class(config=self.config)  # type:ignore[operator]
+            self.km = self.kernel_manager_class(config=self.config)
         else:
-            self.km = self.kernel_manager_class(kernel_name=self.kernel_name, config=self.config)  # type:ignore[operator]
+            self.km = self.kernel_manager_class(kernel_name=self.kernel_name, config=self.config)
         assert self.km is not None
         return self.km
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -84,6 +84,7 @@ path = "nbclient/_version.py"
 [tool.hatch.build.targets.sdist]
 include = [
     "/nbclient",
+    "/tests"
 ]
 
 [tool.hatch.envs.docs]
@@ -104,40 +105,27 @@ dependencies = ["coverage[toml]", "pytest-cov"]
 test = "python -m pytest -vv --cov nbclient --cov-branch --cov-report term-missing:skip-covered {args}"
 nowarn = "test -W default {args}"
 
-[tool.hatch.envs.typing]
-features = ["test"]
-dependencies = ["mypy~=1.6", "traitlets>=5.11.2", "jupyter_core>=5.3.2"]
-[tool.hatch.envs.typing.scripts]
-test = "mypy --install-types --non-interactive {args}"
-
 [tool.hatch.envs.lint]
-dependencies = [
-  "mdformat>0.7",
-  "mdformat-gfm>=0.3.5",
-  "ruff==0.1.3"
-]
 detached = true
+dependencies = ["pre-commit"]
 [tool.hatch.envs.lint.scripts]
-style = [
-  "ruff {args:.}",
-  "ruff format {args:.}",
-  "mdformat --check {args:docs *.md}"
-]
-fmt = [
-  "ruff --fix {args:.}",
-  "ruff format {args:.}",
-  "mdformat {args:docs *.md}"
-]
+build = "pre-commit run --all-files ruff"
+
+[tool.hatch.envs.typing]
+dependencies = [ "pre-commit"]
+detached = true
+[tool.hatch.envs.typing.scripts]
+test = "pre-commit run --all-files --hook-stage manual mypy"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 xfail_strict = true
 log_cli_level = "info"
 addopts = [
-  "-raXs", "--durations=10", "--color=yes", "--doctest-modules",
+  "-ra", "--durations=10", "--color=yes", "--doctest-modules",
    "--showlocals", "--strict-markers", "--strict-config"
 ]
-testpaths = ["nbclient/tests"]
+testpaths = ["tests"]
 filterwarnings= [
   # Fail on warnings
   "error",
@@ -146,7 +134,10 @@ filterwarnings= [
   "module:There is no current event loop:DeprecationWarning",
   "module:unclosed event loop:ResourceWarning",
   "module:Unclosed socket <zmq:ResourceWarning",
+  "module:zmq.eventloop.ioloop is deprecated:DeprecationWarning",
   "module:subprocess .* is still running:ResourceWarning",
+  "module:Unclosed context <zmq:ResourceWarning",
+  "module:datetime.datetime.utc:DeprecationWarning",
 ]
 asyncio_mode = "auto"
 
@@ -204,7 +195,7 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 # S101 Use of `assert` detected
-"nbclient/tests/*" = ["S101"]
+"tests/*" = ["S101"]
 "nbclient/client.py" = ["S101"]
 
 [tool.interrogate]
@@ -215,7 +206,7 @@ ignore-property-decorators=true
 ignore-nested-functions=true
 ignore-nested-classes=true
 fail-under=100
-exclude = ["nbclient/tests", "docs"]
+exclude = ["tests", "docs"]
 
 [tool.repo-review]
-ignore = ["PY005", "PY007", "PP308", "GH102", "PC140"]
+ignore = ["PY005", "PY007", "GH102"]
diff --git a/nbclient/tests/__init__.py → tests/__init__.py b/nbclient/tests/__init__.py → tests/__init__.py
diff --git a/nbclient/tests/base.py → tests/base.py b/nbclient/tests/base.py → tests/base.py
diff --git a/nbclient/tests/conftest.py → tests/conftest.py b/nbclient/tests/conftest.py → tests/conftest.py
diff --git a/nbclient/tests/fake_kernelmanager.py → tests/fake_kernelmanager.py b/nbclient/tests/fake_kernelmanager.py → tests/fake_kernelmanager.py
diff --git a/nbclient/tests/files/Autokill.ipynb → tests/files/Autokill.ipynb b/nbclient/tests/files/Autokill.ipynb → tests/files/Autokill.ipynb
diff --git a/...tests/files/Check History in Memory.ipynb → tests/files/Check History in Memory.ipynb b/...tests/files/Check History in Memory.ipynb → tests/files/Check History in Memory.ipynb
diff --git a/nbclient/tests/files/Clear Output.ipynb → tests/files/Clear Output.ipynb b/nbclient/tests/files/Clear Output.ipynb → tests/files/Clear Output.ipynb
diff --git a/nbclient/tests/files/Disable Stdin.ipynb → tests/files/Disable Stdin.ipynb b/nbclient/tests/files/Disable Stdin.ipynb → tests/files/Disable Stdin.ipynb
diff --git a/nbclient/tests/files/Empty Cell.ipynb → tests/files/Empty Cell.ipynb b/nbclient/tests/files/Empty Cell.ipynb → tests/files/Empty Cell.ipynb
diff --git a/nbclient/tests/files/Error.ipynb → tests/files/Error.ipynb b/nbclient/tests/files/Error.ipynb → tests/files/Error.ipynb
diff --git a/nbclient/tests/files/Factorials.ipynb → tests/files/Factorials.ipynb b/nbclient/tests/files/Factorials.ipynb → tests/files/Factorials.ipynb
diff --git a/nbclient/tests/files/HelloWorld.ipynb → tests/files/HelloWorld.ipynb b/nbclient/tests/files/HelloWorld.ipynb → tests/files/HelloWorld.ipynb
diff --git a/nbclient/tests/files/Inline Image.ipynb → tests/files/Inline Image.ipynb b/nbclient/tests/files/Inline Image.ipynb → tests/files/Inline Image.ipynb
diff --git a/nbclient/tests/files/Interrupt.ipynb → tests/files/Interrupt.ipynb b/nbclient/tests/files/Interrupt.ipynb → tests/files/Interrupt.ipynb
diff --git a/nbclient/tests/files/JupyterWidgets.ipynb → tests/files/JupyterWidgets.ipynb b/nbclient/tests/files/JupyterWidgets.ipynb → tests/files/JupyterWidgets.ipynb
diff --git a/nbclient/tests/files/Other Comms.ipynb → tests/files/Other Comms.ipynb b/nbclient/tests/files/Other Comms.ipynb → tests/files/Other Comms.ipynb
diff --git a/nbclient/tests/files/Output.ipynb → tests/files/Output.ipynb b/nbclient/tests/files/Output.ipynb → tests/files/Output.ipynb
diff --git a/...ient/tests/files/Parallel Execute A.ipynb → tests/files/Parallel Execute A.ipynb b/...ient/tests/files/Parallel Execute A.ipynb → tests/files/Parallel Execute A.ipynb
diff --git a/...ient/tests/files/Parallel Execute B.ipynb → tests/files/Parallel Execute B.ipynb b/...ient/tests/files/Parallel Execute B.ipynb → tests/files/Parallel Execute B.ipynb
diff --git a/nbclient/tests/files/SVG.ipynb → tests/files/SVG.ipynb b/nbclient/tests/files/SVG.ipynb → tests/files/SVG.ipynb
diff --git a/...iles/Skip Exceptions with Cell Tags.ipynb → ...iles/Skip Exceptions with Cell Tags.ipynb b/...iles/Skip Exceptions with Cell Tags.ipynb → ...iles/Skip Exceptions with Cell Tags.ipynb
diff --git a/nbclient/tests/files/Skip Exceptions.ipynb → tests/files/Skip Exceptions.ipynb b/nbclient/tests/files/Skip Exceptions.ipynb → tests/files/Skip Exceptions.ipynb
diff --git a/.../files/Skip Execution with Cell Tag.ipynb → .../files/Skip Execution with Cell Tag.ipynb b/.../files/Skip Execution with Cell Tag.ipynb → .../files/Skip Execution with Cell Tag.ipynb
diff --git a/nbclient/tests/files/Sleep1s.ipynb → tests/files/Sleep1s.ipynb b/nbclient/tests/files/Sleep1s.ipynb → tests/files/Sleep1s.ipynb
diff --git a/nbclient/tests/files/Unicode.ipynb → tests/files/Unicode.ipynb b/nbclient/tests/files/Unicode.ipynb → tests/files/Unicode.ipynb
diff --git a/nbclient/tests/files/UnicodePy3.ipynb → tests/files/UnicodePy3.ipynb b/nbclient/tests/files/UnicodePy3.ipynb → tests/files/UnicodePy3.ipynb
diff --git a/nbclient/tests/files/python.png → tests/files/python.png b/nbclient/tests/files/python.png → tests/files/python.png
diff --git a/nbclient/tests/files/update-display-id.ipynb → tests/files/update-display-id.ipynb b/nbclient/tests/files/update-display-id.ipynb → tests/files/update-display-id.ipynb
diff --git a/nbclient/tests/test_client.py → tests/test_client.py b/nbclient/tests/test_client.py → tests/test_client.py
@@ -352,6 +352,7 @@ def test_run_all_notebooks(input_name, opts):
     assert_notebooks_equal(input_nb, output_nb)
 
 
+@flaky
 def test_parallel_notebooks(capfd, tmpdir):
     """Two notebooks should be able to be run simultaneously without problems.
 
@@ -377,6 +378,7 @@ def test_parallel_notebooks(capfd, tmpdir):
     assert filter_messages_on_error_output(captured.err) == ""
 
 
+@flaky
 @pytest.mark.skipif(os.name == "nt", reason="warns about event loop on Windows")
 def test_many_parallel_notebooks(capfd):
     """Ensure that when many IPython kernels are run in parallel, nothing awful happens.
@@ -404,6 +406,7 @@ def test_many_parallel_notebooks(capfd):
     assert filter_messages_on_error_output(captured.err) == ""
 
 
+@flaky
 def test_async_parallel_notebooks(capfd, tmpdir):
     """Two notebooks should be able to be run simultaneously without problems.
 

diff --git a/nbclient/tests/test_util.py → tests/test_util.py b/nbclient/tests/test_util.py → tests/test_util.py