Adopted Black for code formatting

Author: agronholm

.pre-commit-config.yaml

@@ -21,10 +21,10 @@ repos:
       - id: pyupgrade
         args: [ "--py37-plus", "--keep-runtime-typing" ]
 
-  - repo: https://github.com/pre-commit/mirrors-autopep8
-    rev: v1.6.0
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
     hooks:
-      - id: autopep8
+      - id: black
 
   - repo: https://github.com/pycqa/isort
     rev: 5.10.1

docs/conf.py

@@ -4,40 +4,43 @@
 from packaging.version import parse
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.extlinks',
-    'sphinx_autodoc_typehints',
-    'sphinxcontrib.asyncio'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.extlinks",
+    "sphinx_autodoc_typehints",
+    "sphinxcontrib.asyncio",
 ]
 
-templates_path = ['_templates']
-source_suffix = '.rst'
-master_doc = 'index'
-project = 'asphalt-exceptions'
-author = 'Alex Grönholm'
-copyright = '2017, ' + author
+templates_path = ["_templates"]
+source_suffix = ".rst"
+master_doc = "index"
+project = "asphalt-exceptions"
+author = "Alex Grönholm"
+copyright = "2017, " + author
 
 v = parse(get_version(project))
 version = v.base_version
 release = v.public
 
 language = None
 
-exclude_patterns = ['_build']
-pygments_style = 'sphinx'
-highlight_language = 'python3'
+exclude_patterns = ["_build"]
+pygments_style = "sphinx"
+highlight_language = "python3"
 todo_include_todos = False
 
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
-htmlhelp_basename = project.replace('-', '') + 'doc'
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+htmlhelp_basename = project.replace("-", "") + "doc"
 
 extlinks = {
-    'github': (f'https://github.com/asphalt-framework/{project}/tree/{version}/%s', None)
+    "github": (
+        f"https://github.com/asphalt-framework/{project}/tree/{version}/%s",
+        None,
+    )
 }
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'asphalt': ('https://asphalt.readthedocs.io/en/latest/', None)
+    "python": ("https://docs.python.org/3/", None),
+    "asphalt": ("https://asphalt.readthedocs.io/en/latest/", None),
 }

pyproject.toml

@@ -65,12 +65,7 @@ local_scheme = "dirty-tag"
 [tool.isort]
 src_paths = ["src"]
 skip_gitignore = true
-line_length = 99
-multi_line_output = 4
-known_first_party = ["asphalt.exceptions"]
-
-[tool.autopep8]
-max_line_length = 99
+profile = "black"
 
 [tool.flake8]
 max-line-length = 99

src/asphalt/exceptions/__init__.py

@@ -9,13 +9,18 @@
 
 from asphalt.exceptions.api import ExceptionReporter, ExtrasProvider
 
-__all__ = ('report_exception',)
+__all__ = ("report_exception",)
 
 module_logger = logging.getLogger(__name__)
 
 
