Adopt ruff and address lint (#321)

jupyter · Dec 13, 2022 · bc81ed6 · bc81ed6
1 parent dc10306
commit bc81ed6
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 69 deletions.
diff --git a/.github/dependabot.yml b/.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"
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -85,6 +85,19 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - run: hatch run docs:build
 
+  test_lint:
+    name: Test Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@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
+
   make_sdist:
     name: Make SDist
     runs-on: ubuntu-latest
@@ -103,14 +116,6 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/test-sdist@v1
 
-  pre_commit:
-    name: pre-commit
-    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
-
   check_release:
     runs-on: ubuntu-latest
     steps:
@@ -139,7 +144,7 @@ jobs:
     if: always()
     needs:
       - build
-      - pre_commit
+      - test_lint
       - test_docs
       - test_minimum_versions
       - test_prereleases

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,8 +1,10 @@
+ci:
+  autoupdate_schedule: monthly
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
-      - id: debug-statements
       - id: end-of-file-fixer
       - id: check-case-conflict
       - id: check-executables-have-shebangs
@@ -11,72 +13,28 @@ repos:
       - id: check-case-conflict
       - id: check-toml
       - id: check-yaml
+      - id: debug-statements
       - id: forbid-new-submodules
       - 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
-        additional_dependencies:
-          [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
 
-  - 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/pycqa/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          ["flake8-bugbear==22.6.22", "flake8-implicit-str-concat==0.2.0"]
-        stages: [manual]
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.991
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
     hooks:
-      - id: mypy
-        args: ["--config-file", "pyproject.toml"]
-        stages: [manual]
-        additional_dependencies: [pytest, platformdirs, traitlets, ipykernel]
-        exclude: |
-          exclude: |
-            (?x)^(
-              jupyter_core/tests/.*_config.py |
-              scripts/jupyter
-            )$
+      - 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"]
diff --git a/jupyter_core/application.py b/jupyter_core/application.py
@@ -59,7 +59,7 @@
 base_flags.update(_jupyter_flags)
 
 
-class NoStart(Exception):
+class NoStart(Exception):  # noqa
     """Exception to raise when an application shouldn't start"""
 
 

diff --git a/jupyter_core/paths.py b/jupyter_core/paths.py
@@ -174,7 +174,7 @@ def jupyter_runtime_dir() -> str:
     ).split(os.pathsep)
 else:
     deprecation(
-        "Jupyter is migrating its paths to use standard platformdirs\n"  # noqa
+        "Jupyter is migrating its paths to use standard platformdirs\n"
         + "given by the platformdirs library.  To remove this warning and\n"
         + "see the appropriate new directories, set the environment variable\n"
         + "`JUPYTER_PLATFORM_DIRS=1` and then run `jupyter --paths`.\n"

diff --git a/pyproject.toml b/pyproject.toml
@@ -51,6 +51,8 @@ docs = [
   "sphinxcontrib_github_alt",
   "traitlets",
 ]
+lint = ["black>=22.6.0", "mdformat>0.7", "ruff>=0.0.156"]
+typing = ["mypy>=0.990"]
 
 [project.scripts]
 jupyter = "jupyter_core.command:main"
@@ -81,6 +83,26 @@ dependencies = ["coverage", "pytest-cov"]
 test = "python -m pytest -vv --cov jupyter_core --cov-branch --cov-report term-missing:skip-covered {args}"
 nowarn = "test -W default {args}"
 
+[tool.hatch.envs.typing]
+features = ["test", "typing"]
+dependencies = ["mypy>=0.990"]
+[tool.hatch.envs.typing.scripts]
+test = "mypy --install-types --non-interactive {args:.}"
+
+[tool.hatch.envs.lint]
+features = ["lint"]
+[tool.hatch.envs.lint.scripts]
+style = [
+  "ruff {args:.}",
+  "black --check --diff {args:.}",
+  "mdformat --check {args:*.md}"
+]
+fmt = [
+  "black {args:.}",
+  "ruff --fix {args:.}",
+  "mdformat {args:*.md}"
+]
+
 [tool.mypy]
 check_untyped_defs = true
 disallow_any_generics = true
@@ -97,6 +119,9 @@ warn_unused_configs = true
 warn_redundant_casts = true
 warn_return_any = true
 warn_unused_ignores = true
+exclude = [
+  "jupyter_core/tests/.*/profile_default/.*_config.py"
+]
 
 [tool.pytest.ini_options]
 addopts = "-raXs --durations 10 --color=yes --doctest-modules --ignore-glob=jupyter_core/tests/dotipython*"
@@ -123,3 +148,64 @@ exclude_lines = [
   "class .*\bProtocol\\):",
 "@(abc\\.)?abstractmethod",
 ]
+
+[tool.black]
+line-length = 100
+skip-string-normalization = true
+target-version = ["py38"]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 100
+select = [
+  "A", "B", "C", "E", "F", "FBT", "I", "N", "Q", "RUF", "S", "T",
+  "UP", "W", "YTT",
+]
+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"
+]
+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
+# C408 Unnecessary `dict` call
+# E402 Module level import not at top of file
+# T201 `print` found
+# B007 Loop control variable `i` not used within the loop body.
+# N802 Function name `assertIn` should be lowercase
+"tests/*" = ["B011", "F841", "C408", "E402", "T201", "B007", "N802"]
+# F821 Undefined name `get_config`
+"jupyter_core/tests/**/profile_default/*_config.py" = ["F821"]