Add style testing

.flake8

@@ -0,0 +1,65 @@
+# -----------------------------
+# Configuration file for flake8
+# -----------------------------
+
+# Configure flake8
+# ----------------
+[flake8]
+extend-ignore =
+    # Too many leading '#' for block comment
+    E266,
+    # Line too long (82 > 79 characters)
+    E501,
+    # Do not use variables named 'I', 'O', or 'l'
+    E741,
+    # Line break before binary operator (conflicts with black)
+    W503,
+    # Ignore spaces before a colon (Black handles it)
+    E203,
+    # Ignore spaces around an operator (Black handles it)
+    E225,
+    # Ignore rst warnings for start and end, due to *args and **kwargs being invalid rst, but good for numpydoc
+    RST210,RST213,
+exclude =
+    .git,
+    .eggs,
+    version.py,
+    setup.py,
+    __pycache__,
+    .ipynb_checkpoints,
+    docs/examples/*,
+    docs/tutorials/*,
+    docs/*,
+    discretize/_extensions/*.py
+per-file-ignores =
+    # disable unused-imports errors on __init__.py
+    # Automodule used for __init__ scripts' description
+    __init__.py: F401, D204, D205, D400,
+    # do not check for assigned lambdas in tests
+    # do not check for missing docstrings in tests
+    tests/*: E731, D,
+    tutorials/*: D,
+    examples/*: D,
+
+exclude-from-doctest =
+    # Only check discretize for docstring style
+    tests/*,
+    tutorials/*,
+
+# Configure flake8-rst-docstrings
+# -------------------------------
+docstring-convention=numpy
+# Add some roles used in our docstrings
+rst-roles =
+    class,
+    func,
+    mod,
+    meth,
+    ref,
+    data,
+    # Python programming language:
+    py:func,py:mod,py:attr,py:meth,
+    # Collapse functionality
+rst-directives =
+    # These are sorted alphabetically - but that does not matter
+    autosummary,currentmodule,deprecated,collapse,

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.1a1
+    hooks:
+      - id: black
+        language_version: python3.10

azure-pipelines.yml

@@ -16,6 +16,36 @@ pr:
     - '*no-ci*'
 
 stages:
+
+- stage: StyleChecks
+  displayName: "Style Checks"
+  jobs:
+    - job:
+      displayName: Run style checks with Black
+      pool:
+        vmImage: ubuntu-latest
+      variables:
+        python.version: '3.8'
+      steps:
+        - script: |
+            pip install -r requirements_style.txt
+          displayName: "Install dependencies to run the checks"
+        - script: black --check .
+          displayName: "Run black"
+
+    - job:
+      displayName: Run style checks with flake8
+      pool:
+        vmImage: ubuntu-latest
+      variables:
+        python.version: '3.8'
+      steps:
+        - script: |
+            pip install -r requirements_style.txt
+          displayName: "Install dependencies to run the checks"
+        - script: flake8
+          displayName: "Run flake8"
+
 - stage: Testing
   jobs:
     - template: ./.azure-pipelines/azure-pipelines-linux.yml

discretize/Tests/__init__.py

@@ -1,4 +1,4 @@
-from discretize.tests import *
+from discretize.tests import *  # NOQA F401,F403
 from discretize.utils.code_utils import deprecate_module
 
 # note this needs to be a module with an __init__ so we can avoid name clash

discretize/View.py

@@ -1,3 +1,4 @@
+"""Deprecated view module."""
 from discretize.utils.code_utils import deprecate_module
 
 deprecate_module(
@@ -7,6 +8,6 @@
     future_warn=True,
 )
 try:
-    from discretize.mixins.mpl_mod import Slicer
+    from discretize.mixins.mpl_mod import Slicer  # NOQA F401
 except ImportError:
     pass