Blacken

Makefile

@@ -11,10 +11,11 @@ test:
 	$(PYTHON) -m pytest --cov=trio_websocket --cov-report=term-missing --no-cov-on-fail
 
 lint:
+	$(PYTHON) -m black trio_websocket/ tests/ autobahn/ examples/
 	$(PYTHON) -m pylint trio_websocket/ tests/ autobahn/ examples/
 
 typecheck:
-	$(PYTHON) -m mypy --explicit-package-bases trio_websocket tests autobahn examples
+	$(PYTHON) -m mypy
 
 publish:
 	rm -fr build dist .egg trio_websocket.egg-info

autobahn/client.py

@@ -1,7 +1,8 @@
-'''
+"""
 This test client runs against the Autobahn test server. It is based on the
 test_client.py in wsproto.
-'''
+"""
+
 import argparse
 import json
 import logging
@@ -11,28 +12,28 @@
 from trio_websocket import open_websocket_url, ConnectionClosed
 
 
-AGENT = 'trio-websocket'
+AGENT = "trio-websocket"
 MAX_MESSAGE_SIZE = 16 * 1024 * 1024
 logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger('client')
+logger = logging.getLogger("client")
 
 
-async def get_case_count(url):
-    url = url + '/getCaseCount'
+async def get_case_count(url: str) -> int:
+    url = url + "/getCaseCount"
     async with open_websocket_url(url) as conn:
         case_count = await conn.get_message()
-        logger.info('Case count=%s', case_count)
+        logger.info("Case count=%s", case_count)
     return int(case_count)
 
 
-async def get_case_info(url, case):
-    url = f'{url}/getCaseInfo?case={case}'
+async def get_case_info(url: str, case: str) -> object:
+    url = f"{url}/getCaseInfo?case={case}"
     async with open_websocket_url(url) as conn:
         return json.loads(await conn.get_message())
 
 
-async def run_case(url, case):
-    url = f'{url}/runCase?case={case}&agent={AGENT}'
+async def run_case(url: str, case: str) -> None:
+    url = f"{url}/runCase?case={case}&agent={AGENT}"
     try:
         async with open_websocket_url(url, max_message_size=MAX_MESSAGE_SIZE) as conn:
             while True:
@@ -42,16 +43,16 @@ async def run_case(url, case):
         pass
 
 
-async def update_reports(url):
-    url = f'{url}/updateReports?agent={AGENT}'
+async def update_reports(url: str) -> None:
+    url = f"{url}/updateReports?agent={AGENT}"
     async with open_websocket_url(url) as conn:
         # This command runs as soon as we connect to it, so we don't need to
         # send any messages.
         pass
 
 
-async def run_tests(args):
-    logger = logging.getLogger('trio-websocket')
+async def run_tests(args: argparse.Namespace) -> None:
+    logger = logging.getLogger("trio-websocket")
     if args.debug_cases:
         # Don't fetch case count when debugging a subset of test cases. It adds
         # noise to the debug logging.
@@ -62,7 +63,10 @@ async def run_tests(args):
         test_cases = list(range(1, case_count + 1))
     exception_cases = []
     for case in test_cases:
-        case_id = (await get_case_info(args.url, case))['id']
+        result = await get_case_info(args.url, case)
+        assert isinstance(result, dict)
+        case_id = result["id"]
+        assert isinstance(case_id, int)
         if case_count:
             logger.info("Running test case %s (%d of %d)", case_id, case, case_count)
         else:
@@ -71,28 +75,37 @@ async def run_tests(args):
         try:
             await run_case(args.url, case)
         except Exception:  # pylint: disable=broad-exception-caught
-            logger.exception('  runtime exception during test case %s (%d)', case_id, case)
+            logger.exception(
+                "  runtime exception during test case %s (%d)", case_id, case
+            )
             exception_cases.append(case_id)
         logger.setLevel(logging.INFO)
-    logger.info('Updating report')
+    logger.info("Updating report")
     await update_reports(args.url)
     if exception_cases:
-        logger.error('Runtime exception in %d of %d test cases: %s',
-                     len(exception_cases), len(test_cases), exception_cases)
+        logger.error(
+            "Runtime exception in %d of %d test cases: %s",
+            len(exception_cases),
+            len(test_cases),
+            exception_cases,
+        )
         sys.exit(1)
 
 
-def parse_args():
-    ''' Parse command line arguments. '''
-    parser = argparse.ArgumentParser(description='Autobahn client for'
-        ' trio-websocket')
-    parser.add_argument('url', help='WebSocket URL for server')
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(description="Autobahn client for trio-websocket")
+    parser.add_argument("url", help="WebSocket URL for server")
     # TODO: accept case ID's rather than indices
-    parser.add_argument('debug_cases', type=int, nargs='*', help='Run'
-        ' individual test cases with debug logging (optional)')
+    parser.add_argument(
+        "debug_cases",
+        type=int,
+        nargs="*",
+        help="Run individual test cases with debug logging (optional)",
+    )
     return parser.parse_args()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     args = parse_args()
     trio.run(run_tests, args)

autobahn/server.py

@@ -1,4 +1,4 @@
-'''
+"""
 This simple WebSocket server responds to text messages by reversing each
 message string and sending it back.
 
