Add pylint and black. Apply formatting (#364)

* Install pylint and black

* Add black config and pylintrc file

* Apply black formatting

* Add black format to workflow

Author: cx1111

.github/workflows/run-tests.yml

@@ -33,6 +33,8 @@ jobs:
         run: pytest
       - name: Validate poetry file
         run: poetry check
+      - name: Format files
+        run: black .
 
   test-deb10-i386:
     runs-on: ubuntu-latest

docs/conf.py

@@ -20,16 +20,19 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 # For dependencies
 from unittest.mock import MagicMock
+
+
 class Mock(MagicMock):
     @classmethod
     def __getattr__(cls, name):
-            return MagicMock()
+        return MagicMock()
 
-MOCK_MODULES = ['numpy', 'matplotlib', 'matplotlib.pyplot', 'pandas', 'scipy']
+
+MOCK_MODULES = ["numpy", "matplotlib", "matplotlib.pyplot", "pandas", "scipy"]
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # -- General configuration ------------------------------------------------
@@ -41,26 +44,26 @@ def __getattr__(cls, name):
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'wfdb'
-copyright = '2018, MIT Lab for Computational Physiology'
-author = 'MIT Lab for Computational Physiology'
+project = "wfdb"
+copyright = "2018, MIT Lab for Computational Physiology"
+author = "MIT Lab for Computational Physiology"
 
-with open('../wfdb/version.py') as f:
+with open("../wfdb/version.py") as f:
     __version__ = f.read().split()[-1].strip("'")
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -81,10 +84,10 @@ def __getattr__(cls, name):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -95,7 +98,7 @@ def __getattr__(cls, name):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'classic'
+html_theme = "classic"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -106,25 +109,25 @@ def __getattr__(cls, name):
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # This is required for the alabaster theme
 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 html_sidebars = {
-    '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
+    "**": [
+        "relations.html",  # needs 'show_related': True theme option to display
+        "searchbox.html",
     ]
 }
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'wfdbdoc'
+htmlhelp_basename = "wfdbdoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -133,15 +136,12 @@ def __getattr__(cls, name):
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -151,19 +151,15 @@ def __getattr__(cls, name):
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'wfdb.tex', 'wfdb Documentation',
-     author, 'manual'),
+    (master_doc, "wfdb.tex", "wfdb Documentation", author, "manual"),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'wfdb', 'wfdb Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "wfdb", "wfdb Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -172,7 +168,13 @@ def __getattr__(cls, name):
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'wfdb', 'wfdb Documentation',
-     author, 'wfdb', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "wfdb",
+        "wfdb Documentation",
+        author,
+        "wfdb",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]