Use pre-commit to keep things tidy

- Use black. Formatting is a mess.
- Use mypy. Though more love is required here, especially since we have
  inconsistent APIs. This should help pick up on them.
- Configure flake8 in a compatible way.
- Reorder imports.

Author: Hugo Osvaldo Barrera

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# vim: set nospell:
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+      - id: end-of-file-fixer
+      - id: debug-statements
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.3.5
+    hooks:
+    -   id: reorder-python-imports
+  - repo: https://github.com/psf/black
+    rev: "master"
+    hooks:
+      - id: black
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: "3.8.3" # pick a git hash / tag to point to
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-comprehensions, flake8-import-order, flake8-bugbear]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v0.782'  # Use the sha / tag you want to point at
+    hooks:
+    -   id: mypy

README.rst

@@ -125,7 +125,7 @@ Commandline::
 
     `$ python-barcode create "123456789000" outfile -b ean --text "text to appear under barcode" `
     New barcode saved as outfile.svg.
-    
+
     # The following will not work if Pillow is not installed (Pillow is required for exporting to images instead of SVG).
     $ python-barcode create -t png "My Text" outfile
     New barcode saved as outfile.png.

barcode/__init__.py

@@ -3,34 +3,41 @@
 created as SVG objects. If Pillow is installed, the barcodes can also be
 rendered as images (all formats supported by Pillow).
 """
-
-from barcode.codex import Code128, Code39, Gs1_128, PZN
-from barcode.ean import EAN13, EAN14, EAN8, JAN
+from barcode.codex import Code128
+from barcode.codex import Code39
+from barcode.codex import Gs1_128
+from barcode.codex import PZN
+from barcode.ean import EAN13
+from barcode.ean import EAN14
+from barcode.ean import EAN8
+from barcode.ean import JAN
 from barcode.errors import BarcodeNotFoundError
-from barcode.isxn import ISBN10, ISBN13, ISSN
+from barcode.isxn import ISBN10
+from barcode.isxn import ISBN13
+from barcode.isxn import ISSN
 from barcode.itf import ITF
 from barcode.upc import UPCA
 from barcode.version import version  # noqa: F401
 
 __BARCODE_MAP = {
-    'ean8': EAN8,
-    'ean13': EAN13,
-    'ean': EAN13,
-    'gtin': EAN14,
-    'ean14': EAN14,
-    'jan': JAN,
-    'upc': UPCA,
-    'upca': UPCA,
-    'isbn': ISBN13,
-    'isbn13': ISBN13,
-    'gs1': ISBN13,
-    'isbn10': ISBN10,
-    'issn': ISSN,
-    'code39': Code39,
-    'pzn': PZN,
-    'code128': Code128,
-    'itf': ITF,
-    'gs1_128': Gs1_128,
+    "ean8": EAN8,
+    "ean13": EAN13,
+    "ean": EAN13,
+    "gtin": EAN14,
+    "ean14": EAN14,
+    "jan": JAN,
+    "upc": UPCA,
+    "upca": UPCA,
+    "isbn": ISBN13,
+    "isbn13": ISBN13,
+    "gs1": ISBN13,
+    "isbn10": ISBN10,
+    "issn": ISSN,
+    "code39": Code39,
+    "pzn": PZN,
+    "code128": Code128,
+    "itf": ITF,
+    "gs1_128": Gs1_128,
 }
 
 PROVIDED_BARCODES = list(__BARCODE_MAP)
@@ -55,7 +62,7 @@ def get(name, code=None, writer=None, options=None):
         barcode = __BARCODE_MAP[name.lower()]
     except KeyError:
         raise BarcodeNotFoundError(
-            'The barcode {0!r} you requested is not known.'.format(name)
+            "The barcode {0!r} you requested is not known.".format(name)
         )
 
     if code is not None:
@@ -69,12 +76,7 @@ def get_class(name):
 
 
 def generate(
-    name,
-    code,
-    writer=None,
-    output=None,
-    writer_options=None,
-    text=None,
+    name, code, writer=None, output=None, writer_options=None, text=None,
 ):
     writer_options = writer_options or {}
     barcode = get(name, code, writer, writer_options=writer_options)

barcode/base.py

@@ -1,40 +1,37 @@
 """barcode.base
 
 """
-
 from barcode.writer import SVGWriter
 
 
 class Barcode(object):
 
-    name = ''
+    name = ""
 
     digits = 0
 
     default_writer = SVGWriter
 
     default_writer_options = {
-        'module_width': 0.2,
-        'module_height': 15.0,
-        'quiet_zone': 6.5,
-        'font_size': 10,
-        'text_distance': 5.0,
-        'background': 'white',
-        'foreground': 'black',
-        'write_text': True,
-        'text': '',
+        "module_width": 0.2,
+        "module_height": 15.0,
+        "quiet_zone": 6.5,
+        "font_size": 10,
+        "text_distance": 5.0,
+        "background": "white",
+        "foreground": "black",
+        "write_text": True,
+        "text": "",
     }
 
     def to_ascii(self):
         code = self.build()
         for i, line in enumerate(code):
-            code[i] = line.replace('1', 'X').replace('0', ' ')
-        return '\n'.join(code)
+            code[i] = line.replace("1", "X").replace("0", " ")
+        return "\n".join(code)
 
     def __repr__(self):
-        return '<{0}({1!r})>'.format(
-            self.__class__.__name__, self.get_fullcode()
-        )
+        return "<{0}({1!r})>".format(self.__class__.__name__, self.get_fullcode())
 
     def build(self):
         raise NotImplementedError
@@ -83,7 +80,7 @@ def write(self, fp, options=None, text=None):
                 Text to render under the barcode.
         """
         output = self.render(options, text)
-        if hasattr(output, 'tostring'):
+        if hasattr(output, "tostring"):
             output.save(fp, format=self.writer.format)
         else:
             fp.write(output)
@@ -101,11 +98,11 @@ def render(self, writer_options=None, text=None):
         """
         options = Barcode.default_writer_options.copy()
         options.update(writer_options or {})
-        if options['write_text'] or text is not None:
+        if options["write_text"] or text is not None:
             if text is not None:
-                options['text'] = text
+                options["text"] = text
             else:
-                options['text'] = self.get_fullcode()
+                options["text"] = self.get_fullcode()
         self.writer.set_options(options)
         code = self.build()
         raw = self.writer.render(code)