Adopt ruff and clean up pre-commit (jupyterlab#13562)

* adopt ruff and clean up pre-commit * ignore changelog.md * reinstate prints * reinstate print * reinstate print * reinstate imports * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * reinstate prints * print fixups * fixups in labapp * lint and fix output * Fix latest linter errors * sync pre-commit and pyproject versions * use local versions of black, ruff * formatting * Update snapshots * Correct gutter lines Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Frédéric Collonval <[email protected]> Co-authored-by: Frédéric Collonval <[email protected]>
skyetim · Jan 19, 2023 · 834680b · 834680b
1 parent c253a94
commit 834680b
Show file tree

Hide file tree

Showing 94 changed files with 510 additions and 547 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,5 +4,11 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      # Check for updates to GitHub Actions every weekday
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+  # Set update schedule for pip
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
       interval: "weekly"
diff --git a/.github/workflows/linuxtests.yml b/.github/workflows/linuxtests.yml
@@ -149,14 +149,3 @@ jobs:
         with:
           ignore_glob: "packages/ui-components/docs/source/ui_components.rst images"
           ignore_links: "../api/*.* .*/images/[\\w-]+.png https://docs.github.com/en/.* https://jupyterlab.github.io"
-
-  pre-commit:
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
-    steps:
-      - uses: actions/checkout@v3
-      - name: Base Setup
-        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - name: Install Jupyterlab
-        run: pip install -e .
-      - uses: pre-commit/[email protected]
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 ci:
   # skip any check that needs internet access
-  skip: [check-jsonschema, prettier, eslint, stylelint, integrity]
+  skip: [prettier, eslint, stylelint]
 
 default_language_version:
   node: system
@@ -24,44 +24,21 @@ repos:
       - id: trailing-whitespace
         exclude: .bumpversion.cfg
 
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.19.2
+    hooks:
+      - id: check-github-workflows
+
   - repo: https://github.com/psf/black
     rev: 22.12.0
     hooks:
       - id: black
-        args: ['--line-length', '100']
-
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.11.4
-    hooks:
-      - id: isort
-        files: \.py$
-        args: [--profile=black]
-
-  - 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'
-          ]
-
-  - 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/sirosen/check-jsonschema
-    rev: 0.20.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.177
     hooks:
-      - id: check-jsonschema
-        name: 'Check GitHub Workflows'
-        files: ^\.github/workflows/
-        types: [yaml]
-        args: ['--schemafile', 'https://json.schemastore.org/github-workflow']
+      - id: ruff
+        args: ["--fix"]
 
   - repo: local
     hooks:

diff --git a/.prettierignore b/.prettierignore
@@ -6,6 +6,7 @@
 **/static
 **/.ipynb_checkpoints
 tests/**/coverage
+CHANGELOG.md
 
 .eggs
 dev_mode/index.js

diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ To learn more about extensions, see the [user documentation](https://jupyterlab.
 
 Read the current JupyterLab documentation on [ReadTheDocs](http://jupyterlab.readthedocs.io/en/stable/).
 
-______________________________________________________________________
+---
 
 ## Getting started
 
@@ -92,7 +92,7 @@ The latest versions of the following browsers are currently _known to work_:
 
 See our [documentation](http://jupyterlab.readthedocs.io/en/latest/getting_started/installation.html) for additional details.
 
-______________________________________________________________________
+---
 
 ## Getting help
 
@@ -106,7 +106,7 @@ To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/e
 
 We also welcome suggestions for new features as they help make the project more useful for everyone. To request a feature please use the [feature request template](https://github.com/jupyterlab/jupyterlab/issues/new?labels=enhancement%2C+status%3ANeeds+Triage&template=feature_request.md).
 
-______________________________________________________________________
+---
 
 ## Development
 
@@ -165,7 +165,7 @@ Maintainer emeritus:
 This list is provided to give the reader context on who we are and how our team functions.
 To be listed, please submit a pull request with your information.
 
-______________________________________________________________________
+---
 
 ### Weekly Dev Meeting
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -280,7 +280,7 @@ Now do the actual final release:
 - [ ] Create a branch for the release and push to GitHub
 - [ ] Update the API [docs](#updating-api-docs)
 - [ ] Merge the PRs on the other repos and set the default branch of the
-  xckd repo
+      xckd repo
 - [ ] Publish to [conda-forge](https://github.com/jupyterlab/jupyterlab/blob/master/RELEASE.md#publishing-to-conda-forge).
 
 After a few days (to allow for possible patch releases), set up development for

diff --git a/binder/jupyter_notebook_config.py b/binder/jupyter_notebook_config.py
@@ -1,5 +1,6 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+import logging
 
 common = [
     "--no-browser",
@@ -41,6 +42,4 @@
     },
 }
 
-import logging
-
 c.ServerApp.log_level = logging.DEBUG
diff --git a/binder/start b/binder/start
@@ -2,9 +2,9 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import sys
-import shutil
 import os
+import shutil
+import sys
 
 argv = sys.argv[1:] + [
     "--debug",
@@ -17,16 +17,15 @@ argv = sys.argv[1:] + [
     "--config",
     "binder/jupyter_notebook_config.py",
 ]
-print(argv)
-
+print(argv)  # noqa
 
 # Convert from jupyter-notebook based to jupyter-lab based start-up
 def nb2jps(s):
     return s.replace("jupyter-notebook", "jupyter-lab").replace("--NotebookApp.", "--ServerApp.")
 
 
 new_argv = list(map(nb2jps, argv.copy()))
-print(new_argv)
+print(new_argv)  # noqa
 
 with open(".startup_args.txt", "w") as fid:
     fid.write(str(new_argv))

diff --git a/clean.py b/clean.py
@@ -18,7 +18,7 @@
 subprocess.check_call("python -m pip uninstall -y jupyterlab".split(), cwd=here)
 
 
-def resolvePattern(pat):
+def resolve_pattern(pat):
     """handle a leading `#` or `@` in a pattern"""
     pat = pat.strip()
 
@@ -33,7 +33,7 @@ def resolvePattern(pat):
 
 # get the exclude patterns listed in .cleanignore
 with open(os.path.join(here, ".cleanignore")) as f:
-    git_clean_exclude = [f"--exclude={pat}" for line in f for pat in resolvePattern(line)]
+    git_clean_exclude = [f"--exclude={pat}" for line in f for pat in resolve_pattern(line)]
 
 git_clean_command = ["git", "clean", "-dfx"] + git_clean_exclude
 subprocess.check_call(git_clean_command, cwd=here)
diff --git a/conftest.py b/conftest.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 

diff --git a/design/about.md b/design/about.md
@@ -96,6 +96,6 @@ The About Plugin will feature an interactive guide for the user to scroll throug
 
 Motion will also be implemented in our animations for each feature, using a moving image format (\_.gif or \_.gifv file) of a UX demonstration of a real screen, to show users not only where and what each feature looks like, but also how to actually use each feature in real time.
 
-______________________________________________________________________
+---
 
 Please let our team know if you have any questions, suggestions, or comments about the design of the About plugin. Thank you!
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
@@ -67,7 +66,7 @@
 
 # General information about the project.
 project = "JupyterLab"
-copyright = f"2018-{time.localtime().tm_year}, Project Jupyter"
+copyright = f"2018-{time.localtime().tm_year}, Project Jupyter"  # noqa
 author = "Project Jupyter"
 
 
@@ -78,7 +77,7 @@
 _version_py = HERE.parent.parent / "jupyterlab" / "_version.py"
 version_ns = {}
 
-exec(_version_py.read_text(), version_ns)
+exec(_version_py.read_text(), version_ns)  # noqa
 
 # The short X.Y version.
 version = "{0:d}.{1:d}".format(*version_ns["version_info"])
@@ -118,15 +117,13 @@ def build_api_docs(out_dir: Path):
     if api_index.exists():
         # avoid rebuilding docs because it takes forever
         # `make clean` to force a rebuild
-        print(f"already have {api_index!s}")
+        pass
     else:
-        print("Building jupyterlab API docs")
         check_call(jlpm, cwd=str(root))
         check_call(jlpm + ["build:packages"], cwd=str(root))
         check_call(jlpm + ["docs"], cwd=str(root))
 
     dest_dir = out_dir / "api"
-    print(f"Copying {docs_api!s} -> {dest_dir!s}")
     if dest_dir.exists():
         shutil.rmtree(str(dest_dir))
     shutil.copytree(str(docs_api), str(dest_dir))
@@ -173,7 +170,6 @@ def copy_automated_screenshots(temp_folder: Path) -> List[Path]:
     Returns:
         List of copied files
     """
-    print(f"\n\n{temp_folder}\n")
     docs = HERE.parent
     root = docs.parent
 
@@ -386,8 +382,8 @@ def clean_code_files(tmp_files, app, exception):
         """Remove temporary folder."""
         try:
             shutil.rmtree(str(Path(app.srcdir) / SNIPPETS_FOLDER))
-        except Exception as e:
-            print(f"Fail to remove temporary snippet folder: {e}")
+        except Exception:
+            pass
 
         for f in tmp_files:
             f.unlink()

diff --git a/examples/app/example.ipynb b/examples/app/example.ipynb
@@ -35,6 +35,7 @@
    ],
    "source": [
     "import sys\n",
+    "\n",
     "print('hello world', flush=True)\n",
     "for i in range(3):\n",
     "    print(i, flush=True)\n",
@@ -98,6 +99,7 @@
    ],
    "source": [
     "from IPython.display import Image\n",
+    "\n",
     "Image('./jupyter.png')"
    ]
   },
@@ -134,7 +136,9 @@
    ],
    "source": [
     "from IPython.display import Latex\n",
-    "Latex('''The mass-energy equivalence is described by the famous equation\n",
+    "\n",
+    "Latex(\n",
+    "    '''The mass-energy equivalence is described by the famous equation\n",
     " \n",
     "$$E=mc^2$$\n",
     " \n",
@@ -143,7 +147,8 @@
     " \n",
     "\\\\begin{equation}\n",
     "E=m\n",
-    "\\\\end{equation}''')"
+    "\\\\end{equation}'''\n",
+    ")"
    ]
   },
   {

diff --git a/examples/cell/main.py b/examples/cell/main.py
@@ -15,10 +15,7 @@
 import os
 
 from jupyter_server.base.handlers import JupyterHandler
-from jupyter_server.extension.handler import (
-    ExtensionHandlerJinjaMixin,
-    ExtensionHandlerMixin,
-)
+from jupyter_server.extension.handler import ExtensionHandlerJinjaMixin, ExtensionHandlerMixin
 from jupyter_server.utils import url_path_join as ujoin
 from jupyterlab_server import LabServerApp
 

diff --git a/examples/console/main.py b/examples/console/main.py
@@ -15,10 +15,7 @@
 import os
 
 from jupyter_server.base.handlers import JupyterHandler
-from jupyter_server.extension.handler import (
-    ExtensionHandlerJinjaMixin,
-    ExtensionHandlerMixin,
-)
+from jupyter_server.extension.handler import ExtensionHandlerJinjaMixin, ExtensionHandlerMixin
 from jupyter_server.utils import url_path_join as ujoin
 from jupyterlab_server import LabServerApp
 

diff --git a/examples/console/test.ipynb b/examples/console/test.ipynb
@@ -35,6 +35,7 @@
    ],
    "source": [
     "import sys\n",
+    "\n",
     "print('hello world', flush=True)\n",
     "for i in range(3):\n",
     "    print(i, flush=True)\n",
@@ -98,6 +99,7 @@
    ],
    "source": [
     "from IPython.display import Image\n",
+    "\n",
     "Image('./jupyter.png')"
    ]
   },
@@ -134,7 +136,9 @@
    ],
    "source": [
     "from IPython.display import Latex\n",
-    "Latex('''The mass-energy equivalence is described by the famous equation\n",
+    "\n",
+    "Latex(\n",
+    "    '''The mass-energy equivalence is described by the famous equation\n",
     " \n",
     "$$E=mc^2$$\n",
     " \n",
@@ -143,7 +147,8 @@
     " \n",
     "\\\\begin{equation}\n",
     "E=m\n",
-    "\\\\end{equation}''')"
+    "\\\\end{equation}'''\n",
+    ")"
    ]
   },
   {

diff --git a/examples/example_check.py b/examples/example_check.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.