@@ -7,34 +7,36 @@
 
 To use SSL/TLS: install the `trustme` package from PyPI and run the
 `generate-cert.py` script in this directory.
-'''
+"""
+
 import argparse
 import logging
 
 import trio
 from trio_websocket import serve_websocket, ConnectionClosed, WebSocketRequest
 
-BIND_IP = '0.0.0.0'
+BIND_IP = "0.0.0.0"
 BIND_PORT = 9000
 MAX_MESSAGE_SIZE = 16 * 1024 * 1024
 logging.basicConfig()
-logger = logging.getLogger('client')
+logger = logging.getLogger("client")
 logger.setLevel(logging.INFO)
 connection_count = 0
 
 
-async def main():
-    ''' Main entry point. '''
-    logger.info('Starting websocket server on ws://%s:%d', BIND_IP, BIND_PORT)
-    await serve_websocket(handler, BIND_IP, BIND_PORT, ssl_context=None,
-                          max_message_size=MAX_MESSAGE_SIZE)
+async def main() -> None:
+    """Main entry point."""
+    logger.info("Starting websocket server on ws://%s:%d", BIND_IP, BIND_PORT)
+    await serve_websocket(
+        handler, BIND_IP, BIND_PORT, ssl_context=None, max_message_size=MAX_MESSAGE_SIZE
+    )
 
 
-async def handler(request: WebSocketRequest):
-    ''' Reverse incoming websocket messages and send them back. '''
+async def handler(request: WebSocketRequest) -> None:
+    """Reverse incoming websocket messages and send them back."""
     global connection_count  # pylint: disable=global-statement
     connection_count += 1
-    logger.info('Connection #%d', connection_count)
+    logger.info("Connection #%d", connection_count)
     ws = await request.accept()
     while True:
         try:
@@ -43,20 +45,22 @@ async def handler(request: WebSocketRequest):
         except ConnectionClosed:
             break
         except Exception:  # pylint: disable=broad-exception-caught
-            logger.exception('  runtime exception handling connection #%d', connection_count)
+            logger.exception(
+                "  runtime exception handling connection #%d", connection_count
+            )
 
 
-def parse_args():
-    ''' Parse command line arguments. '''
-    parser = argparse.ArgumentParser(description='Autobahn server for'
-        ' trio-websocket')
-    parser.add_argument('-d', '--debug', action='store_true',
-        help='WebSocket URL for server')
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(description="Autobahn server for trio-websocket")
+    parser.add_argument(
+        "-d", "--debug", action="store_true", help="WebSocket URL for server"
+    )
     return parser.parse_args()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     args = parse_args()
     if args.debug:
-        logging.getLogger('trio-websocket').setLevel(logging.DEBUG)
+        logging.getLogger("trio-websocket").setLevel(logging.DEBUG)
     trio.run(main)

docs/conf.py

@@ -19,11 +19,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Trio WebSocket'
-copyright = '2018, Hyperion Gray'
-author = 'Hyperion Gray'
+project = "Trio WebSocket"
+copyright = "2018, Hyperion Gray"
+author = "Hyperion Gray"
 
 from trio_websocket._version import __version__ as version
+
 release = version
 
 
@@ -37,22 +38,22 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinxcontrib_trio',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinxcontrib_trio",
 ]
 
 # 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"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -64,7 +65,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects 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 = None
@@ -75,7 +76,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # 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
@@ -86,7 +87,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"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -102,46 +103,44 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'TrioWebSocketdoc'
+htmlhelp_basename = "TrioWebSocketdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #
     # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
     #
+    # The font size ('10pt', '11pt' or '12pt').
     # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
     #
+    # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
-
-    # Latex figure (float) alignment
     #
+    # Latex figure (float) alignment
     # 'figure_align': 'htbp',
 }
 
 # 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 = [
-    (master_doc, 'TrioWebSocket.tex', 'Trio WebSocket Documentation',
-     'Hyperion Gray', 'manual'),
+    (
+        master_doc,
+        "TrioWebSocket.tex",
+        "Trio WebSocket Documentation",
+        "Hyperion Gray",
+        "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, 'triowebsocket', 'Trio WebSocket Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "triowebsocket", "Trio WebSocket Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -150,9 +149,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'TrioWebSocket', 'Trio WebSocket Documentation',
-     author, 'TrioWebSocket', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "TrioWebSocket",
+        "Trio WebSocket Documentation",
+        author,
+        "TrioWebSocket",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -171,10 +176,10 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 intersphinx_mapping = {
-    'trio': ('https://trio.readthedocs.io/en/stable/', None),
+    "trio": ("https://trio.readthedocs.io/en/stable/", None),
 }