Enable "pre-commit".

Author: KelSolaar

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.8
+    hooks:
+    -   id: flake8
+        exclude: examples
+-   repo: https://github.com/pre-commit/mirrors-yapf
+    rev: v0.23.0
+    hooks:
+    -   id: yapf

docs/conf.py

@@ -16,7 +16,7 @@
 
 import colour_checker_detection as package
 
-basename = re.sub('_(\w)', lambda x: x.group(1).upper(),
+basename = re.sub('_(\\w)', lambda x: x.group(1).upper(),
                   package.__name__.title())
 
 autosummary_generate = True
@@ -217,9 +217,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', '{0}.tex'.format(basename),
-     u'{0} Documentation'.format(package.__application_name__),
-     package.__author__, 'manual'),
+    ('index', '{0}.tex'.format(basename), u'{0} Documentation'.format(
+        package.__application_name__), package.__author__, 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -246,9 +245,8 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [('index', basename,
-              u'{0} Documentation'.format(package.__application_name__),
-              [package.__author__], 1)]
+man_pages = [('index', basename, u'{0} Documentation'.format(
+    package.__application_name__), [package.__author__], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -259,10 +257,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', basename,
-     u'{0} Documentation'.format(package.__application_name__),
-     package.__author__, package.__application_name__, basename,
-     'Miscellaneous'),
+    ('index', basename, u'{0} Documentation'.format(
+        package.__application_name__), package.__author__,
+     package.__application_name__, basename, 'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -288,10 +285,10 @@
 # The basename for the epub file. It defaults to the project name.
 # epub_basename = basename
 
-# The HTML theme for the epub output. Since the default themes are not optimized
-# for small screen space, using the same theme for HTML and epub output is
-# usually not wise. This defaults to 'epub', a theme designed to save visual
-# space.
+# The HTML theme for the epub output. Since the default themes are not
+# optimized for small screen space, using the same theme for HTML and epub
+# output is usually not wise. This defaults to 'epub', a theme designed to save
+# visual space.
 # epub_theme = 'epub'
 
 # The language of the text. It defaults to the language option

pyproject.toml

@@ -53,6 +53,7 @@ invoke = { version = "*", optional = true }  # Development dependency.
 mock = { version = "*", optional = true }  # Development dependency.
 nose = { version = "*", optional = true }  # Development dependency.
 numpy = { version = "*", optional = true }
+pre-commit = { version = "*", optional = true }  # Development dependency.
 pytest = { version = "*", optional = true }  # Development dependency.
 restructuredtext-lint = { version = "*", optional = true }  # Development dependency.
 sphinx = { version = "*", optional = true }  # Development dependency.
@@ -70,6 +71,7 @@ flake8 = "*"
 invoke = "*"
 mock = "*"
 nose = "*"
+pre-commit = "*"
 pytest = "*"
 restructuredtext-lint = "*"
 sphinx = "*"
@@ -88,6 +90,7 @@ development = [
     "invoke",
     "mock",
     "nose",
+    "pre-commit",
     "pytest",
     "restructuredtext-lint",
     "sphinx",

requirements.txt

@@ -1,10 +1,12 @@
 alabaster==0.7.12
+aspy.yaml==1.3.0
 atomicwrites==1.3.0
 attrs==19.2.0
 Babel==2.7.0
 biblib-simple==0.1.1
 bleach==3.1.0
 certifi==2019.9.11
+cfgv==2.0.1
 chardet==3.0.4
 colour==0.3.13
 colour-demosaicing==0.1.4
@@ -15,6 +17,7 @@ docopt==0.6.2
 docutils==0.15.2
 entrypoints==0.3
 flake8==3.7.8
+identify==1.4.7
 idna==2.8
 imageio==2.5.0
 imagesize==1.1.0
@@ -26,6 +29,7 @@ MarkupSafe==1.1.1
 mccabe==0.6.1
 mock==3.0.5
 more-itertools==7.2.0
+nodeenv==1.3.3
 nose==1.3.7
 numpy==1.17.2
 opencv-python==4.1.1.26
@@ -34,15 +38,16 @@ packaging==19.2
 Pillow==6.2.0
 pkginfo==1.5.0.1
 pluggy==0.13.0
+pre-commit==1.18.3
 py==1.8.0
 pybtex==0.22.2
 pybtex-docutils==0.2.1
 pycodestyle==2.5.0
 pyflakes==2.1.1
 Pygments==2.4.2
 pyparsing==2.4.2
-pytest==5.2.0
-pytz==2019.2
+pytest==5.2.1
+pytz==2019.3
 PyYAML==5.1.2
 readme-renderer==24.0
 requests==2.22.0
@@ -64,6 +69,7 @@ toml==0.10.0
 tqdm==4.36.1
 twine==1.15.0
 urllib3==1.25.6
+virtualenv==16.7.5
 wcwidth==0.1.7
 webencodings==0.5.1
 yapf==0.23.0

tasks.py

@@ -7,8 +7,10 @@
 from __future__ import unicode_literals
 
 import sys
-if sys.version_info[:2] >= (3, 2):
+try:
     import biblib.bib
+except ImportError:
+    pass
 import fnmatch
 import os
 import re
@@ -384,11 +386,11 @@ def tag(ctx):
 
     with open(os.path.join(PYTHON_PACKAGE_NAME, '__init__.py')) as file_handle:
         file_content = file_handle.read()
-        major_version = re.search("__major_version__\s+=\s+'(.*)'",
+        major_version = re.search("__major_version__\\s+=\\s+'(.*)'",
                                   file_content).group(1)
-        minor_version = re.search("__minor_version__\s+=\s+'(.*)'",
+        minor_version = re.search("__minor_version__\\s+=\\s+'(.*)'",
                                   file_content).group(1)
-        change_version = re.search("__change_version__\s+=\s+'(.*)'",
+        change_version = re.search("__change_version__\\s+=\\s+'(.*)'",
                                    file_content).group(1)
 
         version = '.'.join((major_version, minor_version, change_version))

utilities/export_todo.py

@@ -32,10 +32,13 @@
 -----
 
 | **Colour - Checker Detection** by Colour Developers
-| Copyright © 2018-2019 – Colour Developers – `colour-science@googlegroups.com <colour-science@googlegroups.com>`_
-| This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause
-| `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`_
-"""[1:]
+| Copyright © 2018-2019 – Colour Developers – \
+`colour-science@googlegroups.com <colour-science@googlegroups.com>`_
+| This software is released under terms of New BSD License: \
+https://opensource.org/licenses/BSD-3-Clause
+| `https://github.com/colour-science/colour-checker-detection \
+<https://github.com/colour-science/colour-checker-detection>`_
+""" [1:]
 
 
 def extract_todo_items(root_directory):
@@ -105,8 +108,8 @@ def export_todo_items(todo_items, file_path):
     for module, todo_items in todo_items.items():
         todo_rst.append('-   {0}\n'.format(module))
         for line_numer, todo_item in todo_items:
-            todo_rst.append(
-                '    -   Line {0} : {1}'.format(line_numer, todo_item))
+            todo_rst.append('    -   Line {0} : {1}'.format(
+                line_numer, todo_item))
 
         todo_rst.append('\n')
 

utilities/unicode_to_ascii.py

@@ -11,9 +11,9 @@
     reload(sys)  # noqa
     sys.setdefaultencoding('utf-8')
 
-import codecs
-import os
-import unicodedata
+import codecs  # noqa
+import os  # noqa
+import unicodedata  # noqa
 
 __copyright__ = 'Copyright (C) 2018-2019 - Colour Developers'
 __license__ = 'New BSD License - https://opensource.org/licenses/BSD-3-Clause'
@@ -46,9 +46,10 @@ def unicode_to_ascii(root_directory):
 
     for root, dirnames, filenames in os.walk(root_directory):
         for filename in filenames:
-            if (not filename.endswith('.tex') and not filename.endswith('.py')
-                    and not filename.endswith('.bib')
-                    and not filename.endswith('.rst')):
+            if (not filename.endswith('.tex') and
+                    not filename.endswith('.py') and
+                    not filename.endswith('.bib') and
+                    not filename.endswith('.rst')):
                 continue
 
             if filename == 'unicode_to_ascii.py':