Fixes Issue #163

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = *.pyc,*.txt,*.gif,*.png,*.jpg,*.ply,*.vtk,*.vti,*.vtu,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,doc/_build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/examples/*,*.mypy_cache/*,*cover,./tests/tinypages/_build/*,*/_autosummary/*
+ignore-words-list = lod,byteorder,flem,parm,doubleclick,revered,PullRequest
+quiet-level = 3

.coveragerc

@@ -4,6 +4,7 @@ source = pyvistaqt
 omit =
     */setup.py
     */pyvistaqt/rwi.py
+    */py.typed
 
 [report]
 exclude_lines =

.flake8

@@ -0,0 +1,36 @@
+[flake8]
+max-line-length = 100
+exclude =
+    __pycache__,
+    .venv,
+    .cache,
+    .eggs
+    .git,
+    .tox,
+    *.egg-info,
+    *.pyc,
+    *.pyi,
+    build,
+    dist,
+    # This is adopted from VTK
+    pyvistaqt/rwi.py,
+max-complexity = 10
+doctests = true
+extend-ignore =
+    # whitespace before ':'
+    E203,
+    # line break before binary operator
+    W503,
+    # line length too long
+    E501,
+    # do not assign a lambda expression, use a def
+    E731,
+    # missing class docstring; use ``__init__`` docstring instead
+    D101,
+    # missing docstring in magic method
+    D105,
+    # Qt uses camelCase
+    N802
+per-file-ignores =
+    # "Imported but unused: happens with packages
+    __init__.py:F401

.pre-commit-config.yaml

@@ -0,0 +1,64 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 22.3.0
+  hooks:
+  - id: black
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+  - id: isort
+
+- repo: https://gitlab.com/PyCQA/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+    additional_dependencies: [
+      "flake8-black==0.3.2",
+      "flake8-isort==4.1.1",
+      "flake8-quotes==3.3.1",
+    ]
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+  - id: codespell
+    args: [
+      "doc examples examples_flask pyvista tests",
+      "*.py *.rst *.md",
+    ]
+
+- repo: https://github.com/pycqa/pydocstyle
+  rev: 6.1.1
+  hooks:
+  - id: pydocstyle
+    additional_dependencies: [toml==0.10.2]
+    files: ^(pyvista/|other/)
+    exclude: ^pyvista/ext/
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.3.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+  - id: no-commit-to-branch
+    args: [--branch, main]
+
+# this validates our github workflow files
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.16.2
+  hooks:
+    - id: check-github-workflows
+
+- repo: local
+  hooks:
+    - id: pylint
+      name: pylint
+      entry: pylint
+      language: system
+      types: [python]
+      args:
+        [
+          "-rn", # Only display messages
+          "-sn", # Don't display the score
+        ]

.pylintrc

@@ -3,18 +3,24 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-whitelist=vtk
+extension-pkg-whitelist=vtk,
+                        PyQt5,
+                        PyQt6,
+                        PySide2,
+                        PySide6
 
 # Specify a score threshold to be exceeded before program exits with error.
 fail-under=10
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS
+ignore=rwi.py,
+       conf.py,
+       conftest.py
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=
+ignore-patterns=test_.*[.]py
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
@@ -60,89 +66,21 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
-disable=print-statement,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
-        raw-checker-failed,
+disable=raw-checker-failed,
         bad-inline-option,
         locally-disabled,
         file-ignored,
         suppressed-message,
         useless-suppression,
         deprecated-pragma,
         use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape,
-        bad-continuation,
         arguments-differ,
         no-name-in-module,
-        no-member
+        no-member,
+        # Redundant alias imports required for type hinting by PEP 484
+        useless-import-alias,
+        # Qt uses PascalCase
+        invalid-name,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -446,8 +384,11 @@ max-module-lines=1000
 # separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
 # `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
+#
+# Removed in version 2.15
+# https://pylint.pycqa.org/en/latest/whatsnew/2/2.6/summary.html#summary-release-highlights
+; no-space-check=trailing-comma,
+;                dict-separator
 
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.