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

Lint with flake8-bugbear (#10602)

Browse Source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
danieleades 2022-07-12 22:55:57 +01:00 committed by GitHub
parent 69824f9265
commit 25d379fb53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 53 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
setup.cfg
View File

@ -11,7 +11,7 @@ upload = upload --sign --identity=36580288
[flake8]
max-line-length = 95
ignore = E116,E241,E251,E741,W504,I101
ignore = E116,E241,E251,E741,W504,I101,B006,B023
exclude = .git,.tox,.venv,tests/roots/*,build/*,doc/_build/*,sphinx/search/*,doc/usage/extensions/example*.py
application-import-names = sphinx
import-order-style = smarkets

1
setup.py
View File

@ -41,6 +41,7 @@ extras_require = {
'lint': [
'flake8>=3.5.0',
'flake8-comprehensions',
'flake8-bugbear',
'isort',
'mypy>=0.950',
'sphinx-lint',

2
sphinx/builders/linkcheck.py
View File

@ -301,7 +301,7 @@ class HyperlinkAvailabilityCheckWorker(Thread):
req_url = encode_uri(req_url)
# Get auth info, if any
for pattern, auth_info in self.auth:
for pattern, auth_info in self.auth: # noqa: B007 (false positive)
if pattern.match(uri):
break
else:

14
sphinx/domains/c.py
View File

@ -197,11 +197,11 @@ class ASTNestedName(ASTBase):
# just print the name part, with template args, not template params
if mode == 'noneIsName':
if self.rooted:
assert False, "Can this happen?" # TODO
raise AssertionError("Can this happen?") # TODO
signode += nodes.Text('.')
for i in range(len(self.names)):
if i != 0:
assert False, "Can this happen?" # TODO
raise AssertionError("Can this happen?") # TODO
signode += nodes.Text('.')
n = self.names[i]
n.describe_signature(signode, mode, env, '', symbol)
@ -1488,7 +1488,7 @@ class ASTDeclaration(ASTBaseBase):
mainDeclNode += addnodes.desc_sig_keyword(prefix, prefix)
mainDeclNode += addnodes.desc_sig_space()
else:
assert False
raise AssertionError()
self.declaration.describe_signature(mainDeclNode, mode, env, self.symbol)
if self.semicolon:
mainDeclNode += addnodes.desc_sig_punctuation(';', ';')
@ -1518,11 +1518,11 @@ class Symbol:
debug_show_tree = False
def __copy__(self):
assert False # shouldn't happen
raise AssertionError() # shouldn't happen
def __deepcopy__(self, memo):
if self.parent:
assert False # shouldn't happen
raise AssertionError() # shouldn't happen
else:
# the domain base class makes a copy of the initial data, which is fine
return Symbol(None, None, None, None, None)
@ -1543,7 +1543,7 @@ class Symbol:
def __setattr__(self, key: str, value: Any) -> None:
if key == "children":
assert False
raise AssertionError()
else:
return super().__setattr__(key, value)
@ -3091,7 +3091,7 @@ class DefinitionParser(BaseParser):
elif objectType == 'type':
declaration = self._parse_type(named=True, outer='type')
else:
assert False
raise AssertionError()
if objectType != 'macro':
self.skip_ws()
semicolon = self.skip_string(';')

38
sphinx/domains/cpp.py
View File

@ -754,15 +754,15 @@ class ASTNestedName(ASTBase):
# just print the name part, with template args, not template params
if mode == 'noneIsName':
if self.rooted:
assert False, "Can this happen?" # TODO
raise AssertionError("Can this happen?") # TODO
signode += nodes.Text('::')
for i in range(len(self.names)):
if i != 0:
assert False, "Can this happen?" # TODO
raise AssertionError("Can this happen?") # TODO
signode += nodes.Text('::blah')
n = self.names[i]
if self.templates[i]:
assert False, "Can this happen?" # TODO
raise AssertionError("Can this happen?") # TODO
signode += nodes.Text("template")
signode += nodes.Text(" ")
n.describe_signature(signode, mode, env, '', symbol)
@ -1386,7 +1386,7 @@ class ASTNewExpr(ASTExpression):
if self.isNewTypeId:
res.append(transform(self.typ))
else:
assert False
raise AssertionError()
if self.initList is not None:
res.append(transform(self.initList))
return ''.join(res)
@ -1413,7 +1413,7 @@ class ASTNewExpr(ASTExpression):
if self.isNewTypeId:
self.typ.describe_signature(signode, mode, env, symbol)
else:
assert False
raise AssertionError()
if self.initList is not None:
self.initList.describe_signature(signode, mode, env, symbol)
@ -1990,7 +1990,7 @@ class ASTTrailingTypeSpecName(ASTTrailingTypeSpec):
signode += addnodes.desc_sig_keyword('auto', 'auto')
signode += addnodes.desc_sig_punctuation(')', ')')
else:
assert False, self.placeholderType
raise AssertionError(self.placeholderType)
class ASTFunctionParameter(ASTBase):
@ -3095,8 +3095,7 @@ class ASTType(ASTBase):
elif objectType == 'type': # just the name
res.append(symbol.get_full_nested_name().get_id(version))
else:
print(objectType)
assert False
raise AssertionError(objectType)
else: # only type encoding
if self.decl.is_function_type():
raise NoOldIdError()
@ -3125,8 +3124,7 @@ class ASTType(ASTBase):
elif objectType == 'type': # just the name
res.append(symbol.get_full_nested_name().get_id(version))
else:
print(objectType)
assert False
raise AssertionError(objectType)
else: # only type encoding
# the 'returnType' of a non-function type is simply just the last
# type, i.e., for 'int*' it is 'int'
@ -4049,7 +4047,7 @@ class ASTDeclaration(ASTBase):
mainDeclNode += addnodes.desc_sig_keyword('enumerator', 'enumerator')
mainDeclNode += addnodes.desc_sig_space()
else:
assert False, self.objectType
raise AssertionError(self.objectType)
self.declaration.describe_signature(mainDeclNode, mode, env, self.symbol)
lastDeclNode = mainDeclNode
if self.trailingRequiresClause:
@ -4103,11 +4101,11 @@ class Symbol:
debug_show_tree = False # overridden by the corresponding config value
def __copy__(self):
assert False # shouldn't happen
raise AssertionError() # shouldn't happen
def __deepcopy__(self, memo):
if self.parent:
assert False # shouldn't happen
raise AssertionError() # shouldn't happen
else:
# the domain base class makes a copy of the initial data, which is fine
return Symbol(None, None, None, None, None, None, None)
@ -4131,7 +4129,7 @@ class Symbol:
def __setattr__(self, key: str, value: Any) -> None:
if key == "children":
assert False
raise AssertionError()
else:
return super().__setattr__(key, value)
@ -5991,7 +5989,7 @@ class DefinitionParser(BaseParser):
if modifier is not None:
self.fail("Can not have {} without a floating point type.".format(modifier))
else:
assert False, "Unhandled type {}".format(typ)
raise AssertionError("Unhandled type {}".format(typ))
canonNames: List[str] = []
if modifier is not None:
@ -6513,7 +6511,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function':
desc = "If the function has no return type"
else:
assert False
raise AssertionError()
prevErrors.append((exUntyped, desc))
self.pos = startPos
try:
@ -6526,7 +6524,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function':
desc = "If the function has a return type"
else:
assert False
raise AssertionError()
prevErrors.append((exTyped, desc))
# Retain the else branch for easier debugging.
# TODO: it would be nice to save the previous stacktrace
@ -6538,7 +6536,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function':
header = "Error when parsing function declaration."
else:
assert False
raise AssertionError()
raise self._make_multi_error(prevErrors, header) from exTyped
else:
# For testing purposes.
@ -6997,7 +6995,7 @@ class DefinitionParser(BaseParser):
elif objectType == 'enumerator':
declaration = self._parse_enumerator()
else:
assert False
raise AssertionError()
templatePrefix = self._check_template_consistency(declaration.name,
templatePrefix,
fullSpecShorthand=False,
@ -7924,7 +7922,7 @@ class CPPDomain(Domain):
if objtypes:
return declTyp in objtypes
print("Type is %s, declaration type is %s" % (typ, declTyp))
assert False
raise AssertionError()
if not checkType():
logger.warning("cpp:%s targets a %s (%s).",
typ, s.declaration.objectType,

6
sphinx/testing/util.py
View File

@ -24,17 +24,17 @@ __all__ = [
def assert_re_search(regex: Pattern, text: str, flags: int = 0) -> None:
if not re.search(regex, text, flags):
assert False, '%r did not match %r' % (regex, text)
raise AssertionError('%r did not match %r' % (regex, text))
def assert_not_re_search(regex: Pattern, text: str, flags: int = 0) -> None:
if re.search(regex, text, flags):
assert False, '%r did match %r' % (regex, text)
raise AssertionError('%r did match %r' % (regex, text))
def assert_startswith(thing: str, prefix: str) -> None:
if not thing.startswith(prefix):
assert False, '%r does not start with %r' % (thing, prefix)
raise AssertionError('%r does not start with %r' % (thing, prefix))
def assert_node(node: Node, cls: Any = None, xpath: str = "", **kwargs: Any) -> None:

2
tests/test_build_epub.py
View File

@ -381,4 +381,4 @@ def test_run_epubcheck(app):
except CalledProcessError as exc:
print(exc.stdout.decode('utf-8'))
print(exc.stderr.decode('utf-8'))
assert False, 'epubcheck exited with return code %s' % exc.returncode
raise AssertionError('epubcheck exited with return code %s' % exc.returncode)

4
tests/test_build_gettext.py
View File

@ -60,7 +60,7 @@ def test_msgfmt(app):
except CalledProcessError as exc:
print(exc.stdout)
print(exc.stderr)
assert False, 'msginit exited with return code %s' % exc.returncode
raise AssertionError('msginit exited with return code %s' % exc.returncode)
assert (app.outdir / 'en_US.po').isfile(), 'msginit failed'
try:
@ -72,7 +72,7 @@ def test_msgfmt(app):
except CalledProcessError as exc:
print(exc.stdout)
print(exc.stderr)
assert False, 'msgfmt exited with return code %s' % exc.returncode
raise AssertionError('msgfmt exited with return code %s' % exc.returncode)
mo = app.outdir / 'en' / 'LC_MESSAGES' / 'test_root.mo'
assert mo.isfile(), 'msgfmt failed'

12
tests/test_build_html.py
View File

@ -79,7 +79,7 @@ def tail_check(check):
for node in nodes:
if node.tail and rex.search(node.tail):
return True
assert False, '%r not found in tail of any nodes %s' % (check, nodes)
raise AssertionError('%r not found in tail of any nodes %s' % (check, nodes))
return checker
@ -114,9 +114,9 @@ def check_xpath(etree, fname, path, check, be_found=True):
if all(not rex.search(get_text(node)) for node in nodes):
return
assert False, ('%r not found in any node matching '
'path %s in %s: %r' % (check, path, fname,
[node.text for node in nodes]))
raise AssertionError(('%r not found in any node matching '
'path %s in %s: %r' % (check, path, fname,
[node.text for node in nodes])))
@pytest.mark.sphinx('html', testroot='warnings')
@ -1520,7 +1520,7 @@ def test_html_math_renderer_is_duplicated(make_app, app_params):
try:
args, kwargs = app_params
make_app(*args, **kwargs)
assert False
raise AssertionError()
except ConfigError as exc:
assert str(exc) == ('Many math_renderers are registered. '
'But no math_renderer is selected.')
@ -1550,7 +1550,7 @@ def test_html_math_renderer_is_mismatched(make_app, app_params):
try:
args, kwargs = app_params
make_app(*args, **kwargs)
assert False
raise AssertionError()
except ConfigError as exc:
assert str(exc) == "Unknown math_renderer 'imgmath' is given."

6
tests/test_build_latex.py
View File

@ -60,8 +60,8 @@ def compile_latex_document(app, filename='python.tex'):
except CalledProcessError as exc:
print(exc.stdout)
print(exc.stderr)
assert False, '%s exited with return code %s' % (app.config.latex_engine,
exc.returncode)
raise AssertionError('%s exited with return code %s' % (app.config.latex_engine,
exc.returncode))
def skip_if_requested(testfunc):
@ -992,7 +992,7 @@ def test_image_in_section(app, status, warning):
def test_latex_logo_if_not_found(app, status, warning):
try:
app.builder.build_all()
assert False # SphinxError not raised
raise AssertionError() # SphinxError not raised
except Exception as exc:
assert isinstance(exc, SphinxError)

2
tests/test_build_texinfo.py
View File

@ -55,7 +55,7 @@ def test_texinfo(app, status, warning):
except CalledProcessError as exc:
print(exc.stdout)
print(exc.stderr)
assert False, 'makeinfo exited with return code %s' % exc.retcode
raise AssertionError('makeinfo exited with return code %s' % exc.retcode)
@pytest.mark.sphinx('texinfo', testroot='markup-rubric')

6
tests/test_config.py
View File

@ -48,13 +48,13 @@ def test_core_config(app, status, warning):
# invalid values
with pytest.raises(AttributeError):
getattr(cfg, '_value')
cfg._value
with pytest.raises(AttributeError):
getattr(cfg, 'nonexisting_value')
cfg.nonexisting_value
# non-value attributes are deleted from the namespace
with pytest.raises(AttributeError):
getattr(cfg, 'sys')
cfg.sys
# setting attributes
cfg.project = 'Foo'

4
tests/test_domain_cpp.py
View File

@ -1140,7 +1140,7 @@ def test_domain_cpp_build_with_add_function_parentheses_is_True(app, status, war
res = re.search(pattern, text)
if not res:
print("Pattern\n\t%s\nnot found in %s" % (pattern, file))
assert False
raise AssertionError()
rolePatterns = [
('', 'Sphinx'),
('', 'Sphinx::version'),
@ -1181,7 +1181,7 @@ def test_domain_cpp_build_with_add_function_parentheses_is_False(app, status, wa
res = re.search(pattern, text)
if not res:
print("Pattern\n\t%s\nnot found in %s" % (pattern, file))
assert False
raise AssertionError()
rolePatterns = [
('', 'Sphinx'),
('', 'Sphinx::version'),

4
tests/test_ext_doctest.py
View File

@ -18,7 +18,7 @@ def test_build(app, status, warning):
cleanup_called = 0
app.builder.build_all()
if app.statuscode != 0:
assert False, 'failures in doctests:' + status.getvalue()
raise AssertionError('failures in doctests:' + status.getvalue())
# in doctest.txt, there are two named groups and the default group,
# so the cleanup function must be called three times
assert cleanup_called == 3, 'testcleanup did not get executed enough times'
@ -88,7 +88,7 @@ def test_skipif(app, status, warning):
recorded_calls = Counter()
app.builder.build_all()
if app.statuscode != 0:
assert False, 'failures in doctests:' + status.getvalue()
raise AssertionError('failures in doctests:' + status.getvalue())
# The `:skipif:` expressions are always run.
# Actual tests and setup/cleanup code is only run if the `:skipif:`
# expression evaluates to a False value.

2
tests/test_search.py
View File

@ -67,7 +67,7 @@ def test_objects_are_escaped(app, status, warning):
if item[-1] == 'n::Array&lt;T, d&gt;': # n::Array<T,d> is escaped
break
else:
assert False, index.get('objects').get('')
raise AssertionError(index.get('objects').get(''))
@pytest.mark.sphinx(testroot='search')

2
tests/test_util_inspect.py
View File

@ -730,7 +730,7 @@ def test_getdoc_inherited_decorated_method():
"""
class Bar(Foo):
@functools.lru_cache()
@functools.lru_cache() # noqa: B019
def meth(self):
# inherited and decorated method
pass