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

Remove unneeded noqa lint suppression comments (#10772)

Browse Source
This commit is contained in:
danieleades 2022-08-28 20:03:17 +01:00 committed by GitHub
parent 2b02173617
commit 12bff8a273
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/builders/_epub_base.py
View File

@ -464,7 +464,7 @@ class EpubBuilder(StandaloneHTMLBuilder):
logger.info(__('writing mimetype file...'))
copy_asset_file(path.join(self.template_dir, 'mimetype'), self.outdir)
def build_container(self, outname: str = 'META-INF/container.xml') -> None: # NOQA
def build_container(self, outname: str = 'META-INF/container.xml') -> None:
"""Write the metainfo file META-INF/container.xml."""
logger.info(__('writing META-INF/container.xml file...'))
outdir = path.join(self.outdir, 'META-INF')

2
sphinx/domains/c.py
View File

@ -1959,7 +1959,7 @@ class Symbol:
if Symbol.debug_lookup:
Symbol.debug_print(
"no match, but fill an empty declaration, candSybmol is not None?:",
candSymbol is not None) # NOQA
candSymbol is not None)
Symbol.debug_indent -= 2
if candSymbol is not None:
candSymbol.remove()

2
sphinx/ext/graphviz.py
View File

@ -224,7 +224,7 @@ def render_dot(self: SphinxTranslator, code: str, options: Dict, format: str,
return relfn, outfn
if (hasattr(self.builder, '_graphviz_warned_dot') and
self.builder._graphviz_warned_dot.get(graphviz_dot)): # type: ignore # NOQA
self.builder._graphviz_warned_dot.get(graphviz_dot)): # type: ignore
return None, None
ensuredir(path.dirname(outfn))

2
sphinx/transforms/__init__.py
View File

@ -389,7 +389,7 @@ class ManpageLink(SphinxTransform):
for node in self.document.findall(addnodes.manpage):
manpage = ' '.join([str(x) for x in node.children
if isinstance(x, nodes.Text)])
pattern = r'^(?P<path>(?P<page>.+)[\(\.](?P<section>[1-9]\w*)?\)?)$' # noqa
pattern = r'^(?P<path>(?P<page>.+)[\(\.](?P<section>[1-9]\w*)?\)?)$'
info = {'path': manpage,
'page': manpage,
'section': ''}

2
sphinx/util/docutils.py
View File

@ -18,7 +18,7 @@ from docutils.parsers.rst import Directive, directives, roles
from docutils.parsers.rst.states import Inliner
from docutils.statemachine import State, StateMachine, StringList
from docutils.utils import Reporter, unescape
from docutils.writers._html_base import HTMLTranslator # NoQA
from docutils.writers._html_base import HTMLTranslator
from sphinx.deprecation import RemovedInSphinx70Warning, deprecated_alias
from sphinx.errors import SphinxError

2
sphinx/writers/texinfo.py
View File

@ -180,7 +180,7 @@ class TexinfoTranslator(SphinxTranslator):
self.escape_newlines = 0
self.escape_hyphens = 0
self.curfilestack: List[str] = []
self.footnotestack: List[Dict[str, List[Union[collected_footnote, bool]]]] = [] # NOQA
self.footnotestack: List[Dict[str, List[Union[collected_footnote, bool]]]] = []
self.in_footnote = 0
self.in_samp = 0
self.handled_abbrs: Set[str] = set()

4
tests/roots/test-ext-autodoc/autodoc_dummy_module.py
View File

@ -1,6 +1,6 @@
from dummy import * # NOQA
from dummy import *
def test():
"""Dummy function using dummy.*"""
dummy_function() # NOQA
dummy_function()

2
tests/roots/test-ext-autodoc/target/__init__.py
View File

@ -1,7 +1,7 @@
import enum
from io import StringIO
from sphinx.util import save_traceback # NOQA
from sphinx.util import save_traceback
__all__ = ['Class']

2
tests/roots/test-ext-autodoc/target/coroutine.py
View File

@ -5,7 +5,7 @@ from functools import wraps
class AsyncClass:
async def do_coroutine(self):
"""A documented coroutine function"""
attr_coro_result = await _other_coro_func() # NOQA
attr_coro_result = await _other_coro_func()
@classmethod
async def do_coroutine2(cls):

