X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/24e7ffb289fcc7e7f76a0a18ea17259ef07f7a01..bef5cea48e3ead13185e01958f7a3a80d185b11e:/nominatim/api/logging.py?ds=sidebyside diff --git a/nominatim/api/logging.py b/nominatim/api/logging.py index 3949fdae..05598660 100644 --- a/nominatim/api/logging.py +++ b/nominatim/api/logging.py @@ -7,8 +7,9 @@ """ Functions for specialised logging with HTML output. """ -from typing import Any, Optional, cast +from typing import Any, cast from contextvars import ContextVar +import textwrap import io import sqlalchemy as sa @@ -30,6 +31,8 @@ class BaseLogger: in derived classes which implement logging functionality. """ def get_buffer(self) -> str: + """ Return the current content of the log buffer. + """ return '' def function(self, func: str, **kwargs: Any) -> None: @@ -57,20 +60,32 @@ class BaseLogger: """ Print the SQL for the given statement. """ + def format_sql(self, conn: AsyncConnection, statement: 'sa.Executable') -> str: + """ Return the comiled version of the statement. + """ + try: + return str(cast('sa.ClauseElement', statement) + .compile(conn.sync_engine, compile_kwargs={"literal_binds": True})) + except sa.exc.CompileError: + pass + except NotImplementedError: + pass + + return str(cast('sa.ClauseElement', statement).compile(conn.sync_engine)) + class HTMLLogger(BaseLogger): """ Logger that formats messages in HTML. """ - def __init__(self): + def __init__(self) -> None: self.buffer = io.StringIO() def get_buffer(self) -> str: return HTML_HEADER + self.buffer.getvalue() + HTML_FOOTER + def function(self, func: str, **kwargs: Any) -> None: - """ Start a new debug chapter for the given function and its parameters. - """ self._write(f"
Parameters:
{text}
") + def var_dump(self, heading: str, var: Any) -> None: - """ Print the content of the variable to the debug output prefixed by - the given heading. - """ self._write(f'{sqlstr}
{sqlstr}
')
@@ -121,6 +128,49 @@ class HTMLLogger(BaseLogger):
self.buffer.write(text)
+class TextLogger(BaseLogger):
+ """ Logger creating output suitable for the console.
+ """
+ def __init__(self) -> None:
+ self.buffer = io.StringIO()
+
+
+ def get_buffer(self) -> str:
+ return self.buffer.getvalue()
+
+
+ def function(self, func: str, **kwargs: Any) -> None:
+ self._write(f"#### Debug output for {func}()\n\nParameters:\n")
+ for name, value in kwargs.items():
+ self._write(f' {name}: {self._python_var(value)}\n')
+ self._write('\n')
+
+
+ def section(self, heading: str) -> None:
+ self._write(f"\n# {heading}\n\n")
+
+
+ def comment(self, text: str) -> None:
+ self._write(f"{text}\n")
+
+
+ def var_dump(self, heading: str, var: Any) -> None:
+ self._write(f'{heading}:\n {self._python_var(var)}\n\n')
+
+
+ def sql(self, conn: AsyncConnection, statement: 'sa.Executable') -> None:
+ sqlstr = '\n| '.join(textwrap.wrap(self.format_sql(conn, statement), width=78))
+ self._write(f"| {sqlstr}\n\n")
+
+
+ def _python_var(self, var: Any) -> str:
+ return str(var)
+
+
+ def _write(self, text: str) -> None:
+ self.buffer.write(text)
+
+
logger: ContextVar[BaseLogger] = ContextVar('logger', default=BaseLogger())