Added xul.utils; removed legacy xul.log.

docs/changelog.rst

@@ -3,7 +3,7 @@ Changelog
 
 This document records all notable changes to `Xul <https://xul.readthedocs.io/>`_.
 
-`Unreleased <https://github.com/peteradrichem/Xul/compare/2.5.1...py3k>`_ (2025-01-18)
+`3.0.0-rc.1 <https://github.com/peteradrichem/Xul/compare/2.5.1...py3k>`_ (2025-01-19)
 --------------------------------------------------------------------------------------
 * Drop support for Python < 3.9.
 * :doc:`xp <xp>`: fix boolean result (Python >= 3.12).
@@ -17,6 +17,7 @@ This document records all notable changes to `Xul <https://xul.readthedocs.io/>`
 * Improved documentation; grouped CLI options.
 * Code checks: ruff, black, isort, mypy (GitHub Action).
 * Test script for local testing with Docker Compose.
+* Removed legacy code.
 * Typing.
 * Updated Sphinx configuration.
 * Output formatting (f-strings).

src/xul/__init__.py

@@ -9,5 +9,5 @@
 """
 
 # Xul version.
-__version_info__ = ("3", "0", "0-beta1")
+__version_info__ = ("3", "0", "0-rc.1")
 __version__ = ".".join(__version_info__)

src/xul/cmd/ppx.py

@@ -6,8 +6,8 @@
 from lxml.etree import XMLParser
 
 from .. import __version__
-from ..log import setup_logger_console
 from ..ppxml import pp_xml
+from ..utils import config_logger
 
 
 def parse_cl() -> argparse.Namespace:
@@ -42,7 +42,7 @@ def parse_cl() -> argparse.Namespace:
 def main() -> None:
     """Entry point for command line script ppx."""
     # Logging to the console.
-    setup_logger_console()
+    config_logger()
 
     # Command line.
     args = parse_cl()

src/xul/cmd/transform.py

@@ -7,8 +7,8 @@
 from lxml import etree
 
 from .. import __version__
-from ..log import setup_logger_console
 from ..ppxml import prettyprint
+from ..utils import config_logger
 from ..xsl import build_xsl_transform, xml_transformer
 
 
@@ -89,7 +89,7 @@ def output_xslt(
 def main():
     """Entry point for command line script transform."""
     # Logging to the console.
-    setup_logger_console()
+    config_logger()
 
     # Command line.
     args = parse_cl()

src/xul/cmd/validate.py

@@ -7,8 +7,7 @@
 from lxml import etree
 
 from .. import __version__
-from ..etree import get_source_name
-from ..log import setup_logger_console
+from ..utils import config_logger, get_source_name
 from ..validate import build_dtd, build_relaxng, build_xml_schema, validate_xml
 
 
@@ -86,7 +85,7 @@ def apply_validator(
 def main() -> None:
     """Entry point for command line script validate."""
     # Logging to the console.
-    setup_logger_console()
+    config_logger()
 
     # Command line.
     args = parse_cl()

src/xul/cmd/xp.py

@@ -7,9 +7,9 @@
 from lxml import etree
 
 from .. import __version__
-from ..etree import build_etree, get_source_name
-from ..log import setup_logger_console
+from ..etree import build_etree
 from ..ppxml import prettyprint
+from ..utils import config_logger, get_source_name
 from ..xpath import build_xpath, etree_xpath, namespaces
 
 
@@ -460,7 +460,7 @@ def xpath_on_xml(
 def main() -> None:
     """Entry point for command line script xp."""
     # Logging to the console.
-    setup_logger_console()
+    config_logger()
 
     # Command line.
     args = parse_cl()

src/xul/etree.py

@@ -11,26 +11,14 @@
     https://lxml.de/tutorial.html
 """
 
-import io
 from logging import getLogger
 from typing import Optional, TextIO, Union
 
 from lxml import etree
 
-logger = getLogger(__name__)
-
+from .utils import get_source_name
 
-def get_source_name(xml_source: Union[TextIO, str]) -> str:
-    """Return the name of XML source."""
-    if isinstance(xml_source, str):
-        return xml_source
-    if isinstance(xml_source, io.TextIOWrapper):
-        # e.g. sys.stdin
-        return xml_source.name
-    if isinstance(xml_source, io.StringIO):
-        return "StringIO"
-    # ?
-    return str(xml_source)
+logger = getLogger(__name__)
 
 
 def build_etree(

src/xul/utils.py

@@ -0,0 +1,36 @@
+"""Xul utilities."""
+
+import io
+import logging
+from typing import TextIO, Union
+
+
+def config_logger(log_level: int = logging.INFO) -> None:
+    """Configure the root logger and add console handler.
+
+    log_level -- console log level [default 'info']
+
+    Console logging (sys.stderr) for the command line scripts.
+    """
+    # Configure threshold log level for the root logger.
+    logging.getLogger("").setLevel(logging.DEBUG)
+
+    # Configure console handler (StreamHandler).
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(log_level)
+
+    # Attach the console handler to the root logger.
+    logging.getLogger("").addHandler(console_handler)
+
+
+def get_source_name(xml_source: Union[TextIO, str]) -> str:
+    """Return the name of XML source."""
+    if isinstance(xml_source, str):
+        return xml_source
+    if isinstance(xml_source, io.TextIOWrapper):
+        # e.g. sys.stdin
+        return xml_source.name
+    if isinstance(xml_source, io.StringIO):
+        return "StringIO"
+    # ?
+    return str(xml_source)