Adding logging (#5)

Author: djpugh

pyproject.toml

@@ -194,10 +194,10 @@ import-order-style="appnexus"
 profile = "appnexus"
 src_paths = ['src/']
 known_first_party = [
-    "mkdocs_licenseinfo.*"
+    "mkdocs_licenseinfo.*",
 ]
 
-known_application = 'mkdocs_licenseinfo.*'
+known_application = 'mkdocs_licenseinfo*'
 force_alphabetical_sort_within_sections = true
 force_sort_within_sections = true
 reverse_relative = true

src/mkdocs_licenseinfo/__init__.py

@@ -2,6 +2,10 @@
 
 mkdocs extension to visualise package dependencies license information.
 """
+from __future__ import annotations
+
+import logging
+from typing import Any, MutableMapping
 
 
 def __get_version() -> str:
@@ -45,3 +49,32 @@ def __get_version() -> str:
 
 
 __version__ = __get_version()
+
+
+class _PluginLogger(logging.LoggerAdapter):
+    """A logger adapter to prefix messages with the originating package name."""
+
+    def __init__(self, prefix: str, logger: logging.Logger):
+        """Initialize the object.
+
+        Arguments:
+            prefix: The string to insert in front of every message.
+            logger: The logger instance.
+        """
+        super().__init__(logger, {})
+        self.prefix = prefix
+
+    def process(self, msg: str, kwargs: MutableMapping[str, Any]) -> tuple[str, Any]:
+        """Process the message.
+
+        Arguments:
+            msg: The message:
+            kwargs: Remaining arguments.
+
+        Returns:
+            The processed message.
+        """
+        return f"{self.prefix}: {msg}", kwargs
+
+
+logger = _PluginLogger('mkdocs_licenseinfo', logging.getLogger("mkdocs.plugins.mkdocs_licenseinfo"))

src/mkdocs_licenseinfo/extension.py

@@ -42,6 +42,7 @@
 from markdown.extensions import Extension
 from mkdocs.utils.yaml import get_yaml_loader, yaml_load
 
+from mkdocs_licenseinfo import logger
 from mkdocs_licenseinfo.render_markdown import get_licenses_as_markdown
 
 if TYPE_CHECKING:
@@ -65,6 +66,7 @@ def __init__(
 
     def test(self, parent: Element, block: str) -> bool:  # noqa: U100
         """Match the extension instructions."""
+        logger.debug(f'Checking block: {block}')
         return bool(self.regex.search(block))
 
     def run(self, parent: Element, blocks: MutableSequence[str]) -> None:

src/mkdocs_licenseinfo/get_licenses.py

@@ -10,6 +10,8 @@
 
 import licensecheck
 
+from mkdocs_licenseinfo import logger
+
 
 class UnclosableIO(StringIO):
     """StringIO object that cannot be closed."""
@@ -145,6 +147,7 @@ def get_licenses(
         output=output,
         path=path
     ):
+        logger.info(f'Getting licenses for: {using} in path: {path}')
         licensecheck.cli()
     result = json.loads(output.getvalue())
     output.force_close()

src/mkdocs_licenseinfo/render_markdown.py

@@ -13,6 +13,7 @@
 
 from jinja2 import Environment
 
+from mkdocs_licenseinfo import logger
 from mkdocs_licenseinfo.get_licenses import get_licenses
 
 PACKAGE_TEMPLATE = "# [{{package.name}}]({{package.homePage}})\n{% for license in package.licenses %}``{{license}}`` {% endfor %} \n*Version Checked: {{package.version}}*  \nAuthor: {{package.author}}"
@@ -77,12 +78,19 @@ def get_licenses_as_markdown(
 ):
     """Get the licenses and render them as markdown strings."""
     jinja_environment = JINJA_ENVIRONMENT_FACTORY.environment
+    logger.debug('Getting licenses')
     packages = get_licenses(using, ignore_packages, fail_packages, skip_packages, ignore_licenses, fail_licenses, path=path)
+    logger.info(f'Found {len(packages)} packages')
+
     diff_packages = []
     if diff:
+        logger.debug('Getting diff licenses')
         diff_packages = get_licenses(diff, ignore_packages, fail_packages, skip_packages, ignore_licenses, fail_licenses, path=path)
+        logger.info(f'Found {len(diff_packages)} diff packages')
     selected_package_names = list({u['name'] for u in packages} - {u['name'] for u in diff_packages})
     selected_packages = [u for u in packages if u['name'] in selected_package_names]
+    logger.info(f'Processing remaining {len(selected_packages)} packages')
     if package_template is None:
         package_template = PACKAGE_TEMPLATE
+    logger.debug('Rendering licenses')
     return [jinja_environment.from_string(package_template).render(package=package) for package in selected_packages]

tests/unit/test_get_licenses.py

@@ -7,7 +7,6 @@
 import licensecheck
 
 from mkdocs_licenseinfo import get_licenses as gl_module
-
 from mkdocs_licenseinfo.get_licenses import (
     _split_licenses,
     get_licenses,

tests/unit/test_processor.py

@@ -7,7 +7,6 @@
 from nskit.common.contextmanagers import Env
 
 from mkdocs_licenseinfo import extension
-
 from mkdocs_licenseinfo.extension import LicenseInfoProcessor
 
 

tests/unit/test_render_markdown.py

@@ -8,7 +8,6 @@
 from nskit.common.contextmanagers import Env, TestExtension
 
 from mkdocs_licenseinfo import get_licenses
-
 from mkdocs_licenseinfo.render_markdown import (
     _EnvironmentFactory,
     get_licenses_as_markdown,