Adopt ruff and address lint (#69)

Author: blink1073

.github/dependabot.yml

@@ -1,8 +1,10 @@
 version: 2
 updates:
-  # Set update schedule for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      # Check for updates to GitHub Actions every weekday
+      interval: "weekly"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
       interval: "weekly"

.github/workflows/test.yml

@@ -12,12 +12,18 @@ defaults:
     shell: bash -eux {0}
 
 jobs:
-  pre_commit:
+  test_lint:
+    name: Test Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - uses: jupyterlab/maintainer-tools/.github/actions/pre-commit@v1
+      -  name: Run Linters
+         run: |
+          hatch run typing:test
+          hatch run lint:style
+          pipx run 'validate-pyproject[all]' pyproject.toml
+          pipx run doc8 --max-line-length=200
 
   test:
     runs-on: ${{ matrix.os }}
@@ -128,7 +134,7 @@ jobs:
     if: always()
     needs:
       - test
-      - pre_commit
+      - test_lint
       - test_docs
       - test_minimum_versions
       - test_prereleases

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+ci:
+  autoupdate_schedule: monthly
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -15,62 +18,25 @@ repos:
       - id: check-builtin-literals
       - id: trailing-whitespace
 
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-      - id: black
-        args: ["--line-length", "100"]
-
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-        files: \.py$
-        args: [--profile=black]
-
-  - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.10.1
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.19.2
     hooks:
-      - id: validate-pyproject
-        stages: [manual]
+      - id: check-github-workflows
 
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.16
     hooks:
       - id: mdformat
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.0
-    hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
-
-  - repo: https://github.com/PyCQA/doc8
-    rev: v1.0.0
-    hooks:
-      - id: doc8
-        args: [--max-line-length=200]
-        stages: [manual]
-
-  - repo: https://github.com/john-hen/Flake8-pyproject
-    rev: 1.2.2
-    hooks:
-      - id: Flake8-pyproject
-        alias: flake8
         additional_dependencies:
-          ["flake8-bugbear==22.6.22", "flake8-implicit-str-concat==0.2.0"]
-        stages: [manual]
+          [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.991
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
     hooks:
-      - id: mypy
-        exclude: jupyter_client/tests
-        args: ["--config-file", "pyproject.toml"]
-        additional_dependencies: [tornado, pytest, traitlets, jupyter_server>=2.0.0rc5, terminado]
-        stages: [manual]
+      - id: black
 
-  - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.19.2
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.165
     hooks:
-      - id: check-github-workflows
+      - id: ruff
+        args: ["--fix"]

jupyter_server_terminals/api_handlers.py

@@ -10,7 +10,7 @@
     from jupyter_server.auth.decorator import authorized
     from jupyter_server.base.handlers import APIHandler
 except ModuleNotFoundError:
-    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
+    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.") from None
 
 
 AUTH_RESOURCE = "terminals"

jupyter_server_terminals/app.py

@@ -9,11 +9,11 @@
 from .terminalmanager import TerminalManager
 
 try:
+    from jupyter_core.utils import ensure_async
     from jupyter_server.extension.application import ExtensionApp
     from jupyter_server.transutils import trans
-    from jupyter_server.utils import ensure_async
 except ModuleNotFoundError:
-    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
+    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.") from None
 
 
 class TerminalsExtensionApp(ExtensionApp):
@@ -35,7 +35,9 @@ class TerminalsExtensionApp(ExtensionApp):
 
     def initialize_settings(self):
         self.initialize_configurables()
-        self.settings.update(dict(terminals_available=True, terminal_manager=self.terminal_manager))
+        self.settings.update(
+            {"terminals_available": True, "terminal_manager": self.terminal_manager}
+        )
 
     def initialize_configurables(self):
         if os.name == "nt":

jupyter_server_terminals/base.py

@@ -1,7 +1,7 @@
 try:
     from jupyter_server.extension.handler import ExtensionHandlerMixin
 except ModuleNotFoundError:
-    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
+    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.") from None
 
 
 class TerminalsMixin(ExtensionHandlerMixin):

jupyter_server_terminals/handlers.py

@@ -12,7 +12,7 @@
     from jupyter_server.base.handlers import JupyterHandler
     from jupyter_server.base.websocket import WebSocketMixin
 except ModuleNotFoundError:
-    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
+    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.") from None
 
 AUTH_RESOURCE = "terminals"
 
@@ -44,7 +44,7 @@ def get(self, *args, **kwargs):
         elif not self.authorizer.is_authorized(self, user, "execute", self.auth_resource):
             raise web.HTTPError(403)
 
-        if not args[0] in self.term_manager.terminals:
+        if args[0] not in self.term_manager.terminals:
             raise web.HTTPError(404)
         return super().get(*args, **kwargs)
 

jupyter_server_terminals/terminalmanager.py

@@ -18,7 +18,7 @@
         TERMINAL_CURRENTLY_RUNNING_TOTAL,
     )
 except ModuleNotFoundError:
-    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.")
+    raise ModuleNotFoundError("Jupyter Server must be installed to use this extension.") from None
 
 
 class TerminalManager(LoggingConfigurable, NamedTermManager):  # type:ignore[misc]
@@ -86,7 +86,7 @@ async def terminate(self, name, force=False):
 
     async def terminate_all(self):
         """Terminate all terminals."""
-        terms = [name for name in self.terminals]
+        terms = list(self.terminals)
         for term in terms:
             await self.terminate(term, force=True)
 

pyproject.toml

@@ -36,7 +36,7 @@ Homepage = "https://jupyter.org"
 [project.optional-dependencies]
 test = [
   "coverage",
-  "jupyter_server>=2.0.0rc8",
+  "jupyter_server>=2.0.0",
   "pytest-jupyter[server]>=0.5.3",
   "pytest>=7.0",
   "pytest-cov",
@@ -55,14 +55,20 @@ docs = [
 "sphinxcontrib_github_alt",
 "sphinxemoji",
 ]
+lint = [
+  "black[jupyter]>=22.6.0",
+  "mdformat>0.7",
+  "mdformat-gfm>=0.3.5",
+  "ruff>=0.0.156"
+]
+typing = ["mypy>=0.990"]
 
 [tool.hatch.version]
 path = "jupyter_server_terminals/_version.py"
 
 [tool.hatch.build.targets.wheel.shared-data]
 "jupyter-config" = "etc/jupyter/jupyter_server_config.d"
 
-
 [tool.hatch.envs.docs]
 features = ["docs"]
 [tool.hatch.envs.docs.scripts]
@@ -81,6 +87,25 @@ dependencies = ["coverage", "pytest-cov"]
 test = "python -m pytest -vv --cov jupyter_server_terminals --cov-branch --cov-report term-missing:skip-covered {args}"
 nowarn = "test -W default {args}"
 
+[tool.hatch.envs.typing]
+features = ["typing", "test"]
+[tool.hatch.envs.typing.scripts]
+test = "mypy --install-types --non-interactive {args:jupyter_server_terminals tests}"
+
+[tool.hatch.envs.lint]
+features = ["lint"]
+[tool.hatch.envs.lint.scripts]
+style = [
+  "ruff {args:.}",
+  "black --check --diff {args:.}",
+  "mdformat --check {args:docs *.md}"
+]
+fmt = [
+  "black {args:.}",
+  "ruff --fix {args:.}",
+  "mdformat {args:docs *.md}"
+]
+
 [tool.pytest.ini_options]
 addopts = "-raXs --durations 10 --color=yes --doctest-modules"
 testpaths = [
@@ -114,23 +139,56 @@ warn_redundant_casts = true
 warn_return_any = true
 warn_unused_ignores = true
 
-[tool.flake8]
-ignore = "E501, W503, E402"
-builtins = "c, get_config"
-exclude = [
-    ".cache",
-    ".github",
-    "docs",
-    "setup.py",
+[tool.black]
+line-length = 100
+skip-string-normalization = true
+target-version = ["py37"]
+
+[tool.ruff]
+target-version = "py37"
+line-length = 100
+select = [
+  "A", "B", "C", "E", "F", "FBT", "I", "N", "Q", "RUF", "S", "T",
+  "UP", "W", "YTT",
 ]
-enable-extensions = "G"
-extend-ignore = [
-    "G001", "G002", "G004", "G200", "G201", "G202",
-    # black adds spaces around ':'
-    "E203",
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Ignore McCabe complexity
+  "C901",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Use of `assert` detected
+  "S101",
+  # Line too long
+  "E501",
+  # Relative imports are banned
+  "I252",
+  # Boolean ... in function definition
+  "FBT001", "FBT002",
+  # Module level import not at top of file
+  "E402",
+  # A001/A002/A003 .. is shadowing a python builtin
+  "A001", "A002", "A003",
+  # Possible hardcoded password
+  "S105", "S106",
+  # Q000 Single quotes found but double quotes preferred
+  "Q000",
+  # N806 Variable `B` in function should be lowercase
+  "N806",
+  # T201 `print` found
+  "T201",
+  # N802 Function name `CreateWellKnownSid` should be lowercase
+  "N802", "N803"
 ]
-per-file-ignores = [
-    # B011: Do not call assert False since python -O removes these calls
-    # F841 local variable 'foo' is assigned to but never used
-    "tests/*: B011", "F841",
+unfixable = [
+  # Don't touch print statements
+  "T201",
+  # Don't touch noqa lines
+  "RUF100",
 ]
+
+[tool.ruff.per-file-ignores]
+# B011: Do not call assert False since python -O removes these calls
+# F841 local variable 'foo' is assigned to but never used
+"tests/*" = ["B011", "F841"]