1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
"""Tests util functions."""
from __future__ import annotations
import pytest
import sphinx.util
from sphinx._cli.util.errors import strip_escape_sequences
from sphinx.deprecation import RemovedInSphinx10Warning, RemovedInSphinx90Warning
from sphinx.errors import ExtensionError
from sphinx.util._files import DownloadFiles, FilenameUniqDict
from sphinx.util._importer import import_object
from sphinx.util._lines import parse_line_num_spec
from sphinx.util._uri import encode_uri, is_url
from sphinx.util.index_entries import _split_into, split_index_msg
from sphinx.util.matching import patfilter
from sphinx.util.nodes import (
caption_ref_re,
explicit_title_re,
nested_parse_with_titles,
split_explicit_title,
)
from sphinx.util.osutil import (
SEP,
copyfile,
ensuredir,
make_filename,
os_path,
relative_uri,
)
def test_ensuredir(tmp_path):
# Does not raise an exception for an existing directory.
ensuredir(tmp_path)
path = tmp_path / 'a' / 'b' / 'c'
ensuredir(path)
assert path.is_dir()
def test_exported_attributes() -> None:
# RemovedInSphinx90Warning
with pytest.warns(
RemovedInSphinx90Warning,
match=r"deprecated, use 'sphinx.util.index_entries.split_index_msg' instead.",
):
assert sphinx.util.split_index_msg is split_index_msg
with pytest.warns(RemovedInSphinx90Warning, match=r'deprecated.'):
assert sphinx.util.split_into is _split_into
with pytest.warns(
RemovedInSphinx90Warning,
match=r"deprecated, use 'sphinx.errors.ExtensionError' instead.",
):
assert sphinx.util.ExtensionError is ExtensionError
with pytest.warns(
RemovedInSphinx90Warning,
match=r"deprecated, use 'hashlib.md5' instead.",
):
_ = sphinx.util.md5
with pytest.warns(
RemovedInSphinx90Warning,
match=r"deprecated, use 'hashlib.sha1' instead.",
):
_ = sphinx.util.sha1
# RemovedInSphinx10Warning
with pytest.warns(RemovedInSphinx10Warning, match=r'deprecated.'):
assert sphinx.util.FilenameUniqDict is FilenameUniqDict
with pytest.warns(RemovedInSphinx10Warning, match=r'deprecated.'):
assert sphinx.util.DownloadFiles is DownloadFiles
# Re-exported for backwards compatibility,
# but not currently deprecated
assert sphinx.util.encode_uri is encode_uri
assert sphinx.util.import_object is import_object
assert sphinx.util.isurl is is_url
assert sphinx.util.parselinenos is parse_line_num_spec
assert sphinx.util.patfilter is patfilter
assert sphinx.util.strip_escape_sequences is strip_escape_sequences
assert sphinx.util.caption_ref_re is caption_ref_re
assert sphinx.util.explicit_title_re is explicit_title_re
assert sphinx.util.nested_parse_with_titles is nested_parse_with_titles
assert sphinx.util.split_explicit_title is split_explicit_title
assert sphinx.util.SEP is SEP
assert sphinx.util.copyfile is copyfile
assert sphinx.util.ensuredir is ensuredir
assert sphinx.util.make_filename is make_filename
assert sphinx.util.os_path is os_path
assert sphinx.util.relative_uri is relative_uri
|
