Skip to content

Commit 8831d48

Browse files
AA-TurnerAA-Turner
committed
Ruff
1 parent e405138 commit 8831d48

File tree

11 files changed

+259
-152
lines changed

11 files changed

+259
-152
lines changed

‎sphinxarg/ext.py‎

Lines changed: 126 additions & 63 deletions
Large diffs are not rendered by default.

‎sphinxarg/utils.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def command_pos_args(result: dict) -> str:
2020
>>> command_pos_args("blah")
2121
''
2222
"""
23-
ret = ""
23+
ret = ''
2424

2525
if 'name' in result and result['name'] != '':
2626
ret += f"{result['name']}"
@@ -43,12 +43,13 @@ def target_to_anchor_id(target: str) -> str:
4343
'simple-command-A'
4444
"""
4545
if len(target) < 1:
46-
raise ValueError('Supplied target string is less than one character long.')
46+
msg = 'Supplied target string is less than one character long.'
47+
raise ValueError(msg)
4748

4849
return target.replace(' ', '-')
4950

5051

51-
if __name__ == "__main__":
52+
if __name__ == '__main__':
5253
import doctest
5354

5455
doctest.testmod()

‎test/roots/test-argparse-directive/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
extensions = ["sphinxarg.ext"]
1+
extensions = ['sphinxarg.ext']

‎test/roots/test-command-by-group-index/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
extensions = ["sphinxarg.ext"]
1+
extensions = ['sphinxarg.ext']
22
sphinx_argparse_conf = {
3-
"commands_by_group_index_in_toctree": True,
3+
'commands_by_group_index_in_toctree': True,
44
}

‎test/roots/test-command-index/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
extensions = ["sphinxarg.ext"]
1+
extensions = ['sphinxarg.ext']
22
sphinx_argparse_conf = {
3-
"build_commands_index": True,
4-
"commands_index_in_toctree": True,
3+
'build_commands_index': True,
4+
'commands_index_in_toctree': True,
55
}

‎test/roots/test-conf-opts-html/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
extensions = ["sphinxarg.ext"]
1+
extensions = ['sphinxarg.ext']

‎test/test_commands_by_group_index.py‎

Lines changed: 56 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,44 @@
99

1010

1111
@pytest.mark.parametrize(
12-
"fname,expect",
13-
flat_dict(
14-
{
15-
'index.html': [
16-
(".//div[@role='navigation']//a[@class='reference internal']", 'Sample'),
17-
(".//div[@role='navigation']//a[@class='reference internal']", 'Command A'),
18-
(".//div[@role='navigation']//a[@class='reference internal']", 'Command B'),
19-
(".//div[@role='navigation']//a[@class='reference internal']", 'Commands by Group'),
20-
],
21-
'commands-by-group.html': [
22-
(".//h1", 'Commands by Group'),
23-
(".//tr/td[2]/strong", 'ham in a cone'),
24-
(".//tr[td[2]/strong/text()='ham in a cone']/following-sibling::tr[1]/td[2]/a/code", 'sample-directive-opts'),
25-
(".//tr[td[2]/strong/text()='ham in a cone']/following-sibling::tr[2]/td[2]/a/code", 'sample-directive-opts B'),
26-
(".//tr/td[2]/strong", 'spam'),
27-
(".//tr[td[2]/strong/text()='spam on a stick']/following-sibling::tr[1]/td[2]/a/code", 'sample-directive-opts'),
28-
(".//tr[td[2]/strong/text()='spam on a stick']/following-sibling::tr[2]/td[2]/a/code", 'sample-directive-opts A'),
29-
(".//tr/td[2]/em", '(other)', False), # Other does not have idxgroups set at all and is not present.
30-
],
31-
}
32-
),
12+
('fname', 'expect'),
13+
flat_dict({
14+
'index.html': [
15+
(".//div[@role='navigation']//a[@class='reference internal']", 'Sample'),
16+
(".//div[@role='navigation']//a[@class='reference internal']", 'Command A'),
17+
(".//div[@role='navigation']//a[@class='reference internal']", 'Command B'),
18+
(
19+
".//div[@role='navigation']//a[@class='reference internal']",
20+
'Commands by Group',
21+
),
22+
],
23+
'commands-by-group.html': [
24+
('.//h1', 'Commands by Group'),
25+
('.//tr/td[2]/strong', 'ham in a cone'),
26+
(
27+
".//tr[td[2]/strong/text()='ham in a cone']/following-sibling::tr[1]/td[2]/a/code", # NoQA: E501
28+
'sample-directive-opts',
29+
),
30+
(
31+
".//tr[td[2]/strong/text()='ham in a cone']/following-sibling::tr[2]/td[2]/a/code", # NoQA: E501
32+
'sample-directive-opts B',
33+
),
34+
('.//tr/td[2]/strong', 'spam'),
35+
(
36+
".//tr[td[2]/strong/text()='spam on a stick']/following-sibling::tr[1]/td[2]/a/code", # NoQA: E501
37+
'sample-directive-opts',
38+
),
39+
(
40+
".//tr[td[2]/strong/text()='spam on a stick']/following-sibling::tr[2]/td[2]/a/code", # NoQA: E501
41+
'sample-directive-opts A',
42+
),
43+
(
44+
'.//tr/td[2]/em',
45+
'(other)',
46+
False,
47+
), # Other does not have idxgroups set at all and is not present.
48+
],
49+
}),
3350
)
3451
@pytest.mark.sphinx('html', testroot='command-by-group-index')
3552
def test_commands_by_group_index_html(app, cached_etree_parse, fname, expect):
@@ -38,27 +55,28 @@ def test_commands_by_group_index_html(app, cached_etree_parse, fname, expect):
3855

