Skip to content

Fix TypeError when version is shadowed by import in conf.py #14641

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

Draft
aryansk wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix TypeError when version is shadowed by import in conf.py #14641

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
21 changes: 19 additions & 2 deletions sphinx/util/inventory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,15 +176,32 @@
cls, filename: str | os.PathLike[str], env: BuildEnvironment, builder: Builder
) -> None:
def escape(string: str) -> str:
if not isinstance(string, str):
string = str(string) if string is not None else ''
return re.sub('\\s+', ' ', string)

# ``version`` can be shadowed in conf.py (e.g. ``from importlib.metadata import version``)

Check failure on line 183 in sphinx/util/inventory.py

View workflow job for this annotation

GitHub Actions / ruff

Ruff (E501) 

sphinx/util/inventory.py:183:96: E501 Line too long (98 > 95)
# which replaces the expected string config value with a function. Fall back to
# ``release`` when ``version`` is not a string, otherwise to an empty string.
version = env.config.version
if not isinstance(version, str):
release = env.config.release
if isinstance(release, str):
version = release
else:
version = ''

project = env.config.project
if not isinstance(project, str):
project = str(project) if project is not None else ''

with open(filename, 'wb') as f:
# header
f.write(
(
'# Sphinx inventory version 2\n'
f'# Project: {escape(env.config.project)}\n'
f'# Version: {escape(env.config.version)}\n'
f'# Project: {escape(project)}\n'
f'# Version: {escape(version)}\n'
'# The remainder of this file is compressed using zlib.\n'
).encode()
)
Expand Down
Loading