add-black (esphome#1044)

* Setup pre-commit and black

update pre-commit

add setup

* format with black

format and flake

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/ambv/black
+    rev: 20.8b1
+    hooks:
+    - id: black
+      args:
+        - --safe
+        - --quiet
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-docstrings==1.5.0
+          - pydocstyle==5.1.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: no-commit-to-branch
+        args:
+          - --branch=current
+          - --branch=next
+          - --branch=beta

conf.py

@@ -22,14 +22,10 @@
 # sys.path.insert(0, os.path.abspath('.'))
 import hashlib
 import os
-import subprocess
-from sphinx import addnodes
-from sphinx.util.docfields import Field, GroupedField
-import re
 import sys
 
 
-sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath("."))
 
 # -- General configuration ------------------------------------------------
 
@@ -41,58 +37,58 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'github',
-    'seo',
-    'sitemap',
+    "github",
+    "seo",
+    "sitemap",
 ]
 
 # 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 = 'ESPHome'
-copyright = '2019, Otto Winter'
+project = "ESPHome"
+copyright = "2019, Otto Winter"
 html_show_copyright = False
 html_show_sphinx = False
-author = 'Otto Winter'
+author = "Otto Winter"
 
 # 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 = '1.17'
+version = "1.17"
 # The full version, including alpha/beta/rc tags.
-release = '1.17.0-dev'
+release = "1.17.0-dev"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'en'
+language = "en"
 
 # 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 reST default role (used for this markup: `text`) to use for all documents.
 # default_role = 'cpp:any'
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'xcode'
+pygments_style = "xcode"
 
-highlight_language = 'yaml'
+highlight_language = "yaml"
 
 primary_domain = None
 
@@ -105,59 +101,59 @@
 # 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_baseurl = os.getenv('BASE_URL', 'https://esphome.io')
-with open('_static/custom.css', 'rb') as f:
+html_baseurl = os.getenv("BASE_URL", "https://esphome.io")
+with open("_static/custom.css", "rb") as f:
     custom_css_hash = hashlib.md5(f.read()).hexdigest()[:8]
 
 html_theme_options = {
     # 'logo': 'logo-full.png',
-    'logo_name': False,
-    'show_related': False,
-    'sidebar_collapse': True,
-    'fixed_sidebar': True,
-    'show_powered_by': False,
+    "logo_name": False,
+    "show_related": False,
+    "sidebar_collapse": True,
+    "fixed_sidebar": True,
+    "show_powered_by": False,
 }
 
 html_context = {
-    'custom_css_hash': custom_css_hash,
+    "custom_css_hash": custom_css_hash,
 }
 
-html_logo = 'images/logo-text.svg'
+html_logo = "images/logo-text.svg"
 html_copy_source = True
 html_show_sourcelink = False
 html_last_updated_fmt = None
 html_use_smartypants = False
-html_title = 'ESPHome'
+html_title = "ESPHome"
 
 # 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 = {
-    '**': [
+    "**": [
         # 'about.html',
-        'searchbox.html',
-        'localtoc.html',
+        "searchbox.html",
+        "localtoc.html",
     ]
 }
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'esphomedoc'
+htmlhelp_basename = "esphomedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -166,15 +162,12 @@
     # 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',
@@ -184,21 +177,17 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'esphome.tex', 'ESPHome Documentation',
-     'Otto Winter', 'manual'),
+    (master_doc, "esphome.tex", "ESPHome Documentation", "Otto Winter", "manual"),
 ]
 
-latex_engine = 'xelatex'
+latex_engine = "xelatex"
 
 
 # -- 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, 'esphome', 'ESPHome Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "esphome", "ESPHome Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -207,8 +196,14 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'esphome', 'ESPHome Documentation',
-     author, 'esphome', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "esphome",
+        "ESPHome Documentation",
+        author,
+        "esphome",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
-linkcheck_ignore = [r'https://github.com/.*', r'https://discord.gg/.*']
+linkcheck_ignore = [r"https://github.com/.*", r"https://discord.gg/.*"]