Update ruff and typings (#388)

.github/scripts/create_npmrc.py

@@ -1,19 +1,19 @@
-#!/usr/bin/env python
-
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 # Standard library imports
-import os
+from __future__ import annotations
+
+from pathlib import Path
 
 
 def create_npmrc():
     """
     Create NPM configuration file in user home directory to use authentication
     token from environment variables.
     """
-    fpath = os.path.expanduser("~/.npmrc")
-    with open(fpath, "w") as fh:
+    fpath = Path("~/.npmrc").expanduser()
+    with fpath.open("w") as fh:
         fh.write("//registry.npmjs.org/:_authToken=${NPM_TOKEN}")
 
 

.github/scripts/parse_ref.py

@@ -1,14 +1,15 @@
-#!/usr/bin/env python
-
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 # Standard library imports
+from __future__ import annotations
+
 import os
+from pathlib import Path
 
 # Constants
-HERE = os.path.abspath(os.path.dirname(__file__))
-REPO_ROOT = os.path.dirname(os.path.dirname(HERE))
+HERE = Path(__file__).parent.resolve()
+REPO_ROOT = HERE.parent.parent
 
 
 def parse_ref(current_ref):
@@ -22,10 +23,11 @@ def parse_ref(current_ref):
         The github reference string.
     """
     if not current_ref.startswith("refs/tags/"):
-        raise Exception(f"Invalid ref `{current_ref}`!")  # noqa
+        msg = f"Invalid ref `{current_ref}`!"
+        raise Exception(msg)
 
     tag_name = current_ref.replace("refs/tags/", "")
-    print(tag_name)  # noqa
+    print(tag_name)  # noqa: T201
 
 
 if __name__ == "__main__":

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.1
+    rev: 0.27.2
     hooks:
       - id: check-github-workflows
 
@@ -56,7 +56,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.6.1"
+    rev: "v1.7.1"
     hooks:
       - id: mypy
         files: "^nbformat"
@@ -65,7 +65,7 @@ repos:
           ["jsonschema>=2.6", "traitlets>=5.13", "jupyter_core>5.4"]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.5
+    rev: v0.1.6
     hooks:
       - id: ruff
         types_or: [python, jupyter]
@@ -76,7 +76,7 @@ repos:
         types_or: [python, jupyter]
 
   - repo: https://github.com/scientific-python/cookie
-    rev: "2023.10.27"
+    rev: "2023.11.17"
     hooks:
       - id: sp-repo-review
         additional_dependencies: ["repo-review[cli]"]

docs/conf.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-#
 # nbformat documentation build configuration file, created by
 # sphinx-quickstart on Thu May 14 17:26:52 2015.
 #
@@ -16,13 +14,14 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
+from __future__ import annotations
 
-import os
 import shutil
+from pathlib import Path
 
 import nbformat
 
-HERE = os.path.abspath(os.path.dirname(__file__))
+HERE = Path(__file__).parent.resolve()
 
 # -- General configuration ------------------------------------------------
 
@@ -40,7 +39,7 @@
 ]
 
 try:
-    import enchant  # type:ignore  # noqa
+    import enchant  # noqa: F401
 
     extensions += ["sphinxcontrib.spelling"]
 except ImportError:
@@ -62,7 +61,7 @@
 
 # General information about the project.
 project = "nbformat"
-copyright = "2015, Jupyter Development Team"  # noqa
+copyright = "2015, Jupyter Development Team"
 author = "Jupyter Development Team"
 
 # numpydoc configuration
@@ -313,5 +312,5 @@
 
 
 def setup(_):
-    dest = os.path.join(HERE, "changelog.md")
-    shutil.copy(os.path.join(HERE, "..", "CHANGELOG.md"), dest)
+    dest = Path(HERE, "changelog.md")
+    shutil.copy(Path(HERE, "..", "CHANGELOG.md"), dest)

nbformat/__init__.py

@@ -5,6 +5,9 @@
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
+
+from pathlib import Path
 
 from traitlets.log import get_logger
 
@@ -39,12 +42,12 @@
     4: v4,
 }
 
-from . import reader  # noqa
-from .converter import convert  # noqa
-from .notebooknode import NotebookNode, from_dict  # noqa
-from .v4 import nbformat as current_nbformat  # noqa
-from .v4 import nbformat_minor as current_nbformat_minor  # noqa
-from .validator import ValidationError, validate  # noqa
+from . import reader  # noqa: E402
+from .converter import convert  # noqa: E402
+from .notebooknode import NotebookNode, from_dict  # noqa: E402
+from .v4 import nbformat as current_nbformat  # noqa: E402
+from .v4 import nbformat_minor as current_nbformat_minor  # noqa: E402
+from .validator import ValidationError, validate  # noqa: E402
 
 
 class NBFormatError(ValueError):
@@ -165,7 +168,7 @@ def read(fp, as_version, capture_validation_error=None, **kwargs):
     try:
         buf = fp.read()
     except AttributeError:
-        with open(fp, encoding="utf-8") as f:
+        with open(fp, encoding="utf8") as f:  # noqa: PTH123
             return reads(f.read(), as_version, capture_validation_error, **kwargs)
 
     return reads(buf, as_version, capture_validation_error, **kwargs)
@@ -202,7 +205,7 @@ def write(nb, fp, version=NO_CONVERT, capture_validation_error=None, **kwargs):
         if not s.endswith("\n"):
             fp.write("\n")
     except AttributeError:
-        with open(fp, "w", encoding="utf-8") as f:
+        with Path(fp).open("w", encoding="utf8") as f:
             f.write(s)
             if not s.endswith("\n"):
                 f.write("\n")

nbformat/_imports.py

@@ -6,6 +6,7 @@
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 
 def import_item(name):
@@ -26,7 +27,7 @@ def import_item(name):
     """
 
     parts = name.rsplit(".", 1)
-    if len(parts) == 2:  # noqa
+    if len(parts) == 2:
         # called with 'foo.bar....'
         package, obj = parts
         module = __import__(package, fromlist=[obj])
@@ -35,6 +36,5 @@ def import_item(name):
         except AttributeError:
             raise ImportError("No module named %s" % obj) from None
         return pak
-    else:
-        # called with un-dotted string
-        return __import__(parts[0])
+    # called with un-dotted string
+    return __import__(parts[0])

nbformat/_struct.py

@@ -2,6 +2,8 @@
 
 Can probably be replaced by types.SimpleNamespace from Python 3.3
 """
+from __future__ import annotations
+
 from typing import Any, Dict
 
 __all__ = ["Struct"]
@@ -88,7 +90,7 @@ def __setattr__(self, key, value):
         you can't set a class member
         """
         # If key is an str it might be a class member or instance var
-        if isinstance(key, str):  # noqa
+        if isinstance(key, str):  # noqa: SIM102
             # I can't simply call hasattr here because it calls getattr, which
             # calls self.__getattr__, which returns True for keys in
             # self._data.  But I only want keys in the class and in
@@ -196,12 +198,12 @@ def __dict_invert(self, data):
         outdict = {}
         for k, lst in data.items():
             if isinstance(lst, str):
-                lst = lst.split()  # noqa
+                lst = lst.split()  # noqa: PLW2901
             for entry in lst:
                 outdict[entry] = k
         return outdict
 
-    def dict(self):  # noqa
+    def dict(self):
         """Get the dict representation of the struct."""
         return self
 
@@ -217,7 +219,7 @@ def copy(self):
         """
         return Struct(dict.copy(self))
 
-    def hasattr(self, key):  # noqa
+    def hasattr(self, key):
         """hasattr function available as a method.
 
         Implemented like has_key.
@@ -331,11 +333,11 @@ def merge(self, __loc_data__=None, __conflict_solve=None, **kw):
 
         # policies for conflict resolution: two argument functions which return
         # the value that will go in the new struct
-        preserve = lambda old, new: old  # noqa
-        update = lambda old, new: new  # noqa
-        add = lambda old, new: old + new  # noqa
-        add_flip = lambda old, new: new + old  # noqa  # note change of order!
-        add_s = lambda old, new: old + " " + new  # noqa
+        preserve = lambda old, new: old
+        update = lambda old, new: new
+        add = lambda old, new: old + new
+        add_flip = lambda old, new: new + old  # note change of order!
+        add_s = lambda old, new: old + " " + new
 
         # default policy is to keep current keys when there's a conflict
         conflict_solve = dict.fromkeys(self, preserve)

nbformat/_version.py

@@ -1,5 +1,7 @@
 """The version information for nbformat."""
 # Use "hatchling version xx.yy.zz" to handle version changes
+from __future__ import annotations
+
 import re
 from importlib.metadata import version
 

nbformat/converter.py

@@ -2,6 +2,7 @@
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 from . import versions
 from .reader import get_version
@@ -40,7 +41,7 @@ def convert(nb, to_version):
         return nb
 
     # If the version exist, try to convert to it one step at a time.
-    elif to_version in versions:
+    if to_version in versions:
         # Get the the version that this recursion will convert to as a step
         # closer to the final revision.  Make sure the newer of the conversion
         # functions is used to perform the conversion.
@@ -63,7 +64,6 @@ def convert(nb, to_version):
 
         # Recursively convert until target version is reached.
         return convert(converted, to_version)
-    else:
-        raise ValueError(
-            "Cannot convert notebook to v%d because that version doesn't exist" % (to_version)
-        )
+    raise ValueError(
+        "Cannot convert notebook to v%d because that version doesn't exist" % (to_version)
+    )

nbformat/corpus/tests/test_words.py

@@ -2,13 +2,14 @@
 
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 from nbformat.corpus import words
 
 
 def test_generate_corpus_id(recwarn):
     """Test generating a corpus id."""
-    assert len(words.generate_corpus_id()) > 7  # noqa
+    assert len(words.generate_corpus_id()) > 7
     # 1 in 4294967296 (2^32) times this will fail
-    assert words.generate_corpus_id() != words.generate_corpus_id()  # noqa
-    assert len(recwarn) == 0  # noqa
+    assert words.generate_corpus_id() != words.generate_corpus_id()
+    assert len(recwarn) == 0

nbformat/corpus/words.py

@@ -1,4 +1,6 @@
 """Generate a corpus id."""
+from __future__ import annotations
+
 import uuid
 
 

nbformat/current.py

@@ -6,7 +6,7 @@
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
-
+from __future__ import annotations
 
 import re
 import warnings
@@ -83,8 +83,6 @@
 class NBFormatError(ValueError):
     """An error raised for an nbformat error."""
 
-    pass
-
 
 def _warn_format():
     warnings.warn(
@@ -150,7 +148,7 @@ def writes_py(nb, **kwargs):
 # High level API
 
 
-def reads(s, format="DEPRECATED", version=current_nbformat, **kwargs):  # noqa
+def reads(s, format="DEPRECATED", version=current_nbformat, **kwargs):
     """Read a notebook from a string and return the NotebookNode object.
 
     This function properly handles notebooks of any version. The notebook
@@ -179,7 +177,7 @@ def reads(s, format="DEPRECATED", version=current_nbformat, **kwargs):  # noqa
     return nb
 
 
-def writes(nb, format="DEPRECATED", version=current_nbformat, **kwargs):  # noqa
+def writes(nb, format="DEPRECATED", version=current_nbformat, **kwargs):
     """Write a notebook to a string in a given format in the current nbformat version.
 
     This function always writes the notebook in the current nbformat version.
@@ -209,7 +207,7 @@ def writes(nb, format="DEPRECATED", version=current_nbformat, **kwargs):  # noqa
     return versions[version].writes_json(nb, **kwargs)
 
 
-def read(fp, format="DEPRECATED", **kwargs):  # noqa
+def read(fp, format="DEPRECATED", **kwargs):
     """Read a notebook from a file and return the NotebookNode object.
 
     This function properly handles notebooks of any version. The notebook
@@ -228,7 +226,7 @@ def read(fp, format="DEPRECATED", **kwargs):  # noqa
     return reads(fp.read(), **kwargs)
 
 
-def write(nb, fp, format="DEPRECATED", **kwargs):  # noqa
+def write(nb, fp, format="DEPRECATED", **kwargs):
     """Write a notebook to a file in a given format in the current nbformat version.
 
     This function always writes the notebook in the current nbformat version.

nbformat/json_compat.py

@@ -4,6 +4,7 @@
 """
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
 
 import os