3956

4057
@pytest.mark.parametrize(
41-
"fname,expect",
42-
flat_dict(
43-
{
44-
'index.html': [
45-
(".//div[@role='navigation']//a[@class='reference internal']", 'Commands grouped by SomeName'),
46-
],
47-
'commands-groupedby-somename.html': [
48-
(".//h1", 'Commands grouped by SomeName'),
49-
(".//h1", 'Commands by Group', False),
50-
],
51-
}
52-
),
58+
('fname', 'expect'),
59+
flat_dict({
60+
'index.html': [
61+
(
62+
".//div[@role='navigation']//a[@class='reference internal']",
63+
'Commands grouped by SomeName',
64+
),
65+
],
66+
'commands-groupedby-somename.html': [
67+
('.//h1', 'Commands grouped by SomeName'),
68+
('.//h1', 'Commands by Group', False),
69+
],
70+
}),
5371
)
5472
@pytest.mark.sphinx(
5573
'html',
5674
testroot='command-by-group-index',
5775
confoverrides={
5876
'sphinx_argparse_conf': {
59-
"commands_by_group_index_title": "Commands grouped by SomeName",
60-
"commands_by_group_index_file_suffix": "groupedby-somename",
61-
"commands_by_group_index_in_toctree": True,
77+
'commands_by_group_index_title': 'Commands grouped by SomeName',
78+
'commands_by_group_index_file_suffix': 'groupedby-somename',
79+
'commands_by_group_index_in_toctree': True,
6280
}
6381
},
6482
)
@@ -78,5 +96,5 @@ def update_toctree(app):
7896

7997
@pytest.mark.sphinx('html', testroot='command-by-group-index')
8098
def test_by_group_index_overrides_files_html(app):
81-
assert os.path.exists(app.outdir / (CommandsByGroupIndex.name + ".html")) is False
82-
assert os.path.exists(app.outdir / "commands-groupedby-somename.html") is True
99+
assert os.path.exists(app.outdir / (CommandsByGroupIndex.name + '.html')) is False
100+
assert os.path.exists(app.outdir / 'commands-groupedby-somename.html') is True

‎test/test_commands_index.py‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,26 @@
44

55

66
@pytest.mark.parametrize(
7-
"fname,expect",
8-
flat_dict(
9-
{
10-
'subcommand-a.html': [
11-
(".//h1", 'Sample', False),
12-
(".//h1", 'Command A'),
13-
],
14-
'subcommand-b.html': [
15-
(".//h1", 'Sample', False),
16-
(".//h1", 'Command B'),
17-
],
18-
'commands-index.html': [
19-
(".//h1", 'Commands Index'),
20-
(".//tr/td[2]/a/code", 'sample-directive-opts'),
21-
(".//tr/td[3]/em", 'Support SphinxArgParse HTML testing'),
22-
(".//tr[td[2]/a/code/text()='sample-directive-opts']/td[3]/em", 'Support SphinxArgParse HTML testing'),
23-
],
24-
}
25-
),
7+
('fname', 'expect'),
8+
flat_dict({
9+
'subcommand-a.html': [
10+
('.//h1', 'Sample', False),
11+
('.//h1', 'Command A'),
12+
],
13+
'subcommand-b.html': [
14+
('.//h1', 'Sample', False),
15+
('.//h1', 'Command B'),
16+
],
17+
'commands-index.html': [
18+
('.//h1', 'Commands Index'),
19+
('.//tr/td[2]/a/code', 'sample-directive-opts'),
20+
('.//tr/td[3]/em', 'Support SphinxArgParse HTML testing'),
21+
(
22+
".//tr[td[2]/a/code/text()='sample-directive-opts']/td[3]/em",
23+
'Support SphinxArgParse HTML testing',
24+
),
25+
],
26+
}),
2627
)
2728
@pytest.mark.sphinx('html', testroot='command-index')
2829
def test_commands_index_html(app, cached_etree_parse, fname, expect):

‎test/test_conf_options_html.py‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,22 @@
66

77

