switch API parameters to keyword arguments

[nominatim.git] / nominatim / api / logging.py

diff --git a/nominatim/api/logging.py b/nominatim/api/logging.py
index 3949fdae1798c44569ef70494d5ce1f0e35f7aa2..05598660254bd0a42fe04f66c446174e5ce4a515 100644 (file)
--- a/nominatim/api/logging.py
+++ b/nominatim/api/logging.py
@@ -7,8 +7,9 @@
 """
 Functions for specialised logging with HTML output.
 """
 """
 Functions for specialised logging with HTML output.
 """

-from typing import Any, Optional, cast
+from typing import Any, cast

 from contextvars import ContextVar
 from contextvars import ContextVar

+import textwrap

 import io
 
 import sqlalchemy as sa
 import io
 
 import sqlalchemy as sa


@@ -30,6 +31,8 @@ class BaseLogger:
         in derived classes which implement logging functionality.
     """
     def get_buffer(self) -> str:
         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:
         return ''
 
     def function(self, func: str, **kwargs: Any) -> None:


@@ -57,20 +60,32 @@ class BaseLogger:
         """ Print the SQL for the given statement.
         """
 
         """ 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.
     """
 
 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
 
         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:
     def function(self, func: str, **kwargs: Any) -> None:

-        """ Start a new debug chapter for the given function and its parameters.
-        """

         self._write(f"<h1>Debug output for {func}()</h1>\n<p>Parameters:<dl>")
         for name, value in kwargs.items():
             self._write(f'<dt>{name}</dt><dd>{self._python_var(value)}</dd>')
         self._write(f"<h1>Debug output for {func}()</h1>\n<p>Parameters:<dl>")
         for name, value in kwargs.items():
             self._write(f'<dt>{name}</dt><dd>{self._python_var(value)}</dd>')


@@ -78,30 +93,22 @@ class HTMLLogger(BaseLogger):
 
 
     def section(self, heading: str) -> None:
 
 
     def section(self, heading: str) -> None:

-        """ Start a new section with the given title.
-        """

         self._write(f"<h2>{heading}</h2>")
 
         self._write(f"<h2>{heading}</h2>")
 

+

     def comment(self, text: str) -> None:
     def comment(self, text: str) -> None:

-        """ Add a simple comment to the debug output.
-        """

         self._write(f"<p>{text}</p>")
 
         self._write(f"<p>{text}</p>")
 

+

     def var_dump(self, heading: str, var: Any) -> None:
     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'<h5>{heading}</h5>{self._python_var(var)}')
 
 
     def sql(self, conn: AsyncConnection, statement: 'sa.Executable') -> None:
         self._write(f'<h5>{heading}</h5>{self._python_var(var)}')
 
 
     def sql(self, conn: AsyncConnection, statement: 'sa.Executable') -> None:

-        """ Dump the SQL statement to debug output.
-        """
-        sqlstr = str(cast('sa.ClauseElement', statement)
-                      .compile(conn.sync_engine, compile_kwargs={"literal_binds": True}))
+        sqlstr = self.format_sql(conn, statement)

         if CODE_HIGHLIGHT:
             sqlstr = highlight(sqlstr, PostgresLexer(),
         if CODE_HIGHLIGHT:
             sqlstr = highlight(sqlstr, PostgresLexer(),

-                               HtmlFormatter(nowrap=True, lineseparator='<br>'))
+                               HtmlFormatter(nowrap=True, lineseparator='<br />'))

             self._write(f'<div class="highlight"><code class="lang-sql">{sqlstr}</code></div>')
         else:
             self._write(f'<code class="lang-sql">{sqlstr}</code>')
             self._write(f'<div class="highlight"><code class="lang-sql">{sqlstr}</code></div>')
         else:
             self._write(f'<code class="lang-sql">{sqlstr}</code>')


@@ -121,6 +128,49 @@ class HTMLLogger(BaseLogger):
         self.buffer.write(text)
 
 
         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())
 
 
 logger: ContextVar[BaseLogger] = ContextVar('logger', default=BaseLogger())