Merge pull request #259 from blink1073/flake8

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial pre-commit reformat
+e4067d87e1728bfd2219adbbe6ba18b4b8061cab

.github/scripts/parse_ref.py

@@ -5,7 +5,6 @@
 
 # Standard library imports
 import os
-import subprocess
 
 # Constants
 HERE = os.path.abspath(os.path.dirname(__file__))

.pre-commit-config.yaml

@@ -48,16 +48,16 @@ repos:
       - id: doc8
         args: [--max-line-length=200]
 
-  # - repo: https://github.com/pycqa/flake8
-  #   rev: 4.0.1
-  #   hooks:
-  #     - id: flake8
-  #       additional_dependencies:
-  #         [
-  #           "flake8-bugbear==20.1.4",
-  #           "flake8-logging-format==0.6.0",
-  #           "flake8-implicit-str-concat==0.2.0",
-  #         ]
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          [
+            "flake8-bugbear==20.1.4",
+            "flake8-logging-format==0.6.0",
+            "flake8-implicit-str-concat==0.2.0",
+          ]
 
   - repo: https://github.com/sirosen/check-jsonschema
     rev: 0.14.1

MANIFEST.in

@@ -10,6 +10,7 @@ recursive-include nbformat *.json
 recursive-include tests *.*
 exclude scripts/jupyter-trust
 exclude .pre-commit-config.yaml
+exclude .git-blame-ignore-revs
 
 # Javascript
 include package.json

docs/conf.py

@@ -12,10 +12,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import os
-import shlex
-import sys
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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.
@@ -212,16 +208,7 @@
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
-    # Latex figure (float) alignment
-    #'figure_align': 'htbp',
-}
+latex_elements = {}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,

nbformat/__init__.py

@@ -5,7 +5,6 @@
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
-import io
 
 from traitlets.log import get_logger
 

nbformat/_struct.py

@@ -346,11 +346,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
-        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
+        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
 
         # default policy is to keep current keys when there's a conflict
         conflict_solve = dict.fromkeys(self, preserve)

nbformat/converter.py

@@ -70,5 +70,5 @@ def convert(nb, to_version):
         return convert(converted, to_version)
     else:
         raise ValueError(
-            "Cannot convert notebook to v%d because that " "version doesn't exist" % (to_version)
+            "Cannot convert notebook to v%d because that version doesn't exist" % (to_version)
         )

nbformat/corpus/tests/test_words.py

@@ -3,10 +3,6 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import random
-
-import pytest
-
 from .. import words
 
 

nbformat/corpus/words.py

@@ -1,4 +1,3 @@
-import os
 import uuid
 
 

nbformat/json_compat.py

@@ -52,7 +52,7 @@ def validate(self, data):
         try:
             self._validator(data)
         except _JsonSchemaException as error:
-            raise ValidationError(error.message, schema_path=error.path)
+            raise ValidationError(str(error), schema_path=error.path)
 
     def iter_errors(self, data, schema=None):
         if schema is not None:
@@ -63,7 +63,7 @@ def iter_errors(self, data, schema=None):
         try:
             validate_func(data)
         except _JsonSchemaException as error:
-            errors = [ValidationError(error.message, schema_path=error.path)]
+            errors = [ValidationError(str(error), schema_path=error.path)]
 
         return errors
 

nbformat/sign.py

@@ -4,7 +4,6 @@
 # Distributed under the terms of the Modified BSD License.
 
 import hashlib
-import io
 import os
 import sys
 from collections import OrderedDict
@@ -20,6 +19,8 @@
     except ImportError:
         sqlite3 = None
 
