Skip to content

Commit

Permalink
Rename logger to LOGGER
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Apr 25, 2024
1 parent 9629522 commit 13b6700
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
19 changes: 9 additions & 10 deletions sphinx/ext/intersphinx/_load.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
from urllib.parse import urlsplit, urlunsplit

from sphinx.builders.html import INVENTORY_FILENAME
from sphinx.ext.intersphinx._shared import LOGGER as logger
from sphinx.ext.intersphinx._shared import InventoryAdapter
from sphinx.ext.intersphinx._shared import LOGGER, InventoryAdapter
from sphinx.locale import __
from sphinx.util import requests
from sphinx.util.inventory import InventoryFile
Expand Down Expand Up @@ -119,7 +118,7 @@ def fetch_inventory(app: Sphinx, uri: str, inv: str) -> Inventory:
if hasattr(f, 'url'):
newinv = f.url
if inv != newinv:
logger.info(__('intersphinx inventory has moved: %s -> %s'), inv, newinv)
LOGGER.info(__('intersphinx inventory has moved: %s -> %s'), inv, newinv)

if uri in (inv, path.dirname(inv), path.dirname(inv) + '/'):
uri = path.dirname(newinv)
Expand Down Expand Up @@ -154,7 +153,7 @@ def fetch_inventory_group(
# files; remote ones only if the cache time is expired
if '://' not in inv or uri not in cache or cache[uri][1] < cache_time:
safe_inv_url = _get_safe_url(inv)
logger.info(__('loading intersphinx inventory from %s...'), safe_inv_url)
LOGGER.info(__('loading intersphinx inventory from %s...'), safe_inv_url)
try:
invdata = fetch_inventory(app, uri, inv)
except Exception as err:
Expand All @@ -168,13 +167,13 @@ def fetch_inventory_group(
if failures == []:
pass
elif len(failures) < len(invs):
logger.info(__("encountered some issues with some of the inventories,"
LOGGER.info(__("encountered some issues with some of the inventories,"
" but they had working alternatives:"))
for fail in failures:
logger.info(*fail)
LOGGER.info(*fail)
else:
issues = '\n'.join(f[0] % f[1:] for f in failures)
logger.warning(__("failed to reach any of the inventories "
LOGGER.warning(__("failed to reach any of the inventories "
"with the following issues:") + "\n" + issues)


Expand Down Expand Up @@ -226,7 +225,7 @@ def normalize_intersphinx_mapping(app: Sphinx, config: Config) -> None:
# new format
name, (uri, inv) = key, value
if not isinstance(name, str):
logger.warning(__('intersphinx identifier %r is not string. Ignored'),
LOGGER.warning(__('intersphinx identifier %r is not string. Ignored'),
name)
config.intersphinx_mapping.pop(key)
continue
Expand All @@ -241,12 +240,12 @@ def normalize_intersphinx_mapping(app: Sphinx, config: Config) -> None:
f"Hint: \"intersphinx_mapping = {{'<name>': {(uri, inv)!r}}}\"."
"https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping" # NoQA: E501
)
logger.warning(msg)
LOGGER.warning(msg)

if not isinstance(inv, tuple):
config.intersphinx_mapping[key] = (name, (uri, (inv,)))
else:
config.intersphinx_mapping[key] = (name, (uri, inv))
except Exception as exc:
logger.warning(__('Failed to read intersphinx_mapping[%s], ignored: %r'), key, exc)
LOGGER.warning(__('Failed to read intersphinx_mapping[%s], ignored: %r'), key, exc)
config.intersphinx_mapping.pop(key)
7 changes: 3 additions & 4 deletions sphinx/ext/intersphinx/_resolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
from sphinx.addnodes import pending_xref
from sphinx.deprecation import _deprecation_warning
from sphinx.errors import ExtensionError
from sphinx.ext.intersphinx._shared import LOGGER as logger
from sphinx.ext.intersphinx._shared import InventoryAdapter
from sphinx.ext.intersphinx._shared import LOGGER, InventoryAdapter
from sphinx.locale import _, __
from sphinx.transforms.post_transforms import ReferencesResolver
from sphinx.util.docutils import CustomReSTDispatcher, SphinxRole
Expand Down Expand Up @@ -403,7 +402,7 @@ def _get_domain_role(self, name: str) -> tuple[str | None, str | None]:
return None, None

def _emit_warning(self, msg: str, /, *args: Any) -> None:
logger.warning(
LOGGER.warning(
msg,
*args,
type='intersphinx',
Expand Down Expand Up @@ -489,7 +488,7 @@ def run(self, **kwargs: Any) -> None:
typ = node['reftype']
msg = (__('external %s:%s reference target not found: %s') %
(node['refdomain'], typ, node['reftarget']))
logger.warning(msg, location=node, type='ref', subtype=typ)
LOGGER.warning(msg, location=node, type='ref', subtype=typ)
node.replace_self(contnode)
else:
node.replace_self(newnode)
Expand Down

0 comments on commit 13b6700

Please sign in to comment.