-def report_exception(ctx: Context, message: str, exception: BaseException = None, *,
-                     logger: logging.Logger | str | bool = True) -> None:
+def report_exception(
+    ctx: Context,
+    message: str,
+    exception: BaseException = None,
+    *,
+    logger: logging.Logger | str | bool = True,
+) -> None:
     """
     Report an exception to all exception reporters in the given context (and optionally log it too)
 
@@ -31,8 +36,10 @@ def report_exception(ctx: Context, message: str, exception: BaseException = None
     if not exception:
         exception = sys.exc_info()[1]
         if not exception:
-            raise ValueError('missing "exception" parameter and no current exception present in '
-                             'sys.exc_info()')
+            raise ValueError(
+                'missing "exception" parameter and no current exception present in '
+                "sys.exc_info()"
+            )
 
     actual_logger: logging.Logger | None
     if isinstance(logger, bool):
@@ -43,7 +50,7 @@ def report_exception(ctx: Context, message: str, exception: BaseException = None
             if module and module.__spec__:
                 actual_logger = logging.getLogger(module.__spec__.name)
             else:  # pragma: no cover
-                actual_logger = logging.getLogger(frame.f_globals['__name__'])
+                actual_logger = logging.getLogger(frame.f_globals["__name__"])
         else:
             actual_logger = None
     elif isinstance(logger, str):
@@ -61,14 +68,18 @@ def report_exception(ctx: Context, message: str, exception: BaseException = None
             try:
                 new_extra = provider.get_extras(ctx, reporter)
             except Exception:
-                module_logger.exception('error retrieving exception extras for %s from %s',
-                                        qualified_name(reporter), qualified_name(provider))
+                module_logger.exception(
+                    "error retrieving exception extras for %s from %s",
+                    qualified_name(reporter),
+                    qualified_name(provider),
+                )
             else:
                 if isinstance(new_extra, dict):
                     extra = merge_config(extra, new_extra)
 
         try:
             reporter.report_exception(ctx, exception, message, extra)
         except Exception:
-            module_logger.exception('error calling exception reporter (%s)',
-                                    qualified_name(reporter))
+            module_logger.exception(
+                "error calling exception reporter (%s)", qualified_name(reporter)
+            )

src/asphalt/exceptions/api.py

@@ -15,8 +15,13 @@ class ExceptionReporter(metaclass=ABCMeta):
     """
 
     @abstractmethod
-    def report_exception(self, ctx: Context, exception: BaseException, message: str,
-                         extra: dict[str, Any]) -> None:
+    def report_exception(
+        self,
+        ctx: Context,
+        exception: BaseException,
+        message: str,
+        extra: dict[str, Any],
+    ) -> None:
         """
         Report the given exception to an external service.
 
@@ -43,7 +48,9 @@ class ExtrasProvider(metaclass=ABCMeta):
     """
 
     @abstractmethod
-    def get_extras(self, ctx: Context, reporter: ExceptionReporter) -> dict[str, Any] | None:
+    def get_extras(
+        self, ctx: Context, reporter: ExceptionReporter
+    ) -> dict[str, Any] | None:
         """
         Return context specific extras for the given exception reporter backend.
 

src/asphalt/exceptions/component.py

@@ -6,19 +6,26 @@
 from typing import Any, AsyncIterator, Dict, Optional
 
 from asphalt.core import (
-    Component, Context, PluginContainer, context_teardown, merge_config, qualified_name)
+    Component,
+    Context,
+    PluginContainer,
+    context_teardown,
+    merge_config,
+    qualified_name,
+)
 from typeguard import check_argument_types
 
 from asphalt.exceptions import report_exception
 from asphalt.exceptions.api import ExceptionReporter
 
-reporter_backends = PluginContainer('asphalt.exceptions.reporters', ExceptionReporter)
+reporter_backends = PluginContainer("asphalt.exceptions.reporters", ExceptionReporter)
 logger = logging.getLogger(__name__)
 
 
-def default_exception_handler(loop: AbstractEventLoop, context: dict[str, Any], *,
-                              ctx: Context) -> None:
-    report_exception(ctx, context['message'], context['exception'])
+def default_exception_handler(
+    loop: AbstractEventLoop, context: dict[str, Any], *, ctx: Context
+) -> None:
+    report_exception(ctx, context["message"], context["exception"])
 
 
 class ExceptionReporterComponent(Component):
@@ -52,17 +59,21 @@ class ExceptionReporterComponent(Component):
     :param default_args: default values for constructor keyword arguments
     """
 
-    def __init__(self, reporters: Dict[str, Optional[Dict[str, Any]]] = None,
-                 install_default_handler: bool = True, **default_args) -> None:
+    def __init__(
+        self,
+        reporters: Dict[str, Optional[Dict[str, Any]]] = None,
+        install_default_handler: bool = True,
+        **default_args,
+    ) -> None:
         assert check_argument_types()
         self.install_default_handler = install_default_handler
         if not reporters:
-            reporters = {'default': default_args}
+            reporters = {"default": default_args}
 
         self.reporters: list[tuple] = []
         for resource_name, config in reporters.items():
             merged_config = merge_config(default_args, config or {})
-            type_ = merged_config.pop('backend', resource_name)
+            type_ = merged_config.pop("backend", resource_name)
             serializer = reporter_backends.create_object(type_, **merged_config)
             self.reporters.append((resource_name, serializer))
 