+from base64 import encodebytes
+
 from jupyter_core.application import JupyterApp, base_flags
 from traitlets import (
     Any,
@@ -36,7 +37,6 @@
 from traitlets.config import LoggingConfigurable, MultipleInstanceError
 
 from . import NO_CONVERT, __version__, read, reads
-from ._compat import encodebytes
 
 try:
     # Python 3
@@ -576,6 +576,7 @@ class TrustNotebookApp(JupyterApp):
     Otherwise, you will have to re-execute the notebook to see output.
     """
     # This command line tool should use the same config file as the notebook
+
     @default("config_file_name")
     def _config_file_name_default(self):
         return "jupyter_notebook_config"

nbformat/v1/nbbase.py

@@ -16,9 +16,6 @@
 # Imports
 # -----------------------------------------------------------------------------
 
-import pprint
-import uuid
-
 from .._struct import Struct
 
 # -----------------------------------------------------------------------------

nbformat/v2/convert.py

@@ -17,13 +17,7 @@
 # Imports
 # -----------------------------------------------------------------------------
 
-from .nbbase import (
-    new_code_cell,
-    new_notebook,
-    new_output,
-    new_text_cell,
-    new_worksheet,
-)
+from .nbbase import new_code_cell, new_notebook, new_text_cell, new_worksheet
 
 # -----------------------------------------------------------------------------
 # Code

nbformat/v2/nbbase.py

@@ -21,9 +21,6 @@
 # Imports
 # -----------------------------------------------------------------------------
 
-import pprint
-import uuid
-
 from .._struct import Struct
 
 # -----------------------------------------------------------------------------

nbformat/v2/rwbase.py

@@ -16,9 +16,7 @@
 # Imports
 # -----------------------------------------------------------------------------
 
-import pprint
-
-from .._compat import decodebytes, encodebytes
+from base64 import decodebytes, encodebytes
 
 # -----------------------------------------------------------------------------
 # Code

nbformat/v3/convert.py

@@ -3,17 +3,7 @@
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-from nbformat import v2
-
-from .nbbase import (
-    nbformat,
-    nbformat_minor,
-    new_code_cell,
-    new_notebook,
-    new_output,
-    new_text_cell,
-    new_worksheet,
-)
+from .nbbase import nbformat, nbformat_minor
 
 
 def _unbytes(obj):

nbformat/v3/nbbase.py

@@ -9,8 +9,6 @@
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import pprint
-import uuid
 import warnings
 
 from .._struct import Struct
@@ -59,7 +57,7 @@ def cast_str(obj):
             UserWarning,
             stacklevel=3,
         )
-        dec = obj.decode("ascii", "replace")
+        return obj.decode("ascii", "replace")
     else:
         assert isinstance(obj, str)
         return obj

nbformat/v3/nbjson.py

@@ -11,7 +11,6 @@
     NotebookReader,
     NotebookWriter,
     rejoin_lines,
-    restore_bytes,
     split_lines,
     strip_transient,
 )

nbformat/v3/rwbase.py

@@ -4,7 +4,7 @@
 # Distributed under the terms of the Modified BSD License.
 
 
-from .._compat import decodebytes, encodebytes
+from base64 import decodebytes, encodebytes
 
 
 def restore_bytes(nb):

nbformat/v4/convert.py

@@ -39,7 +39,7 @@ def upgrade(nb, from_version=None, from_minor=None):
     if not from_version:
         from_version = nb["nbformat"]
     if not from_minor:
-        if not "nbformat_minor" in nb:
+        if "nbformat_minor" not in nb:
             raise validator.ValidationError(
                 "The notebook does not include the nbformat minor which is needed"
             )

nbformat/v4/rwbase.py

@@ -38,7 +38,7 @@ def rejoin_lines(nb):
             cell.source = "".join(cell.source)
 
         attachments = cell.get("attachments", {})
-        for key, attachment in attachments.items():
+        for _, attachment in attachments.items():
             _rejoin_mimebundle(attachment)
 
         if cell.get("cell_type", None) == "code":
@@ -80,7 +80,7 @@ def split_lines(nb):
             cell["source"] = source.splitlines(True)
 
         attachments = cell.get("attachments", {})
-        for key, attachment in attachments.items():
+        for _, attachment in attachments.items():
             _split_mimebundle(attachment)
 
         if cell.cell_type == "code":

nbformat/validator.py

@@ -5,7 +5,6 @@
 import json
 import os
 import pprint
-import sys
 
 from traitlets.log import get_logger
 

setup.cfg

@@ -3,3 +3,24 @@ universal=0
 
 [metadata]
 license_file = COPYING.md
+
+[flake8]
+ignore = E501, W503, E402
+builtins = c, get_config
+exclude =
+    .cache,
+    .github,
+    docs,
+    setup.py
+enable-extensions = G
+extend-ignore =
+    G001, G002, G004, G200, G201, G202,
+    # black adds spaces around ':'
+    E203,
+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
+    # B007 Loop control variable 'foo' not used within the loop body
+    tests/*: B011, F841, B007,
+    # F401 '.foo' imported but unused
+    nbformat/*/__init__.py: F401

tests/base.py

@@ -5,7 +5,6 @@
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-import io
 import os
 import unittest
 

tests/test_validator.py

@@ -39,7 +39,7 @@ def test_nb2(validator_name):
     with TestsBase.fopen("test2.ipynb", "r") as f:
         nb = read(f, as_version=4)
     validate(nb)
-    assert isvalid(nb) == True
+    assert isvalid(nb)
 
 
 @pytest.mark.parametrize("validator_name", VALIDATORS)
@@ -49,7 +49,7 @@ def test_nb3(validator_name):
     with TestsBase.fopen("test3.ipynb", "r") as f:
         nb = read(f, as_version=4)
     validate(nb)
-    assert isvalid(nb) == True
+    assert isvalid(nb)
 
 
 @pytest.mark.parametrize("validator_name", VALIDATORS)
@@ -59,7 +59,7 @@ def test_nb4(validator_name):
     with TestsBase.fopen("test4.ipynb", "r") as f:
         nb = read(f, as_version=4)
     validate(nb)
-    assert isvalid(nb) == True
+    assert isvalid(nb)
 
 
 @pytest.mark.parametrize("validator_name", VALIDATORS)

tests/v1/nbexamples.py

@@ -1,4 +1,4 @@
-from nbformat.v1.nbbase import NotebookNode, new_code_cell, new_notebook, new_text_cell
+from nbformat.v1.nbbase import new_code_cell, new_notebook, new_text_cell
 
 nb0 = new_notebook()
 

tests/v1/test_nbbase.py

@@ -1,6 +1,6 @@
 from unittest import TestCase
 
-from nbformat.v1.nbbase import NotebookNode, new_code_cell, new_notebook, new_text_cell
+from nbformat.v1.nbbase import new_code_cell, new_notebook, new_text_cell
 
 
 class TestCell(TestCase):