perf: combined import-time optimizations (E2E reference)#10
Closed
perf: combined import-time optimizations (E2E reference)#10
Conversation
…rt time Move the module-level `from .traceback import Traceback` to a lazy import inside `emit()`, guarded by the `rich_tracebacks` check. This avoids loading the traceback -> syntax -> pygments chain (~20ms) when RichHandler is used without rich tracebacks enabled (the default). The Traceback type annotation in `render()` is changed to a string literal for forward-reference compatibility.
Replace `import inspect` + `from inspect import isclass` with: - `isinstance(obj, type)` for isclass (identical behavior) - `sys._getframe` for inspect.currentframe (same underlying call) - Lazy `from inspect import stack` in the fallback path only inspect pulls in dis, tokenize, ast, and annotationlib (~10ms). This eliminates that cost from Console's import path entirely.
`getLogger("rich")` was imported and assigned to `log` but never used
anywhere in segment.py. Removing it avoids importing the `logging`
module (and its transitive chain: traceback, linecache, tokenize)
on the Console import path.
Move `from .pretty import Pretty, is_expandable` from module level to inside the `_collect_renderables()` method (called by `print()`). rich.pretty pulls in dataclasses, reprlib, array, and tries `import attr` — none of which are needed until something is actually printed.
Move `from .scope import render_scope` from module level to inside the `log()` method, gated behind the `log_locals` check. rich.scope pulls in rich.table, rich.panel, and fractions — none of which are needed unless log_locals=True is explicitly requested.
Move `from getpass import getpass` from module level to inside the `input()` method, only when password=True. The getpass module imports contextlib and termios which are unnecessary for normal Console usage.
Move `import configparser` from module level to inside from_file(). configparser is only needed when loading themes from .ini files, not during normal Console/Theme construction.
Replace `from pathlib import Path` + `Path(x).name` with `os.path.basename(x)`. os is already imported transitively and available at near-zero cost, while pathlib adds ~4-5ms to the RichHandler import path. This is also a minor runtime improvement: os.path.basename is a simple string operation vs Path object construction + attribute access.
Move `from html import escape` and `import zlib` from module level to inside export_html() and export_svg() respectively. These modules are only needed for HTML/SVG export operations, not for normal Console usage.
Run `python benchmarks/bench_import.py` to measure RichHandler import time and see the Console-to-RichHandler gap that this PR reduces.
Replace two separate hyperfine invocations with a single parameterized run using -L branch. This produces a proper relative comparison with statistical significance in one invocation. Also adds a Console baseline measurement to show the optimization only affects the traceback import chain, not the common path.
Add `from __future__ import annotations` and move Console, ConsoleRenderable, Highlighter, FormatTimeCallable, and Traceback to TYPE_CHECKING blocks. These are all annotation-only — none are used at runtime. This avoids importing rich.console (~8ms) entirely when importing RichHandler, since _log_render, text, and highlighter don't import console at module level either.
_svg_hash has been unused since the SVG export rewrite in 113997a (May 2022). The only caller (classes_prefix namespacing) was removed but the function definition was left behind. Removing it also fixes a latent NameError since zlib was deferred to export_svg() in the previous commit.
- syntax.py: move Console, ConsoleOptions, JustifyMethod, RenderResult to TYPE_CHECKING (already has future annotations). Eliminates rich.console from syntax's import chain entirely. - protocol.py: replace `from inspect import isclass` with `isinstance(x, type)` — identical behavior, no import needed. - repr.py: defer `import inspect` into auto_rich_repr() where inspect.signature() is actually used. None of these save time yet (inspect still comes in via dataclasses), but they become free wins once dataclasses is removed from console.py.
Owner
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
E2E Results
from rich.console import Consolefrom rich.logging import RichHandlerimport richPer-module breakdown (optimized)
import richConsoleRichHandlerSyntaxTracebackMarkdownSummary
This branch stacks all import-time optimizations for E2E benchmarking. Not intended for merge — each change has its own PR for independent review:
import inspectfrom console.pyloggingimport from segment.pyprettytoConsole.print()scopetoConsole.log()getpasstoConsole.input()configparsertoTheme.from_file()pathlibwithos.path.basenamein logging.pyhtml.escapeandzlibto export methodsfrom __future__ import annotations+ TYPE_CHECKING in logging.py_svg_hashfunction (fixes latent NameError)inspect.isclasswithisinstance(x, type)in protocol.pyimport inspectin repr.pyBenchmarks
Environment: Standard_D2s_v5 (non-burstable), CPython 3.13.13, hyperfine --min-runs 30
Testing
952 passed, 25 skipped. Verified with
make typecheck(mypy) andmake format-check(black).Disclosure
Developed with AI assistance (codeflash-agent). Benchmarked in a controlled environment (dedicated non-burstable Azure VM). All tests verified across multiple Python implementations.