Use black

Author: philpep

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+extend-ignore = E203, E266, E501
+# line length is intentionally set to 80 here because black uses Bugbear
+# See https://github.com/psf/black/blob/master/docs/the_black_code_style.md#line-length for more details
+max-line-length = 80

MANIFEST.in

@@ -5,6 +5,7 @@ recursive-include doc *.py *.rst *.svg
 include doc/source/_templates/piwik.html
 include doc/Makefile
 include tox.ini
+include .flake8
 include Makefile
 include README.rst CONTRIBUTING.rst CHANGELOG.rst
 include MANIFEST.in

doc/source/conf.py

@@ -32,7 +32,7 @@
 # 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- General configuration ------------------------------------------------
 
@@ -43,36 +43,40 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'alabaster',
+    "sphinx.ext.autodoc",
+    "alabaster",
 ]
 autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'testinfra'
-copyright = u'{}, Philippe Pepiot'.format(datetime.date.today().year)
+project = u"testinfra"
+copyright = u"{}, Philippe Pepiot".format(datetime.date.today().year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = subprocess.check_output(
-    ['python3', 'setup.py', '--version'],
-    cwd=os.path.join(os.path.dirname(__file__), os.pardir, os.pardir),
-).decode().strip()
+version = (
+    subprocess.check_output(
+        ["python3", "setup.py", "--version"],
+        cwd=os.path.join(os.path.dirname(__file__), os.pardir, os.pardir),
+    )
+    .decode()
+    .strip()
+)
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -106,7 +110,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -119,19 +123,19 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # 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
 # documentation.
 html_theme_options = {
-    'logo': 'logo.svg',
-    'github_user': 'pytest-dev',
-    'github_repo': 'pytest-testinfra',
-    'github_button': True,
-    'travis_button': True,
-    'extra_nav_links': {
-        'View on github': 'https://github.com/pytest-dev/pytest-testinfra',
+    "logo": "logo.svg",
+    "github_user": "pytest-dev",
+    "github_repo": "pytest-testinfra",
+    "github_button": True,
+    "travis_button": True,
+    "extra_nav_links": {
+        "View on github": "https://github.com/pytest-dev/pytest-testinfra",
     },
 }
 
@@ -157,7 +161,7 @@
 # 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"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -174,11 +178,11 @@
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'searchbox.html',
-        'piwik.html',
+    "**": [
+        "about.html",
+        "navigation.html",
+        "searchbox.html",
+        "piwik.html",
     ],
 }
 
@@ -213,28 +217,25 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'testinfradoc'
+htmlhelp_basename = "testinfradoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper')
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [(
-    'index', 'testinfra.tex', 'testinfra Documentation',
-    'Philippe Pepiot', 'manual'),
+latex_documents = [
+    ("index", "testinfra.tex", "testinfra Documentation", "Philippe Pepiot", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -262,10 +263,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'testinfra', 'testinfra Documentation',
-     ['Philippe Pepiot'], 1)
-]
+man_pages = [("index", "testinfra", "testinfra Documentation", ["Philippe Pepiot"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -276,10 +274,16 @@
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
-texinfo_documents = [(
-    'index', 'testinfra', 'testinfra Documentation',
-    'Philippe Pepiot', 'testinfra', 'One line description of project.',
-    'Miscellaneous'),
+texinfo_documents = [
+    (
+        "index",
+        "testinfra",
+        "testinfra Documentation",
+        "Philippe Pepiot",
+        "testinfra",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

setup.py

@@ -20,14 +20,14 @@ def local_scheme(version):
     import setuptools_scm.version  # only present during setup time
 
     return (
-        ''
-        if 'PEP440_VERSION' in os.environ
+        ""
+        if "PEP440_VERSION" in os.environ
         else setuptools_scm.version.get_local_node_and_date(version)
     )
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     setuptools.setup(
-        use_scm_version={'local_scheme': local_scheme},
+        use_scm_version={"local_scheme": local_scheme},
         setup_requires=["setuptools_scm"],
     )