14
tests/roots/test-ext-autodoc/target/need_mocks.py
View File

@ -1,12 +1,12 @@
import missing_module # NOQA
import missing_package1.missing_module1 # NOQA
from missing_module import missing_name # NOQA
from missing_package2 import missing_module2 # NOQA
from missing_package3.missing_module3 import missing_name # NOQA
import missing_module
import missing_package1.missing_module1
from missing_module import missing_name
from missing_package2 import missing_module2
from missing_package3.missing_module3 import missing_name
import sphinx.missing_module4 # NOQA
from sphinx.missing_module4 import missing_name2 # NOQA
import sphinx.missing_module4
from sphinx.missing_module4 import missing_name2
@missing_name(int)

2
tests/roots/test-ext-autosummary-filename-map/autosummary_dummy_module.py
View File

@ -1,4 +1,4 @@
from os import path # NOQA
from os import path
from typing import Union

2
tests/roots/test-ext-autosummary-recursive/package/module.py
View File

@ -1,4 +1,4 @@
from os import * # NOQA
from os import *
class Foo:

2
tests/roots/test-ext-autosummary-recursive/package/package/module.py
View File

@ -1,4 +1,4 @@
from os import * # NOQA
from os import *
class Foo:

2
tests/roots/test-ext-autosummary-recursive/package2/module.py
View File

@ -1,4 +1,4 @@
from os import * # NOQA
from os import *
class Foo:

2
tests/roots/test-ext-autosummary/autosummary_dummy_module.py
View File

@ -1,4 +1,4 @@
from os import path # NOQA
from os import path
from typing import Union
from autosummary_class_module import Class

2
tests/roots/test-ext-viewcode-find/not_a_package/__init__.py
View File

@ -1 +1 @@
from .submodule import Class1, func1 # NOQA
from .submodule import Class1, func1

2
tests/roots/test-ext-viewcode/conf.py
View File

@ -8,7 +8,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
exclude_patterns = ['_build']
if 'test_linkcode' in tags: # NOQA
if 'test_linkcode' in tags:
extensions.remove('sphinx.ext.viewcode')
extensions.append('sphinx.ext.linkcode')

4
tests/roots/test-ext-viewcode/spam/__init__.py
View File

@ -1,2 +1,2 @@
from .mod1 import Class1, func1 # NOQA
from .mod2 import Class2, func2 # NOQA
from .mod1 import Class1, func1
from .mod2 import Class2, func2

2
tests/roots/test-root/conf.py
View File

@ -46,7 +46,7 @@ extlinks = {'issue': ('http://bugs.python.org/issue%s', 'issue %s'),
'pyurl': ('http://python.org/%s', None)}
# modify tags from conf.py
tags.add('confpytag') # NOQA
tags.add('confpytag')
# -- extension API

8
tests/test_domain_py.py
View File