88
@pytest.mark.parametrize(
9-
"fname,expect",
10-
flat_dict(
11-
{
12-
'index.html': [
13-
(".//h1", 'Sample'),
14-
(".//h2", 'Sub-commands'),
15-
(".//h3", 'sample-directive-opts A'), # By default, just "A".
16-
(".//h3", 'sample-directive-opts B'),
17-
],
18-
}
19-
),
9+
('fname', 'expect'),
10+
flat_dict({
11+
'index.html': [
12+
('.//h1', 'Sample'),
13+
('.//h2', 'Sub-commands'),
14+
('.//h3', 'sample-directive-opts A'), # By default, just "A".
15+
('.//h3', 'sample-directive-opts B'),
16+
],
17+
}),
2018
)
2119
@pytest.mark.sphinx(
2220
'html',
2321
testroot='conf-opts-html',
2422
confoverrides={
2523
'sphinx_argparse_conf': {
26-
"full_subcommand_name": True,
24+
'full_subcommand_name': True,
2725
}
2826
},
2927
)

‎test/test_default_html.py‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Test the HTML builder and check output against XPath."""
22

3-
import re
43
import posixpath
4+
import re
55

66
import pytest
77
from sphinx.ext.intersphinx import INVENTORY_FILENAME
@@ -61,10 +61,16 @@ def get_text(node):
6161
('.//h2', 'Positional Arguments'),
6262
(".//section[@id='sample-directive-opts-positional-arguments']", ''),
6363
(".//section/span[@id='positional-arguments']", ''),
64-
(".//section[@id='sample-directive-opts-positional-arguments']/dl/dt[1]/kbd", 'foo2 metavar'),
64+
(
65+
".//section[@id='sample-directive-opts-positional-arguments']/dl/dt[1]/kbd",
66+
'foo2 metavar',
67+
),
6568
(".//section[@id='sample-directive-opts-named-arguments']", ''),
6669
(".//section/span[@id='named-arguments']", ''),
67-
(".//section[@id='sample-directive-opts-named-arguments']/dl/dt[1]/kbd", '--foo'),
70+
(
71+
".//section[@id='sample-directive-opts-named-arguments']/dl/dt[1]/kbd",
72+
'--foo',
73+
),
6874
(".//section[@id='sample-directive-opts-bar-options']", ''),
6975
(".//section[@id='sample-directive-opts-bar-options']/dl/dt[1]/kbd", '--bar'),
7076
(".//section[@id='link-check']/p[1]/a[@href='#sample-directive-opts-A']", ''),
@@ -79,7 +85,10 @@ def get_text(node):
7985
('.//h2', 'Positional Arguments'),
8086
(".//section[@id='sample-directive-opts-A-positional-arguments']", ''),
8187
(".//section/span[@id='positional-arguments']", ''),
82-
(".//section[@id='sample-directive-opts-A-positional-arguments']/dl/dt[1]/kbd", 'baz'),
88+
(
89+
".//section[@id='sample-directive-opts-A-positional-arguments']/dl/dt[1]/kbd",
90+
'baz',
91+
),
8392
],
8493
),
8594
(
@@ -115,10 +124,10 @@ def test_default_html(app, cached_etree_parse, fname, expect_list):
115124
@pytest.mark.sphinx('html', testroot='default-html')
116125
def test_index_is_optional(app, cached_etree_parse):
117126
app.build()
118-
index_file = app.outdir / "index.html"
127+
index_file = app.outdir / 'index.html'
119128
assert index_file.exists() is True # Confirm that the build occurred.
120129

121-
command_index_file = app.outdir / "commands-index.html"
130+
command_index_file = app.outdir / 'commands-index.html'
122131
assert command_index_file.exists() is False
123132

124133

@@ -132,10 +141,19 @@ def test_object_inventory(app, cached_etree_parse):
132141
inv: Inventory = InventoryFile.load(f, 'test/path', posixpath.join)
133142

134143
assert 'sample-directive-opts' in inv.get('commands:command')
135-
assert 'test/path/index.html#sample-directive-opts' == inv['commands:command']['sample-directive-opts'][2]
144+
assert (
145+
'test/path/index.html#sample-directive-opts'
146+
== inv['commands:command']['sample-directive-opts'][2]
147+
)
136148

137149
assert 'sample-directive-opts A' in inv.get('commands:command')
138-
assert 'test/path/subcommand-a.html#sample-directive-opts-A' == inv['commands:command']['sample-directive-opts A'][2]
150+
assert (
151+
'test/path/subcommand-a.html#sample-directive-opts-A'
152+
== inv['commands:command']['sample-directive-opts A'][2]
153+
)
139154

140155
assert 'sample-directive-opts B' in inv.get('commands:command')
141-
assert 'test/path/index.html#sample-directive-opts-B' == inv['commands:command']['sample-directive-opts B'][2]
156+
assert (
157+
'test/path/index.html#sample-directive-opts-B'
158+
== inv['commands:command']['sample-directive-opts B'][2]
159+
)

0 commit comments

Comments
 (0)