Merge ~jugmac00/lazr.config:introduce-pre-commit into lazr.config:main

[Jürgen Gmach]

Add basic pre-commit configuration.

[Colin Watson (cjwatson)]

review: Approve

diff --git a/.gitignore b/.gitignore
index 66573bf..318ee2c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,3 +11,4 @@ build
 dist
 .tox
 __pycache__
+.coverage
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..9837b22
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,18 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-ast
+    -   id: end-of-file-fixer
+    -   id: check-json
+    -   id: check-merge-conflict
+    -   id: check-xml
+    -   id: check-yaml
+    -   id: debug-statements
+-   repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+    -   id: flake8
diff --git a/NEWS.rst b/NEWS.rst
index 3a909ba..f914361 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -2,6 +2,10 @@
 NEWS for lazr.config
 ====================
 
+2.2.4
+=====
+- Add basic pre-commit configuration.
+
 2.2.3 (2021-01-26)
 ==================
 - Fix tests with zope.interface >= 5.0.0.
diff --git a/conf.py b/conf.py
index e4ad315..068c1d4 100644
--- a/conf.py
+++ b/conf.py
@@ -11,8 +11,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-from __future__ import print_function
-import sys, os
+import os
 
 # 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
@@ -51,7 +50,7 @@ copyright = u'2013-2015, LAZR developers'
 # The short X.Y version.
 with open('src/lazr/config/_version.py') as version_file:
     exec(version_file.read())  # sets __version__
-version = __version__
+version = __version__  # noqa: F821
 # The full version, including alpha/beta/rc tags.
 release = version
 
diff --git a/setup.py b/setup.py
index 327dd30..c3f11a5 100755
--- a/setup.py
+++ b/setup.py
@@ -21,7 +21,7 @@ with open('src/lazr/config/_version.py') as version_file:
 
 setup(
     name='lazr.config',
-    version=__version__,
+    version=__version__,  # noqa: F821
     namespace_packages=['lazr'],
     packages=find_packages('src'),
     package_dir={'': 'src'},
diff --git a/src/lazr/config/__init__.py b/src/lazr/config/__init__.py
index fd59b21..efeae25 100644
--- a/src/lazr/config/__init__.py
+++ b/src/lazr/config/__init__.py
@@ -22,5 +22,5 @@ __version__
 # While we generally frown on "*" imports, this, combined with the fact we
 # only test code from this module, means that we can verify what has been
 # exported.
-from lazr.config._config import *
-from lazr.config._config import __all__
+from lazr.config._config import *  # noqa: F401, F403
+from lazr.config._config import __all__  # noqa: F401, F402
diff --git a/src/lazr/config/_config.py b/src/lazr/config/_config.py
index 9c50d6d..8069d40 100644
--- a/src/lazr/config/_config.py
+++ b/src/lazr/config/_config.py
@@ -350,7 +350,7 @@ class ConfigSchema:
             raise InvalidSectionNameError('[%s] has too many parts.' % name)
         if self._section_name_pattern.match(section_name) is None:
             raise InvalidSectionNameError(
-                '[%s] name does not match [\w.-]+.' % name)
+                r'[%s] name does not match [\w.-]+.' % name)
         return (section_name, category_name,
                 is_template, is_optional, is_master)
 
diff --git a/src/lazr/config/interfaces.py b/src/lazr/config/interfaces.py
index 1d0939f..0b8a497 100644
--- a/src/lazr/config/interfaces.py
+++ b/src/lazr/config/interfaces.py
@@ -68,9 +68,11 @@ class UnknownSectionError(ConfigSchemaError):
 class UnknownKeyError(ConfigSchemaError):
     """The section has a key that is not in the schema."""
 
+
 class NoConfigError(ConfigSchemaError):
     """No config has the name."""
 
+
 class ConfigErrors(ConfigSchemaError):
     """The errors in a Config.
 
@@ -123,6 +125,7 @@ class ISection(ISectionSchema):
         :raise: AttributeError if there is no key with the name.
         """
 
+
 class IConfigLoader(Interface):
     """A configuration file loader."""
 
@@ -211,7 +214,6 @@ class IStackableConfig(IConfigSchema):
     extends = Attribute("The ConfigData that this config extends.")
     overlays = Attribute("The stack of ConfigData that define this config.")
 
-
     def __getattr__(name):
         """Return the named section.
 
diff --git a/src/lazr/config/tests/testdata/bad-nonascii.conf b/src/lazr/config/tests/testdata/bad-nonascii.conf
index 4c3896b..77bdc95 100644
--- a/src/lazr/config/tests/testdata/bad-nonascii.conf
+++ b/src/lazr/config/tests/testdata/bad-nonascii.conf
@@ -1,4 +1,3 @@
 # Non ascii character: é.
 [test-section]
 key1: café.
-
diff --git a/src/lazr/config/tests/testdata/bad-redefined-key.conf b/src/lazr/config/tests/testdata/bad-redefined-key.conf
index ef799bb..617697d 100644
--- a/src/lazr/config/tests/testdata/bad-redefined-key.conf
+++ b/src/lazr/config/tests/testdata/bad-redefined-key.conf
@@ -2,4 +2,3 @@
 [test-section]
 key1: original
 key1: redefined
-
diff --git a/src/lazr/config/tests/testdata/bad-redefined-section.conf b/src/lazr/config/tests/testdata/bad-redefined-section.conf
index db39304..5f5a9a9 100644
--- a/src/lazr/config/tests/testdata/bad-redefined-section.conf
+++ b/src/lazr/config/tests/testdata/bad-redefined-section.conf
@@ -5,4 +5,3 @@ key2: redefined
 #Redefine the test-section
 [test-section]
 key3: a value
-
diff --git a/src/lazr/config/tests/testdata/shared.conf b/src/lazr/config/tests/testdata/shared.conf
index f08a251..054dd8b 100644
--- a/src/lazr/config/tests/testdata/shared.conf
+++ b/src/lazr/config/tests/testdata/shared.conf
@@ -4,4 +4,3 @@
 [section_1]
 key2: sharing is fun
 key5: shared value
-
diff --git a/tox.ini b/tox.ini
index a5bc9ac..9bee34a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -8,3 +8,19 @@ commands = python -s -m nose -P lazr
 deps =
      nose
      coverage
+
+[testenv:pre-commit]
+commands =
+     pre-commit run --all-files
+deps =
+     pre-commit
+
+[flake8]
+ignore =
+     # flake8 errors from the E category will be mostly gone after
+     # applying black
+     E
+     # line break before/after binary operator
+     # mutually exclusive
+     W503
+     W504