IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Enable automatic formatting for `sphinx/ext/duration.py`

Browse Source
This commit is contained in:
Adam Turner 2024-12-18 20:32:19 +00:00
parent 01d993b359
commit a699f390c5
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.ruff.toml
View File

@ -415,7 +415,6 @@ exclude = [
"sphinx/domains/python/_object.py", "sphinx/domains/python/_object.py",
"sphinx/domains/rst.py", "sphinx/domains/rst.py",
"sphinx/domains/std/__init__.py", "sphinx/domains/std/__init__.py",
"sphinx/ext/duration.py",
"sphinx/ext/extlinks.py", "sphinx/ext/extlinks.py",
"sphinx/ext/githubpages.py", "sphinx/ext/githubpages.py",
"sphinx/ext/graphviz.py", "sphinx/ext/graphviz.py",

13
sphinx/ext/duration.py
View File

@ -23,6 +23,7 @@ if TYPE_CHECKING:
class _DurationDomainData(TypedDict): class _DurationDomainData(TypedDict):
reading_durations: dict[str, float] reading_durations: dict[str, float]
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -44,7 +45,9 @@ class DurationDomain(Domain):
def clear_doc(self, docname: str) -> None: def clear_doc(self, docname: str) -> None:
self.reading_durations.pop(docname, None) self.reading_durations.pop(docname, None)
def merge_domaindata(self, docnames: Set[str], otherdata: _DurationDomainData) -> None: # type: ignore[override] def merge_domaindata( # type: ignore[override]
self, docnames: Set[str], otherdata: _DurationDomainData
) -> None:
other_reading_durations = otherdata.get('reading_durations', {}) other_reading_durations = otherdata.get('reading_durations', {})
docnames_set = frozenset(docnames) docnames_set = frozenset(docnames)
for docname, duration in other_reading_durations.items(): for docname, duration in other_reading_durations.items():
@ -79,10 +82,14 @@ def on_build_finished(app: Sphinx, error: Exception) -> None:
domain = app.env.domains['duration'] domain = app.env.domains['duration']
if not domain.reading_durations: if not domain.reading_durations:
return return
durations = sorted(domain.reading_durations.items(), key=itemgetter(1), reverse=True) durations = sorted(
domain.reading_durations.items(), key=itemgetter(1), reverse=True
)
logger.info('') logger.info('')
logger.info(__('====================== slowest reading durations =======================')) logger.info(
__('====================== slowest reading durations =======================')
)
for docname, d in islice(durations, 5): for docname, d in islice(durations, 5):
logger.info(f'{d:.3f} {docname}') # NoQA: G004 logger.info(f'{d:.3f} {docname}') # NoQA: G004