Use antsibull-core's logging compatibility layer.

felixfontein · felixfontein · commit c3233158027d · 2025-10-28T22:03:29.000+01:00
diff --git a/.github/workflows/antsibull-docs.yml b/.github/workflows/antsibull-docs.yml
@@ -33,7 +33,7 @@ jobs:
           - '3.14'
         antsibull_core_ref:
           - main
-          - '3.4.0'
+          - '3.5.0'
         antsibull_docs_parser_ref:
           - main
         antsibull_changelog_ref:
diff --git a/changelogs/fragments/414-logging.yml b/changelogs/fragments/414-logging.yml
@@ -0,0 +1,4 @@
+minor_changes:
+  - "Uses new logging framework provided by antsibull-core. This currently has no user-observable impact, but that will change with later versions of antsibull-core
+     (https://github.com/ansible-community/antsibull-docs/pull/414)."
+  - "antsibull-docs now depends on antsibull-core 3.5.0+ (https://github.com/ansible-community/antsibull-docs/pull/414)."
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,7 @@ requires-python = ">=3.9"
 dependencies = [
     "ansible-pygments",
     "antsibull-changelog >= 0.24.0",
-    "antsibull-core >= 3.4.0, < 4.0.0",
+    "antsibull-core >= 3.5.0, < 4.0.0",
     "antsibull-docs-parser >= 1.1.0, < 2.0.0",
     "antsibull-docutils >= 1.3.0, < 2.0.0",
     "antsibull-fileutils >= 1.3.0, < 2.0.0",
diff --git a/src/antsibull_docs/ansible_output/load.py b/src/antsibull_docs/ansible_output/load.py
@@ -13,7 +13,7 @@
 from pathlib import Path
 
 import pydantic
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.pydantic import get_formatted_error_messages
 from antsibull_docutils.rst_code_finder import (
     CodeBlockInfo,
@@ -40,7 +40,7 @@
 
 from ..schemas.collection_config import AnsibleOutputConfig, CollectionConfig
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 @dataclass
diff --git a/src/antsibull_docs/ansible_output/process.py b/src/antsibull_docs/ansible_output/process.py
@@ -13,7 +13,7 @@
 from pathlib import Path
 
 import jinja2
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_docutils.rst_code_finder import (
     CodeBlockInfo,
 )
@@ -31,7 +31,7 @@
 
 from .load import Block, Error
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def _get_variable_value(
diff --git a/src/antsibull_docs/ansible_output/replace.py b/src/antsibull_docs/ansible_output/replace.py
@@ -12,15 +12,15 @@
 import typing as t
 from pathlib import Path
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_docutils.rst_code_finder import (
     CodeBlockInfo,
 )
 
 from .load import Error
 from .process import Replacement
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 _COLORS = {
diff --git a/src/antsibull_docs/cli/antsibull_docs.py b/src/antsibull_docs/cli/antsibull_docs.py
@@ -27,8 +27,11 @@
 except ImportError:
     HAS_ARGCOMPLETE = False
 
-import twiggy  # type: ignore[import]
-from antsibull_core.logging import initialize_app_logging, log
+from antsibull_core.logging import (
+    configure_logger,
+    get_module_logger,
+    initialize_app_logging,
+)
 
 initialize_app_logging()
 
@@ -58,7 +61,7 @@
 # pylint: enable=wrong-import-position
 
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def _create_loader(module: str, function: str) -> Callable[[], Callable[[], int]]:
@@ -949,7 +952,7 @@ def run(args: list[str]) -> int:
         args=parsed_args, cfg=cfg, app_context_model=DocsAppContext
     )
     with app_context.app_and_lib_context(context_data) as (app_ctx, dummy_):
-        twiggy.dict_config(app_ctx.logging_cfg.model_dump())
+        configure_logger(app_ctx)
         flog.debug("Set logging config")
 
         flog.fields(command=parsed_args.command).info("Action")
diff --git a/src/antsibull_docs/cli/doc_commands/_build.py b/src/antsibull_docs/cli/doc_commands/_build.py
@@ -14,7 +14,7 @@
 import typing as t
 from collections.abc import Mapping, MutableMapping
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.schemas.collection_meta import (
     CollectionMetadata,
     CollectionsMetadata,
@@ -74,7 +74,7 @@
 from ...write_docs.plugin_stubs import output_all_plugin_stub_rst
 from ...write_docs.plugins import output_all_plugin_rst
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def _remove_collections_from_mapping(
diff --git a/src/antsibull_docs/cli/doc_commands/ansible_output.py b/src/antsibull_docs/cli/doc_commands/ansible_output.py
@@ -13,7 +13,7 @@
 from pathlib import Path
 
 import pydantic
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.pydantic import get_formatted_error_messages
 from antsibull_fileutils.yaml import load_yaml_file
 
@@ -37,7 +37,7 @@
 from ...schemas.collection_config import AnsibleOutputConfig
 from ...utils.collection_copier import CollectionCopier
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def find_blocks_in_file(
diff --git a/src/antsibull_docs/cli/doc_commands/collection.py b/src/antsibull_docs/cli/doc_commands/collection.py
@@ -16,15 +16,15 @@
 import asyncio_pool  # type: ignore[import]
 from antsibull_core.collections import install_together
 from antsibull_core.galaxy import CollectionDownloader, GalaxyContext
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.venv import FakeVenvRunner
 from antsibull_fileutils.tempfile import AnsibleTemporaryDirectory
 
 from ... import app_context
 from ...jinja2.environment import OutputFormat
 from ._build import generate_docs_for_all_collections
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def generate_collection_docs(
diff --git a/src/antsibull_docs/cli/doc_commands/collection_plugins.py b/src/antsibull_docs/cli/doc_commands/collection_plugins.py
@@ -12,7 +12,7 @@
 import os.path
 
 from antsibull_core.collections import install_together
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.venv import FakeVenvRunner
 from antsibull_fileutils.tempfile import AnsibleTemporaryDirectory
 
@@ -21,7 +21,7 @@
 from ._build import generate_docs_for_all_collections
 from .collection import retrieve
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def generate_collection_plugins_docs(
diff --git a/src/antsibull_docs/cli/doc_commands/current.py b/src/antsibull_docs/cli/doc_commands/current.py
@@ -7,14 +7,14 @@
 
 from __future__ import annotations
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.venv import FakeVenvRunner
 
 from ... import app_context
 from ...jinja2.environment import OutputFormat
 from ._build import generate_docs_for_all_collections
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def generate_docs() -> int:
diff --git a/src/antsibull_docs/cli/doc_commands/devel.py b/src/antsibull_docs/cli/doc_commands/devel.py
@@ -17,7 +17,7 @@
 from antsibull_core.collections import install_together
 from antsibull_core.dependency_files import parse_pieces_file
 from antsibull_core.galaxy import CollectionDownloader, DownloadResults, GalaxyContext
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.schemas.collection_meta import CollectionsMetadata
 from antsibull_core.venv import FakeVenvRunner, VenvRunner
 from antsibull_fileutils.tempfile import AnsibleTemporaryDirectory
@@ -27,7 +27,7 @@
 from ...jinja2.environment import OutputFormat
 from ._build import generate_docs_for_all_collections
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 async def retrieve(
diff --git a/src/antsibull_docs/cli/doc_commands/lint_docs.py b/src/antsibull_docs/cli/doc_commands/lint_docs.py
@@ -10,7 +10,7 @@
 import os
 import textwrap
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 
 from ... import app_context
 from ...collection_config import lint_collection_config
@@ -33,7 +33,7 @@
     collect_names,
 )
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def lint_collection_docs() -> int:
diff --git a/src/antsibull_docs/cli/doc_commands/plugin.py b/src/antsibull_docs/cli/doc_commands/plugin.py
@@ -13,7 +13,7 @@
 import sys
 import traceback
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.subprocess_util import CalledProcessError
 from antsibull_core.vendored.json_utils import _filter_non_json_lines
 from antsibull_core.venv import FakeVenvRunner
@@ -34,7 +34,7 @@
 from ...write_docs.io import Output
 from ...write_docs.plugins import write_plugin_rst
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def generate_plugin_docs(
diff --git a/src/antsibull_docs/cli/doc_commands/sphinx_init.py b/src/antsibull_docs/cli/doc_commands/sphinx_init.py
@@ -12,15 +12,15 @@
 import sys
 import typing as t
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 
 import antsibull_docs
 
 from ... import app_context
 from ...jinja2.environment import doc_environment
 from ...utils.text import sanitize_whitespace
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 RST_INDEX_RST = "rst/index.rst"
diff --git a/src/antsibull_docs/cli/doc_commands/stable.py b/src/antsibull_docs/cli/doc_commands/stable.py
@@ -18,7 +18,7 @@
 from antsibull_core.collections import install_together
 from antsibull_core.dependency_files import DepsFile
 from antsibull_core.galaxy import CollectionDownloader, GalaxyContext
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.schemas.collection_meta import CollectionsMetadata
 from antsibull_core.venv import FakeVenvRunner, VenvRunner
 from antsibull_fileutils.tempfile import AnsibleTemporaryDirectory
@@ -28,7 +28,7 @@
 from ...jinja2.environment import OutputFormat
 from ._build import generate_docs_for_all_collections
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 async def retrieve(
diff --git a/src/antsibull_docs/collection_config.py b/src/antsibull_docs/collection_config.py
@@ -14,13 +14,13 @@
 import asyncio_pool  # type: ignore[import]
 import pydantic as p
 from antsibull_core import app_context
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.pydantic import forbid_extras, get_formatted_error_messages
 from antsibull_fileutils.yaml import load_yaml_file
 
 from .schemas.collection_config import CollectionConfig
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 _ANSIBLE_CORE_CONFIG: dict[str, t.Any] = {}
diff --git a/src/antsibull_docs/collection_links.py b/src/antsibull_docs/collection_links.py
@@ -15,7 +15,7 @@
 import asyncio_pool  # type: ignore[import]
 import pydantic as p
 from antsibull_core import app_context
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.pydantic import forbid_extras, get_formatted_error_messages
 from antsibull_fileutils.yaml import load_yaml_file
 
@@ -29,7 +29,7 @@
     MatrixRoom,
 )
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 _ANSIBLE_CORE_METADATA = {
diff --git a/src/antsibull_docs/docs_parsing/ansible_doc.py b/src/antsibull_docs/docs_parsing/ansible_doc.py
@@ -15,7 +15,7 @@
 import typing as t
 from collections.abc import Mapping
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.subprocess_util import CalledProcessError
 from antsibull_core.vendored.json_utils import _filter_non_json_lines
 from packaging.version import Version as PypiVer
@@ -27,7 +27,7 @@
     from antsibull_core.venv import FakeVenvRunner, VenvRunner
 
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 def _extract_ansible_builtin_metadata(stdout: str) -> AnsibleCollectionMetadata:
diff --git a/src/antsibull_docs/docs_parsing/ansible_doc_core_213.py b/src/antsibull_docs/docs_parsing/ansible_doc_core_213.py
@@ -14,7 +14,7 @@
 from collections.abc import Mapping, MutableMapping
 
 import semantic_version as semver
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_core.subprocess_util import CalledProcessError
 from antsibull_core.vendored.json_utils import _filter_non_json_lines
 from packaging.version import Version as PypiVer
@@ -28,7 +28,7 @@
     from antsibull_core.venv import FakeVenvRunner, VenvRunner
 
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 async def _call_ansible_doc(
diff --git a/src/antsibull_docs/docs_parsing/parsing.py b/src/antsibull_docs/docs_parsing/parsing.py
@@ -10,7 +10,7 @@
 import typing as t
 from collections.abc import Mapping, MutableMapping
 
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from packaging.version import Version as PypiVer
 
 from .. import app_context
@@ -24,7 +24,7 @@
     from antsibull_core.venv import FakeVenvRunner, VenvRunner
 
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 
 async def get_ansible_plugin_info(
diff --git a/src/antsibull_docs/extra_docs.py b/src/antsibull_docs/extra_docs.py
@@ -16,11 +16,11 @@
 
 import asyncio_pool  # type: ignore[import]
 from antsibull_core import app_context
-from antsibull_core.logging import log
+from antsibull_core.logging import get_module_logger
 from antsibull_fileutils.io import read_file
 from antsibull_fileutils.yaml import load_yaml_file
 
-mlog = log.fields(mod=__name__)
+mlog = get_module_logger(__name__)
 
 _RST_LABEL_DEFINITION = re.compile(r"""^\.\. _([^:]+):""")
 
diff --git a/src/antsibull_docs/jinja2/filters.py b/src/antsibull_docs/jinja2/filters.py
diff --git a/src/antsibull_docs/process_docs.py b/src/antsibull_docs/process_docs.py
diff --git a/src/antsibull_docs/write_docs/__init__.py b/src/antsibull_docs/write_docs/__init__.py
diff --git a/src/antsibull_docs/write_docs/changelog.py b/src/antsibull_docs/write_docs/changelog.py
diff --git a/src/antsibull_docs/write_docs/collections.py b/src/antsibull_docs/write_docs/collections.py
diff --git a/src/antsibull_docs/write_docs/hierarchy.py b/src/antsibull_docs/write_docs/hierarchy.py
diff --git a/src/antsibull_docs/write_docs/indexes.py b/src/antsibull_docs/write_docs/indexes.py
diff --git a/src/antsibull_docs/write_docs/io.py b/src/antsibull_docs/write_docs/io.py
diff --git a/src/antsibull_docs/write_docs/plugin_stubs.py b/src/antsibull_docs/write_docs/plugin_stubs.py
diff --git a/src/antsibull_docs/write_docs/plugins.py b/src/antsibull_docs/write_docs/plugins.py
