Skip to content

polish loggers #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdpython merged 1 commit into from
Mar 6, 2026
Merged

polish loggers #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sphinx_runpython/blocdefs/sphinx_blocref_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
from ..language import TITLES
from ..ext_helper import info_blocref

logger = logging.getLogger("blocref")


class blocref_node(nodes.admonition):
"""
Expand Down Expand Up @@ -471,15 +473,13 @@ def process_blocref_nodes_generic(
try:
targ = blocref_info["target"]
except KeyError as e:
logger = logging.getLogger("blocref")
logger.warning(
"Unable to find key 'target' in %r (e=%r)", blocref_info, e
)
continue
try:
targ_refid = blocref_info["target"]["refid"]
except KeyError as e:
logger = logging.getLogger("blocref")
logger.warning("Unable to find key 'refid' in %r (e=%r)", targ, e)
continue
int_ids = [f"index{targ_refid}-{env.new_serialno(targ_refid)}"]
Expand Down
3 changes: 2 additions & 1 deletion sphinx_runpython/collapse/sphinx_collapse_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
from sphinx.util.nodes import nested_parse_with_titles
from ..language import TITLES, sphinx_lang

logger = logging.getLogger("sphinx")


class collapse_node(nodes.admonition):
"""
Expand Down Expand Up @@ -61,7 +63,6 @@ def run(self):
if "legend" in self.options:
legend = self.options["legend"]
if "/" not in legend:
logger = logging.getLogger("sphinx")
logger.warning(
"[CollapseDirective] unable to interpret parameter legend %r.",
legend,
Expand Down
7 changes: 2 additions & 5 deletions sphinx_runpython/docassert/sphinx_docassert_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
from sphinx.util.docfields import DocFieldTransformer, _is_single_paragraph
from ..import_object_helper import import_any_object, import_object

logger = logging.getLogger("docassert")


class Parameter:
"Definition of a parameter."
Expand Down Expand Up @@ -121,7 +123,6 @@ def kg(p):
return p if isinstance(p, str) else p.name

check_params = {kg(p): 0 for p in parameters}
logger = logging.getLogger("docassert")

def check_item(fieldarg, content, logger):
"local function"
Expand Down Expand Up @@ -339,7 +340,6 @@ def override_transform(self, other_self, node):
reasons = "\n".join(f" {e}" for e in excs)
else:
reasons = "unknown"
logger = logging.getLogger("docassert")
logger.warning(
"[docassert] unable to import object %r, reasons: %s", docs, reasons
)
Expand All @@ -353,7 +353,6 @@ def override_transform(self, other_self, node):
parameters = signature.parameters
except (TypeError, ValueError):
# built-in function
logger = logging.getLogger("docassert")
if myfunc.__text_signature__:
logger.warning(
"[docassert] unable to get signature (1) of %r: %s",
Expand Down Expand Up @@ -393,15 +392,13 @@ def override_transform(self, other_self, node):
try:
env = other_self.directive.state.document.settings.env
except AttributeError as e:
logger = logging.getLogger("docassert")
logger.warning("[docassert] %s", e)
env = None

docname = fieldbody.parent.source.split("docstring of")[-1].strip()

for entry in entries:
if isinstance(entry, nodes.field):
logger = logging.getLogger("docassert")
logger.warning("[docassert] unable to check [nodes.field] %s", entry)
else:
fieldtype, content = entry
Expand Down
7 changes: 2 additions & 5 deletions sphinx_runpython/gdot/sphinx_gdot_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
from ..ext_io_helper import download_requirejs, get_url_content_timeout
from ..runpython.sphinx_runpython_extension import run_python_script

logger = logging.getLogger("gdot")


class gdot_node(nodes.admonition):
"""
Expand Down Expand Up @@ -130,7 +132,6 @@ def run(self):
if url == "local":
if docname is None or "HERE" not in info:
url = GDotDirective._default_url
logger = logging.getLogger("gdot")
logger.warning("[gdot] docname is none, falling back to %r.", url)
else:
spl = docname.split("/")
Expand Down Expand Up @@ -196,13 +197,11 @@ def run(self):
)

if stderr:
logger = logging.getLogger("gdot")
logger.warning("[gdot] a dot graph cannot be draw due to %s", stderr)
content = stdout
if script:
spl = content.split(script)
if len(spl) > 2:
logger = logging.getLogger("gdot")
logger.warning("[gdot] too many output lines %s", content)
content = spl[-1]

Expand Down Expand Up @@ -274,7 +273,6 @@ def render_dot_html(
_emit_dummy_output(self, format=format)

if format not in {"png", "svg"}:
logger = logging.getLogger(__name__)
logger.warning(__("format must be either 'png' or 'svg', but is %r"), format)
try:
fname, outfn = render_dot(self, code, options, format, prefix, filename)
Expand Down Expand Up @@ -428,7 +426,6 @@ def depart_gdot_node_html(self, node):


def copy_js_files(app):
logger = logging.getLogger("gdot")
dest = app.config.html_static_path
if isinstance(dest, list) and len(dest) > 0:
dest = dest[0]
Expand Down
3 changes: 2 additions & 1 deletion sphinx_runpython/runpython/sphinx_runpython_extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
from .run_cmd import run_cmd
from ..collapse.sphinx_collapse_extension import collapse_node

logger = logging.getLogger("runpython")


def remove_extra_spaces_and_black(
filename: str, apply_black=True, is_string=None
Expand Down Expand Up @@ -757,7 +759,6 @@ def run(self):
try:
script_disp = remove_extra_spaces_and_black(script_disp, is_string=True)
except Exception as e:
logger = logging.getLogger("runpython")
if "." in docname:
comment = f' File "{docname}", line {lineno}'
else:
Expand Down
Loading