Merge pull request #295 from blink1073/add-flake8

Author: blink1073

.github/workflows/test.yml

@@ -3,21 +3,18 @@ on:
   push:
     branches: ["main"]
   pull_request:
-    branches: ["*"]
+
 jobs:
-  # Run "pre-commit run --all-files"
+  # Run "pre-commit run --all-files --hook-stage=manual"
   pre-commit:
     runs-on: ubuntu-20.04
-    timeout-minutes: 2
-
+    timeout-minutes: 5
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: "3.10"
-
-      # ref: https://github.com/pre-commit/action
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: pre-commit/[email protected]
+        with:
+          extra_args: --all-files --hook-stage=manual
       - name: Help message if pre-commit fail
         if: ${{ failure() }}
         run: |
@@ -27,7 +24,7 @@ jobs:
           echo "or you can run by hand on staged files with"
           echo "    pre-commit run"
           echo "or after-the-fact on already committed files with"
-          echo "    pre-commit run --all-files"
+          echo "    pre-commit run --all-files --hook-stage=manual"
 
   check-links:
     runs-on: ubuntu-20.04
@@ -43,11 +40,11 @@ jobs:
         uses: ./.github/actions/check-links
 
   test:
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu, windows, macos]
+        os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ["3.7", "3.10"]
     steps:
       - name: Checkout

.pre-commit-config.yaml

@@ -1,29 +1,52 @@
 repos:
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
     hooks:
-      - id: reorder-python-imports
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+      - id: check-added-large-files
+      - 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.3.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/pre-commit/mirrors-prettier
     rev: v2.6.2
     hooks:
       - id: prettier
-  - repo: https://github.com/PyCQA/flake8
-    rev: "4.0.1"
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
     hooks:
-      - id: flake8
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
-    hooks:
-      - id: end-of-file-fixer
-      - id: check-case-conflict
-      - id: check-executables-have-shebangs
-      - id: requirements-txt-fixer
-  - repo: https://github.com/pre-commit/mirrors-pylint
-    rev: v3.0.0a4
+      - id: pyupgrade
+        args: [--py37-plus]
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
     hooks:
-      - id: pylint
-        args: [--disable=all, --enable=unused-import]
+      - id: flake8
+        additional_dependencies:
+          [
+            "flake8-bugbear==20.1.4",
+            "flake8-logging-format==0.6.0",
+            "flake8-implicit-str-concat==0.2.0",
+          ]
+        stages: [manual]

CONTRIBUTING.md

@@ -35,7 +35,7 @@ pre-commit install
 You can also invoke the pre-commit hook manually at any time with
 
 ```bash
-pre-commit run
+pre-commit run --all-files --hook-stage manual
 ```
 
 Once you have done this, you can launch the main branch of Jupyter Releaser

jupyter_releaser/actions/check_links.py

@@ -1,5 +1,4 @@
-from jupyter_releaser.actions.common import run_action
-from jupyter_releaser.actions.common import setup
+from jupyter_releaser.actions.common import run_action, setup
 
 setup()
 

jupyter_releaser/actions/draft_changelog.py

@@ -2,12 +2,8 @@
 # Distributed under the terms of the Modified BSD License.
 import os
 
-from jupyter_releaser.actions.common import make_group
-from jupyter_releaser.actions.common import run_action
-from jupyter_releaser.actions.common import setup
-from jupyter_releaser.util import CHECKOUT_NAME
-from jupyter_releaser.util import get_latest_tag
-from jupyter_releaser.util import log
+from jupyter_releaser.actions.common import make_group, run_action, setup
+from jupyter_releaser.util import CHECKOUT_NAME, get_latest_tag, log
 
 setup()
 

jupyter_releaser/actions/draft_release.py

@@ -5,14 +5,9 @@
 from pathlib import Path
 from subprocess import CalledProcessError
 
