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

Fix RES102 (Remove unnecessary parentheses)

Browse Source
This commit is contained in:
Adam Turner 2023-07-28 07:05:56 +01:00 committed by Adam Turner
parent 064b627953
commit e2ff04eafe
5 changed files with 42 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pyproject.toml
View File

@ -230,8 +230,6 @@ ignore = [
# flake8-return # flake8-return
"RET504", # unnecessary variable assignment before `return` statement "RET504", # unnecessary variable assignment before `return` statement
"RET505", # unnecessary `else` after `return` statement "RET505", # unnecessary `else` after `return` statement
# flake8-raise
"RSE102",
# Ruff-specific rules # Ruff-specific rules
"RUF001", # string contains ambiguous unicode character "RUF001", # string contains ambiguous unicode character
"RUF003", # comment contains ambiguous unicode character "RUF003", # comment contains ambiguous unicode character

12
sphinx/domains/c.py
View File

@ -1511,7 +1511,7 @@ class ASTDeclaration(ASTBaseBase):
mainDeclNode += addnodes.desc_sig_keyword(prefix, prefix) mainDeclNode += addnodes.desc_sig_keyword(prefix, prefix)
mainDeclNode += addnodes.desc_sig_space() mainDeclNode += addnodes.desc_sig_space()
else: else:
raise AssertionError() raise AssertionError
self.declaration.describe_signature(mainDeclNode, mode, env, self.symbol) self.declaration.describe_signature(mainDeclNode, mode, env, self.symbol)
if self.semicolon: if self.semicolon:
mainDeclNode += addnodes.desc_sig_punctuation(';', ';') mainDeclNode += addnodes.desc_sig_punctuation(';', ';')
@ -1541,11 +1541,11 @@ class Symbol:
debug_show_tree = False debug_show_tree = False
def __copy__(self): def __copy__(self):
raise AssertionError() # shouldn't happen raise AssertionError # shouldn't happen
def __deepcopy__(self, memo): def __deepcopy__(self, memo):
if self.parent: if self.parent:
raise AssertionError() # shouldn't happen raise AssertionError # shouldn't happen
# the domain base class makes a copy of the initial data, which is fine # the domain base class makes a copy of the initial data, which is fine
return Symbol(None, None, None, None, None) return Symbol(None, None, None, None, None)
@ -1565,7 +1565,7 @@ class Symbol:
def __setattr__(self, key: str, value: Any) -> None: def __setattr__(self, key: str, value: Any) -> None:
if key == "children": if key == "children":
raise AssertionError() raise AssertionError
return super().__setattr__(key, value) return super().__setattr__(key, value)
def __init__( def __init__(
@ -3113,7 +3113,7 @@ class DefinitionParser(BaseParser):
elif objectType == 'type': elif objectType == 'type':
declaration = self._parse_type(named=True, outer='type') declaration = self._parse_type(named=True, outer='type')
else: else:
raise AssertionError() raise AssertionError
if objectType != 'macro': if objectType != 'macro':
self.skip_ws() self.skip_ws()
semicolon = self.skip_string(';') semicolon = self.skip_string(';')
@ -3243,7 +3243,7 @@ class CObject(ObjectDescription[ASTDeclaration]):
@property @property
def object_type(self) -> str: def object_type(self) -> str:
raise NotImplementedError() raise NotImplementedError
@property @property
def display_object_type(self) -> str: def display_object_type(self) -> str:

64
sphinx/domains/cpp.py
View File

@ -621,7 +621,7 @@ class ASTIdentifier(ASTBase):
def get_id(self, version: int) -> str: def get_id(self, version: int) -> str:
if self.is_anon() and version < 3: if self.is_anon() and version < 3:
raise NoOldIdError() raise NoOldIdError
if version == 1: if version == 1:
if self.identifier == 'size_t': if self.identifier == 'size_t':
return 's' return 's'
@ -1407,7 +1407,7 @@ class ASTNewExpr(ASTExpression):
if self.isNewTypeId: if self.isNewTypeId:
res.append(transform(self.typ)) res.append(transform(self.typ))
else: else:
raise AssertionError() raise AssertionError
if self.initList is not None: if self.initList is not None:
res.append(transform(self.initList)) res.append(transform(self.initList))
return ''.join(res) return ''.join(res)
@ -1434,7 +1434,7 @@ class ASTNewExpr(ASTExpression):
if self.isNewTypeId: if self.isNewTypeId:
self.typ.describe_signature(signode, mode, env, symbol) self.typ.describe_signature(signode, mode, env, symbol)
else: else:
raise AssertionError() raise AssertionError
if self.initList is not None: if self.initList is not None:
self.initList.describe_signature(signode, mode, env, symbol) self.initList.describe_signature(signode, mode, env, symbol)
@ -1701,12 +1701,12 @@ class ASTOperator(ASTBase):
return True return True
def get_id(self, version: int) -> str: def get_id(self, version: int) -> str:
raise NotImplementedError() raise NotImplementedError
def _describe_identifier(self, signode: TextElement, identnode: TextElement, def _describe_identifier(self, signode: TextElement, identnode: TextElement,
env: BuildEnvironment, symbol: Symbol) -> None: env: BuildEnvironment, symbol: Symbol) -> None:
"""Render the prefix into signode, and the last part into identnode.""" """Render the prefix into signode, and the last part into identnode."""
raise NotImplementedError() raise NotImplementedError
def describe_signature(self, signode: TextElement, mode: str, def describe_signature(self, signode: TextElement, mode: str,
env: BuildEnvironment, prefix: str, templateArgs: str, env: BuildEnvironment, prefix: str, templateArgs: str,
@ -1746,7 +1746,7 @@ class ASTOperatorBuildIn(ASTOperator):
if version == 1: if version == 1:
ids = _id_operator_v1 ids = _id_operator_v1
if self.op not in ids: if self.op not in ids:
raise NoOldIdError() raise NoOldIdError
else: else:
ids = _id_operator_v2 ids = _id_operator_v2
if self.op not in ids: if self.op not in ids:
@ -1774,7 +1774,7 @@ class ASTOperatorLiteral(ASTOperator):
def get_id(self, version: int) -> str: def get_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return 'li' + self.identifier.get_id(version) return 'li' + self.identifier.get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -1938,7 +1938,7 @@ class ASTTrailingTypeSpecDecltypeAuto(ASTTrailingTypeSpec):
def get_id(self, version: int) -> str: def get_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return 'Dc' return 'Dc'
def describe_signature(self, signode: TextElement, mode: str, def describe_signature(self, signode: TextElement, mode: str,
@ -1958,7 +1958,7 @@ class ASTTrailingTypeSpecDecltype(ASTTrailingTypeSpec):
def get_id(self, version: int) -> str: def get_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return 'DT' + self.expr.get_id(version) + "E" return 'DT' + self.expr.get_id(version) + "E"
def describe_signature(self, signode: TextElement, mode: str, def describe_signature(self, signode: TextElement, mode: str,
@ -2906,18 +2906,18 @@ class ASTDeclaratorMemPtr(ASTDeclarator):
def get_modifiers_id(self, version: int) -> str: def get_modifiers_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return self.next.get_modifiers_id(version) return self.next.get_modifiers_id(version)
def get_param_id(self, version: int) -> str: # only the parameters (if any) def get_param_id(self, version: int) -> str: # only the parameters (if any)
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return self.next.get_param_id(version) return self.next.get_param_id(version)
def get_ptr_suffix_id(self, version: int) -> str: def get_ptr_suffix_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
raise NotImplementedError() raise NotImplementedError
return self.next.get_ptr_suffix_id(version) + 'Dp' return self.next.get_ptr_suffix_id(version) + 'Dp'
def get_type_id(self, version: int, returnTypeId: str) -> str: def get_type_id(self, version: int, returnTypeId: str) -> str:
@ -3002,7 +3002,7 @@ class ASTDeclaratorParen(ASTDeclarator):
def get_ptr_suffix_id(self, version: int) -> str: def get_ptr_suffix_id(self, version: int) -> str:
if version == 1: if version == 1:
raise NoOldIdError() # TODO: was this implemented before? raise NoOldIdError # TODO: was this implemented before?
return self.next.get_ptr_suffix_id(version) + \ return self.next.get_ptr_suffix_id(version) + \
self.inner.get_ptr_suffix_id(version) self.inner.get_ptr_suffix_id(version)
return self.inner.get_ptr_suffix_id(version) + \ return self.inner.get_ptr_suffix_id(version) + \
@ -3141,7 +3141,7 @@ class ASTType(ASTBase):
raise AssertionError(objectType) raise AssertionError(objectType)
else: # only type encoding else: # only type encoding
if self.decl.is_function_type(): if self.decl.is_function_type():
raise NoOldIdError() raise NoOldIdError
res.append(self.declSpecs.get_id(version)) res.append(self.declSpecs.get_id(version))
res.append(self.decl.get_ptr_suffix_id(version)) res.append(self.decl.get_ptr_suffix_id(version))
res.append(self.decl.get_param_id(version)) res.append(self.decl.get_param_id(version))
@ -3292,7 +3292,7 @@ class ASTTypeUsing(ASTBase):
def get_id(self, version: int, objectType: str | None = None, def get_id(self, version: int, objectType: str | None = None,
symbol: Symbol | None = None) -> str: symbol: Symbol | None = None) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return symbol.get_full_nested_name().get_id(version) return symbol.get_full_nested_name().get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -3332,7 +3332,7 @@ class ASTConcept(ASTBase):
def get_id(self, version: int, objectType: str | None = None, def get_id(self, version: int, objectType: str | None = None,
symbol: Symbol | None = None) -> str: symbol: Symbol | None = None) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return symbol.get_full_nested_name().get_id(version) return symbol.get_full_nested_name().get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -3441,7 +3441,7 @@ class ASTUnion(ASTBase):
def get_id(self, version: int, objectType: str, symbol: Symbol) -> str: def get_id(self, version: int, objectType: str, symbol: Symbol) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return symbol.get_full_nested_name().get_id(version) return symbol.get_full_nested_name().get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -3471,7 +3471,7 @@ class ASTEnum(ASTBase):
def get_id(self, version: int, objectType: str, symbol: Symbol) -> str: def get_id(self, version: int, objectType: str, symbol: Symbol) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return symbol.get_full_nested_name().get_id(version) return symbol.get_full_nested_name().get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -3513,7 +3513,7 @@ class ASTEnumerator(ASTBase):
def get_id(self, version: int, objectType: str, symbol: Symbol) -> str: def get_id(self, version: int, objectType: str, symbol: Symbol) -> str:
if version == 1: if version == 1:
raise NoOldIdError() raise NoOldIdError
return symbol.get_full_nested_name().get_id(version) return symbol.get_full_nested_name().get_id(version)
def _stringify(self, transform: StringifyTransform) -> str: def _stringify(self, transform: StringifyTransform) -> str:
@ -4038,7 +4038,7 @@ class ASTDeclaration(ASTBase):
def get_id(self, version: int, prefixed: bool = True) -> str: def get_id(self, version: int, prefixed: bool = True) -> str:
if version == 1: if version == 1:
if self.templatePrefix or self.trailingRequiresClause: if self.templatePrefix or self.trailingRequiresClause:
raise NoOldIdError() raise NoOldIdError
if self.objectType == 'enumerator' and self.enumeratorScopedSymbol: if self.objectType == 'enumerator' and self.enumeratorScopedSymbol:
return self.enumeratorScopedSymbol.declaration.get_id(version) return self.enumeratorScopedSymbol.declaration.get_id(version)
return self.declaration.get_id(version, self.objectType, self.symbol) return self.declaration.get_id(version, self.objectType, self.symbol)
@ -4067,7 +4067,7 @@ class ASTDeclaration(ASTBase):
if requiresClauseInLast or self.trailingRequiresClause: if requiresClauseInLast or self.trailingRequiresClause:
if version < 4: if version < 4:
raise NoOldIdError() raise NoOldIdError
res.append('IQ') res.append('IQ')
if requiresClauseInLast and self.trailingRequiresClause: if requiresClauseInLast and self.trailingRequiresClause:
# make a conjunction of them # make a conjunction of them
@ -4227,11 +4227,11 @@ class Symbol:
debug_show_tree = False # overridden by the corresponding config value debug_show_tree = False # overridden by the corresponding config value
def __copy__(self): def __copy__(self):
raise AssertionError() # shouldn't happen raise AssertionError # shouldn't happen
def __deepcopy__(self, memo): def __deepcopy__(self, memo):
if self.parent: if self.parent:
raise AssertionError() # shouldn't happen raise AssertionError # shouldn't happen
# the domain base class makes a copy of the initial data, which is fine # the domain base class makes a copy of the initial data, which is fine
return Symbol(None, None, None, None, None, None, None) return Symbol(None, None, None, None, None, None, None)
@ -4254,7 +4254,7 @@ class Symbol:
def __setattr__(self, key: str, value: Any) -> None: def __setattr__(self, key: str, value: Any) -> None:
if key == "children": if key == "children":
raise AssertionError() raise AssertionError
return super().__setattr__(key, value) return super().__setattr__(key, value)
def __init__(self, parent: Symbol | None, def __init__(self, parent: Symbol | None,
@ -5086,7 +5086,7 @@ class Symbol:
# Is there another case where it would be good? # Is there another case where it would be good?
if parentSymbol.declaration is not None: if parentSymbol.declaration is not None:
if parentSymbol.declaration.objectType == 'templateParam': if parentSymbol.declaration.objectType == 'templateParam':
raise QualifiedSymbolIsTemplateParam() raise QualifiedSymbolIsTemplateParam
return None return None
try: try:
@ -6646,7 +6646,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function': elif outer == 'function':
desc = "If the function has no return type" desc = "If the function has no return type"
else: else:
raise AssertionError() raise AssertionError
prevErrors.append((exUntyped, desc)) prevErrors.append((exUntyped, desc))
self.pos = startPos self.pos = startPos
try: try:
@ -6659,7 +6659,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function': elif outer == 'function':
desc = "If the function has a return type" desc = "If the function has a return type"
else: else:
raise AssertionError() raise AssertionError
prevErrors.append((exTyped, desc)) prevErrors.append((exTyped, desc))
# Retain the else branch for easier debugging. # Retain the else branch for easier debugging.
# TODO: it would be nice to save the previous stacktrace # TODO: it would be nice to save the previous stacktrace
@ -6671,7 +6671,7 @@ class DefinitionParser(BaseParser):
elif outer == 'function': elif outer == 'function':
header = "Error when parsing function declaration." header = "Error when parsing function declaration."
else: else:
raise AssertionError() raise AssertionError
raise self._make_multi_error(prevErrors, header) from exTyped raise self._make_multi_error(prevErrors, header) from exTyped
else: # NoQA: RET506 else: # NoQA: RET506
# For testing purposes. # For testing purposes.
@ -7128,7 +7128,7 @@ class DefinitionParser(BaseParser):
elif objectType == 'enumerator': elif objectType == 'enumerator':
declaration = self._parse_enumerator() declaration = self._parse_enumerator()
else: else:
raise AssertionError() raise AssertionError
templatePrefix = self._check_template_consistency(declaration.name, templatePrefix = self._check_template_consistency(declaration.name,
templatePrefix, templatePrefix,
fullSpecShorthand=False, fullSpecShorthand=False,
@ -7324,7 +7324,7 @@ class CPPObject(ObjectDescription[ASTDeclaration]):
@property @property
def object_type(self) -> str: def object_type(self) -> str:
raise NotImplementedError() raise NotImplementedError
@property @property
def display_object_type(self) -> str: def display_object_type(self) -> str:
@ -8094,7 +8094,7 @@ class CPPDomain(Domain):
if objtypes: if objtypes:
return declTyp in objtypes return declTyp in objtypes
print(f"Type is {typ}, declaration type is {declTyp}") print(f"Type is {typ}, declaration type is {declTyp}")
raise AssertionError() raise AssertionError
if not checkType(): if not checkType():
logger.warning("cpp:%s targets a %s (%s).", logger.warning("cpp:%s targets a %s (%s).",
typ, s.declaration.objectType, typ, s.declaration.objectType,

4
sphinx/transforms/post_transforms/images.py
View File

@ -222,7 +222,7 @@ class ImageConverter(BaseImageConverter):
def is_available(self) -> bool: def is_available(self) -> bool:
"""Return the image converter is available or not.""" """Return the image converter is available or not."""
raise NotImplementedError() raise NotImplementedError
def guess_mimetypes(self, node: nodes.image) -> list[str]: def guess_mimetypes(self, node: nodes.image) -> list[str]:
if '?' in node['candidates']: if '?' in node['candidates']:
@ -263,7 +263,7 @@ class ImageConverter(BaseImageConverter):
*_from* is a path of the source image file, and *_to* is a path *_from* is a path of the source image file, and *_to* is a path
of the destination file. of the destination file.
""" """
raise NotImplementedError() raise NotImplementedError
def setup(app: Sphinx) -> dict[str, Any]: def setup(app: Sphinx) -> dict[str, Any]:

4
tests/test_domain_cpp.py
View File

@ -1218,7 +1218,7 @@ def test_domain_cpp_build_with_add_function_parentheses_is_True(app, status, war
res = re.search(pattern, text) res = re.search(pattern, text)
if not res: if not res:
print(f"Pattern\n\t{pattern}\nnot found in {file}") print(f"Pattern\n\t{pattern}\nnot found in {file}")
raise AssertionError() raise AssertionError
rolePatterns = [ rolePatterns = [
('', 'Sphinx'), ('', 'Sphinx'),
('', 'Sphinx::version'), ('', 'Sphinx::version'),
@ -1259,7 +1259,7 @@ def test_domain_cpp_build_with_add_function_parentheses_is_False(app, status, wa
res = re.search(pattern, text) res = re.search(pattern, text)
if not res: if not res:
print(f"Pattern\n\t{pattern}\nnot found in {file}") print(f"Pattern\n\t{pattern}\nnot found in {file}")
raise AssertionError() raise AssertionError
rolePatterns = [ rolePatterns = [
('', 'Sphinx'), ('', 'Sphinx'),
('', 'Sphinx::version'), ('', 'Sphinx::version'),