Fix #55: Improved Logging (#83)

* fix#55: updated logging

Signed-off-by: sushant-suse <[email protected]>

* fix#55: worked on the NameError and AttributeError issues

Signed-off-by: sushant-suse <[email protected]>

* fix#55: worked on the NameError and AttributeError issues

Signed-off-by: sushant-suse <[email protected]>

* fix#55: worked on the NameError and AttributeError issues

Signed-off-by: sushant-suse <[email protected]>

* fix#55: renamed the changelog file with correct PR number

Signed-off-by: sushant-suse <[email protected]>

* fix#55: modified as per Toms suggestions

Signed-off-by: sushant-suse <[email protected]>

---------

Signed-off-by: sushant-suse <[email protected]>

Author: sushant-suse

changelog.d/83.bugfix.rst

@@ -0,0 +1 @@
+Fixed a bug where `INFO` and `DEBUG` level logs were not written to the log file. The logging system is now non-blocking and fully configurable via `pyproject.toml`.

src/docbuild/cli/callback.py

@@ -6,7 +6,6 @@
 from ..models.doctype import Doctype
 from ..utils.merge import merge_doctypes
 
-#
 log = logging.getLogger(__name__)
 
 

src/docbuild/cli/cmd_cli.py

@@ -2,8 +2,12 @@
 
 from pathlib import Path
 import sys
-
+import logging
 import click
+import rich.console
+import rich.logging
+from rich.pretty import install
+from rich.traceback import install as install_traceback
 
 from ..__about__ import __version__
 from ..config.app import replace_placeholders
@@ -29,6 +33,14 @@
 PYTHON_VERSION = (
     f'{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}'
 )
+# Global instance of Rich Console
+CONSOLE = rich.console.Console(stderr=True, highlight=False)
+
+def _setup_console() -> None:
+    """Configures the rich console."""
+    install_traceback(console=CONSOLE, show_locals=True)
+    # The Rich console is now handled by the logging setup.
+    # install(console=CONSOLE)
 
 @click.group(
     name=APP_NAME,
@@ -38,7 +50,6 @@
 )
 @click.version_option(
     __version__,
-    # package_name=__package__,
     prog_name=APP_NAME,
     message=f"%(prog)s, version %(version)s running Python {PYTHON_VERSION}",
 )
@@ -97,7 +108,6 @@ def cli(
     :param env_config: Filename to a environment's TOML config file.
     :param kwargs: Additional keyword arguments.
     """
-    setup_logging(cliverbosity=verbose)
 
     if ctx.invoked_subcommand is None:
         # If no subcommand is invoked, show the help message
@@ -127,6 +137,10 @@ def cli(
     )
     context.appconfig = replace_placeholders(context.appconfig)
 
+    # Phase 2: Advanced logging setup with user configuration.
+    logging_config = context.appconfig.get('logging', {})
+    setup_logging(cliverbosity=verbose, user_config={'logging': logging_config})
+
     (
         context.envconfigfiles,
         context.envconfig,
@@ -149,4 +163,4 @@ def cli(
 cli.add_command(config)
 cli.add_command(repo)
 cli.add_command(metadata)
-cli.add_command(validate)
+cli.add_command(validate)

src/docbuild/cli/cmd_repo/cmd_clone.py

@@ -14,11 +14,12 @@
 import click
 
 from ...cli.context import DocBuildContext
-from ...logging import GITLOGGERNAME
 from .process import process
+from ...constants import GITLOGGER_NAME
 
-log = logging.getLogger(GITLOGGERNAME)
+log = logging.getLogger(__name__)
 
+git_logger = logging.getLogger(GITLOGGER_NAME)
 
 @click.command(help=__doc__)
 @click.argument(

src/docbuild/cli/cmd_repo/process.py

@@ -6,11 +6,11 @@
 
 from ...cli.context import DocBuildContext
 from ...config.xml.stitch import create_stitchfile
-from ...logging import GITLOGGERNAME
 from ...models.repo import Repo
 from ...utils.contextmgr import make_timer
+from ...constants import GITLOGGER_NAME
 
-log = logging.getLogger(GITLOGGERNAME)
+log = logging.getLogger(GITLOGGER_NAME)
 
 
 async def clone_repo(repo: Repo, base_dir: Path) -> bool:
@@ -127,4 +127,4 @@ async def process(context: DocBuildContext, repos: tuple[str, ...]) -> int:
     # Return 0 for success (all clones succeeded), 1 for failure.
     if all(results):
         return 0
-    return 1
+    return 1

src/docbuild/constants.py

@@ -139,6 +139,9 @@
 used in production."""
 
 # --- Logging constants ---
+GITLOGGER_NAME = "docbuild.git"
+"""The standardized name for the Git-related logger."""
+
 BASE_LOG_DIR = Path.home() / '.local' / 'state' / APP_NAME / 'logs'
 """The directory where log files will be stored, typically at
 :file:`~/.local/state/docbuild/logs` as recommended by the XDG Base