-from jupyter_releaser.actions.common import make_group
-from jupyter_releaser.actions.common import run_action
-from jupyter_releaser.actions.common import setup
+from jupyter_releaser.actions.common import make_group, run_action, setup
 from jupyter_releaser.changelog import extract_current
-from jupyter_releaser.util import CHECKOUT_NAME
-from jupyter_releaser.util import get_latest_tag
-from jupyter_releaser.util import log
-from jupyter_releaser.util import run
+from jupyter_releaser.util import CHECKOUT_NAME, get_latest_tag, log, run
 
 setup()
 

jupyter_releaser/actions/generate-changelog.py

@@ -3,8 +3,7 @@
 
 from jupyter_releaser.actions.common import run_action
 from jupyter_releaser.changelog import get_version_entry
-from jupyter_releaser.util import CHECKOUT_NAME
-from jupyter_releaser.util import get_branch
+from jupyter_releaser.util import CHECKOUT_NAME, get_branch
 
 target = os.environ.get("RH_REPOSITORY")
 branch = os.environ.get("RH_BRANCH", "<default>")

jupyter_releaser/changelog.py

@@ -132,10 +132,7 @@ def get_version_entry(
     entry = "\n".join(entry).strip()
 
     # Remove empty documentation entry if only automated changelogs were there
-    if (
-        "# Documentation improvements" in entry
-        and not "# Documentation improvements\n\n-" in entry
-    ):
+    if "# Documentation improvements" in entry and "# Documentation improvements\n\n-" not in entry:
         entry = re.sub(r"#+ Documentation improvements\n\n", "", entry)
 
     output = f"""
@@ -201,7 +198,7 @@ def insert_entry(changelog, entry, version=None):
             pr = re.search(r"\[#\d+\]", line)
             if not pr:
                 continue
-            for old_line in prev_entry.splitlines():
+            for old_line in old_lines:
                 if pr.group() in old_line:
                     lines[ind] = old_line
         changelog = changelog.replace(prev_entry, "\n".join(lines))
@@ -278,10 +275,10 @@ def check_entry(
                 break
         if skip:
             continue
-        if not f"[#{pr}]" in final_entry:  # pragma: no cover
+        if f"[#{pr}]" not in final_entry:  # pragma: no cover
             raise ValueError(f"Missing PR #{pr} in changelog")
     for pr in final_prs:
-        if not f"[#{pr}]" in raw_entry:  # pragma: no cover
+        if f"[#{pr}]" not in raw_entry:  # pragma: no cover
             raise ValueError(f"PR #{pr} does not belong in changelog for {version}")
 
     if output:

jupyter_releaser/cli.py

@@ -7,27 +7,23 @@
 
 import click
 
-from jupyter_releaser import changelog
-from jupyter_releaser import lib
-from jupyter_releaser import npm
-from jupyter_releaser import python
-from jupyter_releaser import util
+from jupyter_releaser import changelog, lib, npm, python, util
 
 
 class ReleaseHelperGroup(click.Group):
     """Click group tailored to jupyter-releaser"""
 
-    _needs_checkout_dir = dict()
+    _needs_checkout_dir = {}
 
     def invoke(self, ctx):
         """Handle jupyter-releaser config while invoking a command"""
         # Get the command name and make sure it is valid
         cmd_name = ctx.protected_args[0]
-        if not cmd_name in self.commands:
+        if cmd_name not in self.commands:
             super().invoke(ctx)
 
         if cmd_name == "list-envvars":
-            envvars = dict()
+            envvars = {}
             for cmd_name in self.commands:
                 for param in self.commands[cmd_name].params:
                     if isinstance(param, click.Option):
@@ -126,9 +122,7 @@ def list_commands(self, ctx):
 
 
 @click.group(cls=ReleaseHelperGroup)
-@click.option(
-    "--force", default=False, help="Force a command to run even when skipped by config"
-)
+@click.option("--force", default=False, help="Force a command to run even when skipped by config")
 def main(force):
     """Jupyter Releaser scripts"""
     pass
@@ -145,9 +139,7 @@ def main(force):
 ]
 
 version_cmd_options = [
-    click.option(
-        "--version-cmd", envvar="RH_VERSION_COMMAND", help="The version command"
-    )
+    click.option("--version-cmd", envvar="RH_VERSION_COMMAND", help="The version command")
 ]
 
 
@@ -161,9 +153,7 @@ def main(force):
     click.option("--auth", envvar="GITHUB_ACCESS_TOKEN", help="The GitHub auth token"),
 ]
 
-username_options = [
-    click.option("--username", envvar="GITHUB_ACTOR", help="The git username")
-]
+username_options = [click.option("--username", envvar="GITHUB_ACTOR", help="The git username")]
 
 dist_dir_options = [
     click.option(
@@ -195,15 +185,11 @@ def main(force):
 ]
 
 dry_run_options = [
-    click.option(
-        "--dry-run", is_flag=True, envvar="RH_DRY_RUN", help="Run as a dry run"
-    )
+    click.option("--dry-run", is_flag=True, envvar="RH_DRY_RUN", help="Run as a dry run")
 ]
 
 
-git_url_options = [
-    click.option("--git-url", help="A custom url for the git repository")
-]
+git_url_options = [click.option("--git-url", help="A custom url for the git repository")]
 
 
 changelog_path_options = [
@@ -370,9 +356,7 @@ def draft_changelog(
 
 @main.command()
 @add_options(changelog_options)
-@click.option(
-    "--output", envvar="RH_CHANGELOG_OUTPUT", help="The output file for changelog entry"
-)
+@click.option("--output", envvar="RH_CHANGELOG_OUTPUT", help="The output file for changelog entry")
 @use_checkout_dir()
 def check_changelog(
     ref,
@@ -414,9 +398,7 @@ def build_python(dist_dir, python_packages):
                 f"Skipping build-python in {python_package} since there are no python package files"
             )
         else:
-            python.build_dist(
-                Path(os.path.relpath(".", python_package)) / dist_dir, clean=clean
-            )
+            python.build_dist(Path(os.path.relpath(".", python_package)) / dist_dir, clean=clean)
             clean = False
         os.chdir(prev_dir)
 
@@ -433,9 +415,7 @@ def check_python(dist_dir, check_imports, pydist_check_cmd):
             util.log(f"Skipping non-python dist file {dist_file}")
             continue
 
-        python.check_dist(
-            dist_file, python_imports=check_imports, check_cmd=pydist_check_cmd
-        )
+        python.check_dist(dist_file, python_imports=check_imports, check_cmd=pydist_check_cmd)
 
 
 @main.command()
@@ -528,13 +508,9 @@ def check_links(ignore_glob, ignore_links, cache_file, links_expire):
     help="Whether to skip tagging npm workspace packages",
 )
 @use_checkout_dir()
-def tag_release(
-    dist_dir, release_message, tag_format, tag_message, no_git_tag_workspace
-):
+def tag_release(dist_dir, release_message, tag_format, tag_message, no_git_tag_workspace):
     """Create release commit and tag"""
-    lib.tag_release(
-        dist_dir, release_message, tag_format, tag_message, no_git_tag_workspace
-    )
+    lib.tag_release(dist_dir, release_message, tag_format, tag_message, no_git_tag_workspace)
 
 
 @main.command()
@@ -698,9 +674,7 @@ def publish_release(auth, release_url):
 @add_options(dry_run_options)
 @click.argument("release-url")
 @use_checkout_dir()
-def forwardport_changelog(
-    auth, ref, branch, repo, username, changelog_path, dry_run, release_url
-):
+def forwardport_changelog(auth, ref, branch, repo, username, changelog_path, dry_run, release_url):
     """Forwardport Changelog Entries to the Default Branch"""
     lib.forwardport_changelog(
         auth, ref, branch, repo, username, changelog_path, dry_run, release_url