diff --git a/docker/start.py b/docker/start.py
index ac62bbc8ba..4ac8f03477 100755
--- a/docker/start.py
+++ b/docker/start.py
@@ -6,27 +6,28 @@ import os
import platform
import subprocess
import sys
+from typing import Any, Dict, List, Mapping, MutableMapping, NoReturn, Optional
import jinja2
# Utility functions
-def log(txt):
+def log(txt: str) -> None:
print(txt, file=sys.stderr)
-def error(txt):
+def error(txt: str) -> NoReturn:
log(txt)
sys.exit(2)
-def convert(src, dst, environ):
+def convert(src: str, dst: str, environ: Mapping[str, object]) -> None:
"""Generate a file from a template
Args:
- src (str): path to input file
- dst (str): path to file to write
- environ (dict): environment dictionary, for replacement mappings.
+ src: path to input file
+ dst: path to file to write
+ environ: environment dictionary, for replacement mappings.
"""
with open(src) as infile:
template = infile.read()
@@ -35,25 +36,30 @@ def convert(src, dst, environ):
outfile.write(rendered)
-def generate_config_from_template(config_dir, config_path, environ, ownership):
+def generate_config_from_template(
+ config_dir: str,
+ config_path: str,
+ os_environ: Mapping[str, str],
+ ownership: Optional[str],
+) -> None:
"""Generate a homeserver.yaml from environment variables
Args:
- config_dir (str): where to put generated config files
- config_path (str): where to put the main config file
- environ (dict): environment dictionary
- ownership (str|None): "<user>:<group>" string which will be used to set
+ config_dir: where to put generated config files
+ config_path: where to put the main config file
+ os_environ: environment mapping
+ ownership: "<user>:<group>" string which will be used to set
ownership of the generated configs. If None, ownership will not change.
"""
for v in ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"):
- if v not in environ:
+ if v not in os_environ:
error(
"Environment variable '%s' is mandatory when generating a config file."
% (v,)
)
# populate some params from data files (if they exist, else create new ones)
- environ = environ.copy()
+ environ: Dict[str, Any] = dict(os_environ)
secrets = {
"registration": "SYNAPSE_REGISTRATION_SHARED_SECRET",
"macaroon": "SYNAPSE_MACAROON_SECRET_KEY",
@@ -127,12 +133,12 @@ def generate_config_from_template(config_dir, config_path, environ, ownership):
subprocess.check_output(args)
-def run_generate_config(environ, ownership):
+def run_generate_config(environ: Mapping[str, str], ownership: Optional[str]) -> None:
"""Run synapse with a --generate-config param to generate a template config file
Args:
- environ (dict): env var dict
- ownership (str|None): "userid:groupid" arg for chmod. If None, ownership will not change.
+ environ: env vars from `os.enrivon`.
+ ownership: "userid:groupid" arg for chmod. If None, ownership will not change.
Never returns.
"""
@@ -178,7 +184,7 @@ def run_generate_config(environ, ownership):
os.execv(sys.executable, args)
-def main(args, environ):
+def main(args: List[str], environ: MutableMapping[str, str]) -> None:
mode = args[1] if len(args) > 1 else "run"
# if we were given an explicit user to switch to, do so
|
