Update ruff config (#542)

* Update ruff config

* update test paths

* fix path

* python 3.12 compat

* address warning

Author: blink1073

.github/workflows/test.yml

@@ -40,7 +40,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.8", "3.11"]
+        python-version: ["3.8", "3.12"]
     steps:
       - uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.2
+    rev: 0.27.3
     hooks:
       - id: check-github-workflows
 
@@ -33,7 +33,7 @@ repos:
           [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.3"
+    rev: "v3.1.0"
     hooks:
       - id: prettier
         types_or: [yaml, html, json]
@@ -44,7 +44,7 @@ repos:
     hooks:
       - id: mypy
         files: "^jupyter_releaser"
-        exclude: "jupyter_releaser/tests"
+        exclude: "tests"
         stages: [manual]
         args: ["--install-types", "--non-interactive"]
         additional_dependencies:
@@ -70,7 +70,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.6
+    rev: v0.1.8
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]

docs/source/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "Jupyter Releaser"
-copyright = "2021, Project Jupyter"  # noqa
+copyright = "2021, Project Jupyter"
 author = "Project Jupyter"
 
 # The full version, including alpha/beta/rc tags.
@@ -42,7 +42,7 @@
 ]
 
 try:
-    import enchant  # type:ignore  # noqa
+    import enchant  # noqa: F401
 
     extensions += ["sphinxcontrib.spelling"]
 except ImportError:

jupyter_releaser/changelog.py

@@ -58,7 +58,7 @@ def get_version_entry(
     since_last_stable=None,
     until=None,
     auth=None,
-    resolve_backports=False,
+    resolve_backports=False,  # noqa: ARG001
     dry_run=False,
 ):
     """Get a changelog for the changes since the last tag on the given branch.
@@ -143,14 +143,12 @@ def get_version_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"""
+    return f"""
 ## {version}
 
 {entry}
 """.strip()
 
