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

Use `_StrPath in sphinx.config`

Browse Source
This commit is contained in:
Adam Turner 2024-10-26 00:07:13 +01:00
parent 5cf3e6bf9a
commit e7fa2420b6
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
sphinx/config.py
View File

@ -7,14 +7,14 @@ import traceback
import types import types
import warnings import warnings
from contextlib import chdir from contextlib import chdir
from os import getenv, path from os import getenv
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, NamedTuple from typing import TYPE_CHECKING, Any, Literal, NamedTuple
from sphinx.deprecation import RemovedInSphinx90Warning from sphinx.deprecation import RemovedInSphinx90Warning
from sphinx.errors import ConfigError, ExtensionError from sphinx.errors import ConfigError, ExtensionError
from sphinx.locale import _, __ from sphinx.locale import _, __
from sphinx.util import logging from sphinx.util import logging
from sphinx.util.osutil import fs_encoding
if TYPE_CHECKING: if TYPE_CHECKING:
import os import os
@ -304,8 +304,8 @@ class Config:
def read(cls: type[Config], confdir: str | os.PathLike[str], overrides: dict | None = None, def read(cls: type[Config], confdir: str | os.PathLike[str], overrides: dict | None = None,
tags: Tags | None = None) -> Config: tags: Tags | None = None) -> Config:
"""Create a Config object from configuration file.""" """Create a Config object from configuration file."""
filename = path.join(confdir, CONFIG_FILENAME) filename = Path(confdir, CONFIG_FILENAME)
if not path.isfile(filename): if not filename.is_file():
raise ConfigError(__("config directory doesn't contain a conf.py file (%s)") % raise ConfigError(__("config directory doesn't contain a conf.py file (%s)") %
confdir) confdir)
namespace = eval_config_file(filename, tags) namespace = eval_config_file(filename, tags)
@ -510,18 +510,19 @@ class Config:
self.__dict__.update(state) self.__dict__.update(state)
def eval_config_file(filename: str, tags: Tags | None) -> dict[str, Any]: def eval_config_file(filename: str | os.PathLike[str], tags: Tags | None) -> dict[str, Any]:
"""Evaluate a config file.""" """Evaluate a config file."""
filename = Path(filename)
namespace: dict[str, Any] = {} namespace: dict[str, Any] = {}
namespace['__file__'] = filename namespace['__file__'] = str(filename)
namespace['tags'] = tags namespace['tags'] = tags
with chdir(path.dirname(filename)): with chdir(filename.parent):
# during executing config file, current dir is changed to ``confdir``. # during executing config file, current dir is changed to ``confdir``.
try: try:
with open(filename, 'rb') as f: code = compile(filename.read_bytes(), filename, 'exec')
code = compile(f.read(), filename.encode(fs_encoding), 'exec') exec(code, namespace) # NoQA: S102
exec(code, namespace) # NoQA: S102
except SyntaxError as err: except SyntaxError as err:
msg = __("There is a syntax error in your configuration file: %s\n") msg = __("There is a syntax error in your configuration file: %s\n")
raise ConfigError(msg % err) from err raise ConfigError(msg % err) from err