diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-12-08 14:04:35 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-08 14:04:35 +0000 |
| commit | ab7a24cc6bbffa5ba67b42731c45b1d4d33f3ae3 (patch) | |
| tree | 9aeefb42b2c5871847505fc50f58127c7b605ebb /synapse/config/_base.pyi | |
| parent | Simplify the flow for SSO UIA (#8881) (diff) | |
| download | synapse-ab7a24cc6bbffa5ba67b42731c45b1d4d33f3ae3.tar.xz | |
Better formatting for config errors from modules (#8874)
The idea is that the parse_config method of extension modules can raise either a ConfigError or a JsonValidationError, and it will be magically turned into a legible error message. There's a few components to it: * Separating the "path" and the "message" parts of a ConfigError, so that we can fiddle with the path bit to turn it into an absolute path. * Generally improving the way ConfigErrors get printed. * Passing in the config path to load_module so that it can wrap any exceptions that get caught appropriately.
Diffstat (limited to 'synapse/config/_base.pyi')
| -rw-r--r-- | synapse/config/_base.pyi | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/synapse/config/_base.pyi b/synapse/config/_base.pyi index b8faafa9bd..ed26e2fb60 100644 --- a/synapse/config/_base.pyi +++ b/synapse/config/_base.pyi @@ -1,4 +1,4 @@ -from typing import Any, List, Optional +from typing import Any, Iterable, List, Optional from synapse.config import ( api, @@ -35,7 +35,10 @@ from synapse.config import ( workers, ) -class ConfigError(Exception): ... +class ConfigError(Exception): + def __init__(self, msg: str, path: Optional[Iterable[str]] = None): + self.msg = msg + self.path = path MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS: str MISSING_REPORT_STATS_SPIEL: str |