style: run black

docs/conf.py

@@ -19,9 +19,9 @@
 import os
 
 try:
-  import configparser
+    import configparser
 except ImportError:
-  import ConfigParser as configparser
+    import ConfigParser as configparser
 
 import falcon
 
@@ -32,7 +32,7 @@
 #   * https://docs.python.org/3/library/multiprocessing.html#contexts-and-start-methods
 #
 if not sys.platform.startswith('win'):
-  multiprocessing.set_start_method('fork')
+    multiprocessing.set_start_method('fork')
 
 # on_rtd is whether we are on readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
@@ -52,7 +52,7 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -63,9 +63,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
     'sphinx_tabs.tabs',
-
     'sphinx_tabs.tabs',
-
     # Falcon-specific extensions
     'ext.doorway',
     'ext.private_args',
@@ -79,16 +77,14 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
 project = u'Falcon'
-copyright = u"{year} Falcon Contributors".format(
-  year=datetime.utcnow().year
-)
+copyright = u"{year} Falcon Contributors".format(year=datetime.utcnow().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
@@ -99,7 +95,7 @@
 tag = cfg.get('egg_info', 'tag_build')
 
 html_context = {
-  'prerelease': bool(tag),  # True if tag is not the empty string
+    'prerelease': bool(tag),  # True if tag is not the empty string
 }
 
 # The short X.Y version.
@@ -110,41 +106,41 @@
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build', '_newsfragments']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'github'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -175,26 +171,30 @@
     'github_banner': not dash_build,
     'fixed_sidebar': False,
     'show_powered_by': False,
-    'extra_nav_links': OrderedDict([
-      ('Falcon Home', 'https://falconframework.org/'),
-      ('Falcon Wiki', 'https://github.com/falconry/falcon/wiki'),
-      ('GitHub Project', 'https://github.com/falconry/falcon'),
-      ('Get Help', '/community/help.html'),
-      ('Support Falcon', 'https://falconframework.org/#sectionSupportFalconDevelopment'),
-    ]),
+    'extra_nav_links': OrderedDict(
+        [
+            ('Falcon Home', 'https://falconframework.org/'),
+            ('Falcon Wiki', 'https://github.com/falconry/falcon/wiki'),
+            ('GitHub Project', 'https://github.com/falconry/falcon'),
+            ('Get Help', '/community/help.html'),
+            ('Support Falcon', 'https://falconframework.org/#sectionSupportFalconDevelopment'),
+        ]
+    ),
 }
 
 if dash_build:
-    html_theme_options.update({
-        'font_size': 13,
-    })
+    html_theme_options.update(
+        {
+            'font_size': 13,
+        }
+    )
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -213,15 +213,15 @@
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 # html_sidebars = {
@@ -238,38 +238,40 @@
         'navigation.html',
         'relations.html',
         'searchbox.html',
-    ] if not dash_build else []
+    ]
+    if not dash_build
+    else []
 }
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Falcondoc'
@@ -278,56 +280,50 @@
 # -- 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': '',
+    # 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', 'Falcon.tex', u'Falcon Documentation',
-   u'Kurt Griffiths et al.', 'manual'),
+    ('index', 'Falcon.tex', u'Falcon Documentation', u'Kurt Griffiths et al.', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'falcon', u'Falcon Documentation',
-     [u'Kurt Griffiths et al.'], 1)
-]
+man_pages = [('index', 'falcon', u'Falcon Documentation', [u'Kurt Griffiths et al.'], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -336,22 +332,28 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'Falcon', u'Falcon Documentation',
-   u'Kurt Griffiths et al.', 'Falcon', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        'index',
+        'Falcon',
+        u'Falcon Documentation',
+        u'Kurt Griffiths et al.',
+        'Falcon',
+        'One line description of project.',
+        'Miscellaneous',
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

docs/ext/rfc.py

@@ -47,7 +47,7 @@ def _process_line(line):
 
     rendered_text = template.format(rfc=rfc, section=section)
 
-    return line[:m.start()] + rendered_text + line[m.end():]
+    return line[: m.start()] + rendered_text + line[m.end() :]
 
 
 def _on_process_docstring(app, what, name, obj, options, lines):

e2e-tests/server/hub.py

@@ -17,8 +17,7 @@ async def events(self):
 
             while True:
                 try:
-                    event = await asyncio.wait_for(
-                        self._queue.get(), timeout=self.POLL_TIMEOUT)
+                    event = await asyncio.wait_for(self._queue.get(), timeout=self.POLL_TIMEOUT)
                     yield event
                 except asyncio.TimeoutError:
                     # NOTE(vytas): Keep the connection alive.

e2e-tests/server/ping.py

@@ -4,7 +4,6 @@
 
 
 class Pong:
-
     async def on_get(self, req, resp):
         resp.content_type = falcon.MEDIA_TEXT
         resp.text = 'PONG\n'

e2e-tests/test_e2e.py

@@ -25,8 +25,7 @@ def test_sse_broadcast(browser, clear_log):
 
     browser.type('#input1', '/all Zombie apocalypse averted (for now)')
     browser.slow_click('#button1')
-    browser.assert_text(
-        '[WS1] Zombie apocalypse averted (for now)', 'div.sse', timeout=5)
+    browser.assert_text('[WS1] Zombie apocalypse averted (for now)', 'div.sse', timeout=5)
     clear_log()
 
     browser.type('#input1', '/quit')

examples/asgilook/asgilook/app.py

@@ -16,7 +16,6 @@ def create_app(config=None):
     app = falcon.asgi.App(middleware=[cache])
     app.add_route('/images', images)
     app.add_route('/images/{image_id:uuid}.jpeg', images, suffix='image')
-    app.add_route('/thumbnails/{image_id:uuid}/{width:int}x{height:int}.jpeg',
-                  thumbnails)
+    app.add_route('/thumbnails/{image_id:uuid}/{width:int}x{height:int}.jpeg', thumbnails)
 
     return app

examples/asgilook/asgilook/cache.py

@@ -25,8 +25,7 @@ def _deserialize_response(self, resp, data):
 
     async def process_startup(self, scope, event):
         if self._redis is None:
-            self._redis = await self._config.create_redis_pool(
-                self._config.redis_host)
+            self._redis = await self._config.create_redis_pool(self._config.redis_host)
 
     async def process_request(self, req, resp):
         resp.context.cached = False