-    return output
-
 
 def build_entry(
     ref, branch, repo, auth, changelog_path, since, since_last_stable, resolve_backports
@@ -295,13 +293,13 @@ def insert_entry(
     return format(changelog)
 
 
-def format(changelog: str) -> str:  # noqa A001
+def format(changelog: str) -> str:
     """Clean up changelog formatting"""
     changelog = re.sub(r"\n\n+", r"\n\n", changelog)
     return re.sub(r"\n\n+$", r"\n", changelog)
 
 
-def check_entry(  # noqa
+def check_entry(
     ref,
     branch,
     repo,

jupyter_releaser/cli.py

@@ -15,9 +15,9 @@
 class ReleaseHelperGroup(click.Group):
     """Click group tailored to jupyter-releaser"""
 
-    _needs_checkout_dir: t.Dict[str, bool] = {}  # noqa
+    _needs_checkout_dir: t.Dict[str, bool] = {}  # noqa: RUF012
 
-    def invoke(self, ctx):  # noqa
+    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]
@@ -96,12 +96,11 @@ def invoke(self, ctx):  # noqa
                         ctx.args.append(arg)
                         ctx.args.append(val)
                     continue
-                else:
-                    val = ctx.args[ctx.args.index(arg) + 1]
-                    if "token" in name.lower():
-                        val = "***"
-                    util.log(f"Using cli arg for {name}: '{val}'")
-                    continue
+                val = ctx.args[ctx.args.index(arg) + 1]
+                if "token" in name.lower():
+                    val = "***"
+                util.log(f"Using cli arg for {name}: '{val}'")
+                continue
 
             util.log(f"Using default value for {name}: '{param.default}'")
 
@@ -141,16 +140,15 @@ def invoke(self, ctx):  # noqa
 
         os.chdir(orig_dir)
 
-    def list_commands(self, ctx):
+    def list_commands(self, ctx):  # noqa: ARG002
         """List commands in insertion order"""
         return self.commands.keys()
 
 
 @click.group(cls=ReleaseHelperGroup)
 @click.option("--force", default=False, help="Force a command to run even when skipped by config")
-def main(force):
+def main(force):  # noqa: ARG001
     """Jupyter Releaser scripts"""
-    pass
 
 
 # Extracted common options
@@ -357,7 +355,6 @@ def inner(func):
 def list_envvars():
     """List the environment variables"""
     # This is implemented in ReleaseHelperGroup.invoke
-    pass
 
 
 @main.command()
@@ -709,7 +706,7 @@ def publish_release(auth, dry_run, release_url, silent):
     "--expected-sha", help="The expected sha of the branch HEAD", envvar="RH_EXPECTED_SHA"
 )
 @use_checkout_dir()
-def ensure_sha(ref, branch, repo, dry_run, expected_sha):
+def ensure_sha(ref, branch, repo, dry_run, expected_sha):  # noqa: ARG001
     """Ensure that a sha has not changed."""
     util.ensure_sha(dry_run, expected_sha, branch)
 
@@ -735,7 +732,7 @@ def forwardport_changelog(auth, ref, branch, repo, username, changelog_path, dry
 @add_options(changelog_path_options)
 @add_options(dry_run_options)
 @use_checkout_dir()
-def publish_changelog(auth, ref, branch, repo, changelog_path, dry_run):
+def publish_changelog(auth, ref, branch, repo, changelog_path, dry_run):  # noqa: ARG001
     """Remove changelog placeholder entries."""
     lib.publish_changelog(branch, repo, auth, changelog_path, dry_run)
 

jupyter_releaser/lib.py

@@ -230,9 +230,9 @@ def tag_release(dist_dir, release_message, tag_format, tag_message, no_git_tag_w
 
 
 def populate_release(
-    ref,
+    ref,  # noqa: ARG001
     branch,
-    repo,
+    repo,  # noqa: ARG001
     version_cmd,
     auth,
     changelog_path,
@@ -355,7 +355,7 @@ def extract_release(auth, dist_dir, dry_run, release_url):
     os.chdir(orig_dir)
 
 
-def publish_assets(  # noqa
+def publish_assets(
     auth,
     dist_dir,
     npm_token,
@@ -396,7 +396,7 @@ def publish_assets(  # noqa
 
     res = python_package.split(":")
     python_package_path = res[0]
-    python_package_name = res[1].replace("-", "_") if len(res) == 2 else ""  # noqa
+    python_package_name = res[1].replace("-", "_") if len(res) == 2 else ""
 
     if release_url and len(glob(f"{dist_dir}/*.whl")):
         twine_token = python.get_pypi_token(release_url, python_package_path)
@@ -474,7 +474,7 @@ def publish_release(auth, dry_run, release_url, silent):
     util.actions_output("release_url", release.html_url)
 
 
-def prep_git(ref, branch, repo, auth, username, url):  # noqa
+def prep_git(ref, branch, repo, auth, username, url):
     """Set up git"""
     repo = repo or util.get_repo()
 
@@ -570,7 +570,7 @@ def extract_changelog(dry_run, auth, changelog_path, release_url, silent=False):
     changelog.update_changelog(changelog_path, changelog_text, silent=silent)
 
 
-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):  # noqa: ARG001
     """Forwardport Changelog Entries to the Default Branch"""
     # Set up the git repo with the branch
     match = util.parse_release_url(release_url)

jupyter_releaser/mock_github.py

@@ -60,7 +60,7 @@ def write_to_file(name, data):
 class Asset(BaseModel):
     """An asset model."""
 
-    id: int  # noqa
+    id: int
     name: str
     content_type: str
     size: int
@@ -86,7 +86,7 @@ class Release(BaseModel):
     published_at: str = ""
     draft: bool
     body: str = ""
-    id: int  # noqa
+    id: int
     node_id: str = ""
     author: str = ""
     html_url: str
@@ -124,7 +124,7 @@ class Tag(BaseModel):
     """A tag model."""
 
     ref: str
-    object: TagObject  # noqa
+    object: TagObject
 
 
 releases: Dict[str, "Release"] = load_from_file("releases", Release)

jupyter_releaser/npm.py

@@ -15,6 +15,12 @@
 PACKAGE_JSON = util.PACKAGE_JSON
 
 
+# Python 3.12+ gives a deprecation warning if TarFile.extraction_filter is None.
+# https://docs.python.org/3.12/library/tarfile.html#tarfile-extraction-filter
+if hasattr(tarfile, "fully_trusted_filter"):
+    tarfile.TarFile.extraction_filter = staticmethod(tarfile.fully_trusted_filter)  # type:ignore[assignment]
+
+
 def build_dist(package, dist_dir):
     """Build npm dist file(s) from a package"""
     # Clean the dist folder of existing npm tarballs

jupyter_releaser/python.py

@@ -21,7 +21,7 @@
 PYPROJECT = util.PYPROJECT
 SETUP_PY = util.SETUP_PY
 
-PYPI_GH_API_TOKEN_URL = "https://pypi.org/_/oidc/github/mint-token"  # noqa
+PYPI_GH_API_TOKEN_URL = "https://pypi.org/_/oidc/github/mint-token"  # noqa: S105
 
 
 def build_dist(dist_dir, clean=True):
@@ -70,7 +70,7 @@ def check_dist(
     # run the test command in the venv
     with TemporaryDirectory() as td:
         env_path = util.normalize_path(osp.abspath(td))
-        if os.name == "nt":  # noqa  # pragma: no cover
+        if os.name == "nt":  # pragma: no cover  # noqa: SIM108
             bin_path = f"{env_path}/Scripts/"
         else:
             bin_path = f"{env_path}/bin"
@@ -185,7 +185,7 @@ def start_local_pypi():
     """Start a local PyPI server"""
     temp_dir = TemporaryDirectory()
     cmd = f"pypi-server run -p 8081  -P . -a . -o  -v {temp_dir.name}"
-    proc = Popen(shlex.split(cmd), stdout=PIPE)  # noqa
+    proc = Popen(shlex.split(cmd), stdout=PIPE)  # noqa: S603
     # Wait for the server to start
     while True:
         assert proc.stdout is not None

jupyter_releaser/tee.py

@@ -52,7 +52,7 @@ async def _read_stream(stream: StreamReader, callback: Callable[..., Any]) -> No
             break
 
 
-async def _stream_subprocess(args: str, **kwargs: Any) -> CompletedProcess:  # noqa
+async def _stream_subprocess(args: str, **kwargs: Any) -> CompletedProcess:
     platform_settings: Dict[str, Any] = {}
     if platform.system() == "Windows":
         platform_settings["env"] = os.environ
@@ -61,10 +61,10 @@ async def _stream_subprocess(args: str, **kwargs: Any) -> CompletedProcess:  # n
     tee = kwargs.get("tee", True)
     stdout = kwargs.get("stdout", sys.stdout)
     if stdout == subprocess.DEVNULL or not tee:
-        stdout = open(os.devnull, "w")  # noqa
+        stdout = open(os.devnull, "w")  # noqa: SIM115
     stderr = kwargs.get("stderr", sys.stderr)
     if stderr == subprocess.DEVNULL or not tee:
-        stderr = open(os.devnull, "w")  # noqa
+        stderr = open(os.devnull, "w")  # noqa: SIM115
 
     # We need to tell subprocess which shell to use when running shell-like
     # commands.
@@ -91,7 +91,7 @@ async def _stream_subprocess(args: str, **kwargs: Any) -> CompletedProcess:  # n
     out: List[str] = []
     err: List[str] = []
 
-    def tee_func(line: bytes, sink: List[str], pipe: Optional[Any]) -> None:
+    def tee_func(line: bytes, sink: List[str], pipe: Optional[Any]) -> None:  # noqa: ARG001
         line_str = line.decode("utf-8").rstrip()
         sink.append(line_str)
         if not kwargs.get("quiet", False):
@@ -137,7 +137,7 @@ def run(args: Union[str, List[str]], **kwargs: Any) -> CompletedProcess:
     quiet: False - Avoid printing output
     show_cwd: False - Prints the current working directory.
     """
-    if isinstance(args, str):  # noqa
+    if isinstance(args, str):  # noqa: SIM108
         cmd = args
     else:
         # run was called with a list instead of a single item but asyncio