@ -1342,8 +1342,8 @@ def test_module_index(app):
assert index.generate() == (
[('d', [IndexEntry('docutils', 0, 'index', 'module-docutils', '', '', '')]),
('s', [IndexEntry('sphinx', 1, 'index', 'module-sphinx', '', '', ''),
IndexEntry('sphinx.builders', 2, 'index', 'module-sphinx.builders', '', '', ''), # NOQA
IndexEntry('sphinx.builders.html', 2, 'index', 'module-sphinx.builders.html', '', '', ''), # NOQA
IndexEntry('sphinx.builders', 2, 'index', 'module-sphinx.builders', '', '', ''),
IndexEntry('sphinx.builders.html', 2, 'index', 'module-sphinx.builders.html', '', '', ''),
IndexEntry('sphinx.config', 2, 'index', 'module-sphinx.config', '', '', ''),
IndexEntry('sphinx_intl', 0, 'index', 'module-sphinx_intl', '', '', '')])],
False
@ -1386,8 +1386,8 @@ def test_modindex_common_prefix(app):
restructuredtext.parse(app, text)
index = PythonModuleIndex(app.env.get_domain('py'))
assert index.generate() == (
[('b', [IndexEntry('sphinx.builders', 1, 'index', 'module-sphinx.builders', '', '', ''), # NOQA
IndexEntry('sphinx.builders.html', 2, 'index', 'module-sphinx.builders.html', '', '', '')]), # NOQA
[('b', [IndexEntry('sphinx.builders', 1, 'index', 'module-sphinx.builders', '', '', ''),
IndexEntry('sphinx.builders.html', 2, 'index', 'module-sphinx.builders.html', '', '', '')]),
('c', [IndexEntry('sphinx.config', 0, 'index', 'module-sphinx.config', '', '', '')]),
('d', [IndexEntry('docutils', 0, 'index', 'module-docutils', '', '', '')]),
('s', [IndexEntry('sphinx', 0, 'index', 'module-sphinx', '', '', ''),

2
tests/test_ext_autodoc.py
View File

@ -363,7 +363,7 @@ def test_get_doc(app):
# verify that method docstrings get extracted in both normal case
# and in case of bound method posing as a function
class J: # NOQA
class J:
def foo(self):
"""Method docstring"""
assert getdocl('method', J.foo) == ['Method docstring']

14
tests/test_util_inspect.py
View File

@ -649,12 +649,12 @@ def test_isattributedescriptor(app):
assert inspect.isattributedescriptor(Base.meth) is False # method
assert inspect.isattributedescriptor(Base.staticmeth) is False # staticmethod
assert inspect.isattributedescriptor(Base.classmeth) is False # classmetho
assert inspect.isattributedescriptor(Descriptor) is False # custom descriptor class # NOQA
assert inspect.isattributedescriptor(str.join) is False # MethodDescriptorType # NOQA
assert inspect.isattributedescriptor(object.__init__) is False # WrapperDescriptorType # NOQA
assert inspect.isattributedescriptor(dict.__dict__['fromkeys']) is False # ClassMethodDescriptorType # NOQA
assert inspect.isattributedescriptor(types.FrameType.f_locals) is True # GetSetDescriptorType # NOQA
assert inspect.isattributedescriptor(datetime.timedelta.days) is True # MemberDescriptorType # NOQA
assert inspect.isattributedescriptor(Descriptor) is False # custom descriptor class
assert inspect.isattributedescriptor(str.join) is False # MethodDescriptorType
assert inspect.isattributedescriptor(object.__init__) is False # WrapperDescriptorType
assert inspect.isattributedescriptor(dict.__dict__['fromkeys']) is False # ClassMethodDescriptorType
assert inspect.isattributedescriptor(types.FrameType.f_locals) is True # GetSetDescriptorType
assert inspect.isattributedescriptor(datetime.timedelta.days) is True # MemberDescriptorType
try:
# _testcapi module cannot be importable in some distro
@ -662,7 +662,7 @@ def test_isattributedescriptor(app):
import _testcapi
testinstancemethod = _testcapi.instancemethod(str.__repr__)
assert inspect.isattributedescriptor(testinstancemethod) is False # instancemethod (C-API) # NOQA
assert inspect.isattributedescriptor(testinstancemethod) is False # instancemethod (C-API)
except ImportError:
pass

4
tests/test_util_typing.py
View File

@ -320,8 +320,8 @@ def test_stringify_type_hints_pep_585():
@pytest.mark.skipif(sys.version_info < (3, 9), reason='python 3.9+ is required.')
def test_stringify_Annotated():
from typing import Annotated # type: ignore
assert stringify(Annotated[str, "foo", "bar"]) == "str" # NOQA
assert stringify(Annotated[str, "foo", "bar"], "smart") == "str" # NOQA
assert stringify(Annotated[str, "foo", "bar"]) == "str"
assert stringify(Annotated[str, "foo", "bar"], "smart") == "str"
def test_stringify_type_hints_string():

2
utils/babel_runner.py
View File

@ -26,7 +26,7 @@ import sphinx
ROOT = os.path.realpath(os.path.join(os.path.abspath(__file__), "..", ".."))
class compile_catalog_plusjs(compile_catalog): # NoQA
class compile_catalog_plusjs(compile_catalog):
"""
An extended command that writes all message strings that occur in
JavaScript files to a JavaScript file along with the .mo file.