add style checks

Author: davidism

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+max_line_length = 88
+
+[*.{yml,yaml,json,js,css,html}]
+indent_size = 2

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v1.3.1
+    hooks:
+      - id: reorder-python-imports
+        args: ["--application-directories", "src"]
+  - repo: https://github.com/ambv/black
+    rev: 18.9b0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.0.0
+    hooks:
+      - id: check-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: flake8
+        additional_dependencies: [flake8-bugbear]

.travis.yml

@@ -15,7 +15,7 @@ matrix:
     - dist: xenial
       sudo: required
       python: "3.7"
-    - env: TOXENV=docs-html
+    - env: TOXENV=stylecheck,docs-html
     - stage: wheel
       sudo: required
       services:

bench/bench_basic.py

@@ -2,4 +2,4 @@
 
 
 def run():
-    escape('<strong>Hello World!</strong>')
+    escape("<strong>Hello World!</strong>")

bench/bench_largestring.py

@@ -2,5 +2,5 @@
 
 
 def run():
-    string = '<strong>Hello World!</strong>' * 1000
+    string = "<strong>Hello World!</strong>" * 1000
     escape(string)

bench/bench_long_empty_string.py

@@ -2,5 +2,5 @@
 
 
 def run():
-    string = 'Hello World!' * 1000
+    string = "Hello World!" * 1000
     escape(string)

bench/bench_long_suffix.py

@@ -2,5 +2,5 @@
 
 
 def run():
-    string = '<strong>Hello World!</strong>' + 'x' * 100000
+    string = "<strong>Hello World!</strong>" + "x" * 100000
     escape(string)

bench/bench_short_empty_string.py

@@ -2,4 +2,4 @@
 
 
 def run():
-    escape('Hello World!')
+    escape("Hello World!")

bench/runbench.py

@@ -3,12 +3,13 @@
     Runs the benchmarks
 """
 from __future__ import print_function
-import sys
+
 import os
 import re
+import sys
 from subprocess import Popen
 
-_filename_re = re.compile(r'^bench_(.*?)\.py$')
+_filename_re = re.compile(r"^bench_(.*?)\.py$")
 bench_directory = os.path.abspath(os.path.dirname(__file__))
 
 
@@ -18,27 +19,27 @@ def list_benchmarks():
         match = _filename_re.match(name)
         if match is not None:
             result.append(match.group(1))
-    result.sort(key=lambda x: (x.startswith('logging_'), x.lower()))
+    result.sort(key=lambda x: (x.startswith("logging_"), x.lower()))
     return result
 
 
 def run_bench(name):
-    sys.stdout.write('%-32s' % name)
+    sys.stdout.write("%-32s" % name)
     sys.stdout.flush()
-    Popen([sys.executable, '-mtimeit', '-s',
-           'from bench_%s import run' % name,
-           'run()']).wait()
+    Popen(
+        [sys.executable, "-mtimeit", "-s", "from bench_%s import run" % name, "run()"]
+    ).wait()
 
 
 def main():
-    print('=' * 80)
-    print('Running benchmark for MarkupSafe')
-    print('-' * 80)
+    print("=" * 80)
+    print("Running benchmark for MarkupSafe")
+    print("-" * 80)
     os.chdir(bench_directory)
     for bench in list_benchmarks():
         run_bench(bench)
-    print('-' * 80)
+    print("-" * 80)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

setup.cfg

@@ -14,3 +14,19 @@ source =
     src/markupsafe
     .tox/*/lib/python*/site-packages/markupsafe
     .tox/*/site-packages/markupsafe
+
+[flake8]
+# B = bugbear
+# E = pycodestyle errors
+# F = flake8 pyflakes
+# W = pycodestyle warnings
+# B9 = bugbear opinions
+select = B, E, F, W, B9
+# E203 = slice notation whitespace, invalid
+# E501 = line length, handled by bugbear B950
+# W503 = bin op line break, invalid
+ignore = E203, E501, W503
+# up to 88 allowed by bugbear B950
+max-line-length = 80
+# _compat names and imports will always look bad, ignore warnings
+exclude = src/markupsafe/_compat.py