@@ -71,15 +82,18 @@ async def start(self, ctx: Context) -> AsyncIterator[None]:
         for resource_name, reporter in self.reporters:
             types = [ExceptionReporter, type(reporter)]
             ctx.add_resource(reporter, resource_name, types=types)
-            logger.info('Configured exception reporter (%s; class=%s)', resource_name,
-                        qualified_name(reporter))
+            logger.info(
+                "Configured exception reporter (%s; class=%s)",
+                resource_name,
+                qualified_name(reporter),
+            )
 
         if self.install_default_handler:
             handler = partial(default_exception_handler, ctx=ctx)
             ctx.loop.set_exception_handler(handler)
-            logger.info('Installed default event loop exception handler')
+            logger.info("Installed default event loop exception handler")
 
             yield
 
             ctx.loop.set_exception_handler(None)
-            logger.info('Uninstalled default event loop exception handler')
+            logger.info("Uninstalled default event loop exception handler")

src/asphalt/exceptions/reporters/raygun.py

@@ -28,6 +28,11 @@ class RaygunExceptionReporter(ExceptionReporter):
     def __init__(self, api_key: str, **config) -> None:
         self.client = RaygunSender(api_key, config)
 
-    def report_exception(self, ctx: Context, exception: BaseException, message: str,
-                         extra: dict[str, Any]) -> None:
+    def report_exception(
+        self,
+        ctx: Context,
+        exception: BaseException,
+        message: str,
+        extra: dict[str, Any],
+    ) -> None:
         self.client.send_exception(exception, **extra)

src/asphalt/exceptions/reporters/sentry.py

@@ -36,13 +36,20 @@ class SentryExceptionReporter(ExceptionReporter):
     """
 
     def __init__(self, **client_args) -> None:
-        client_args.setdefault('environment', 'development' if __debug__ else 'production')
-        client_args.setdefault('transport', AioHttpTransport)
-        client_args.setdefault('enable_breadcrumbs', False)
-        client_args.setdefault('install_logging_hook', False)
+        client_args.setdefault(
+            "environment", "development" if __debug__ else "production"
+        )
+        client_args.setdefault("transport", AioHttpTransport)
+        client_args.setdefault("enable_breadcrumbs", False)
+        client_args.setdefault("install_logging_hook", False)
         self.client = Client(**client_args)
 
-    def report_exception(self, ctx: Context, exception: BaseException, message: str,
-                         extra: dict[str, Any]) -> None:
+    def report_exception(
+        self,
+        ctx: Context,
+        exception: BaseException,
+        message: str,
+        extra: dict[str, Any],
+    ) -> None:
         exc_info = type(exception), exception, exception.__traceback__
         self.client.captureException(exc_info, message=message, **extra)

tests/reporters/test_raygun.py

@@ -15,9 +15,9 @@ async def test_raygun():
     except ZeroDivisionError as exc:
         exception = exc
 
-    reporter = RaygunExceptionReporter('abvcgrdg234')
-    with patch.object(reporter.client, '_post') as post:
-        reporter.report_exception(Context(), exception, 'test exception', {})
+    reporter = RaygunExceptionReporter("abvcgrdg234")
+    with patch.object(reporter.client, "_post") as post:
+        reporter.report_exception(Context(), exception, "test exception", {})
 
     await asyncio.sleep(0.1)
     assert post.call_count == 1

tests/reporters/test_sentry.py

@@ -15,9 +15,9 @@ async def test_sentry():
     except ZeroDivisionError as exc:
         exception = exc
 
-    reporter = SentryExceptionReporter(dsn='http://username:[email protected]/000000')
-    with patch.object(reporter.client, 'send') as send:
-        reporter.report_exception(Context(), exception, 'test exception', {})
+    reporter = SentryExceptionReporter(dsn="http://username:[email protected]/000000")
+    with patch.object(reporter.client, "send") as send:
+        reporter.report_exception(Context(), exception, "test exception", {})
 
     await asyncio.sleep(0.1)
     assert send.call_count == 1