diff --git a/tests/conftest.py b/tests/conftest.py index 67560d009..eef0cb185 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -10,9 +10,9 @@ import os import shutil import sys -import warnings import pytest + from sphinx.testing.path import path pytest_plugins = 'sphinx.testing.fixtures' diff --git a/tests/py35/test_autodoc_py35.py b/tests/py35/test_autodoc_py35.py index 439ebd67a..51a9ef1ff 100644 --- a/tests/py35/test_autodoc_py35.py +++ b/tests/py35/test_autodoc_py35.py @@ -11,16 +11,15 @@ """ # "raises" imported for usage by autodoc -import six import sys -from sphinx.testing.util import SphinxTestApp, Struct + import pytest - -from six import StringIO +import six from docutils.statemachine import ViewList +from six import StringIO -from sphinx.ext.autodoc import AutoDirective, add_documenter, \ - ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL +from sphinx.ext.autodoc import add_documenter, FunctionDocumenter, ALL # NOQA +from sphinx.testing.util import SphinxTestApp, Struct from sphinx.util import logging app = None @@ -279,8 +278,8 @@ class Base(object): def inheritedmeth(self): """Inherited function.""" -if six.PY3 and sys.version_info[:2] >= (3, 5): +if six.PY3 and sys.version_info[:2] >= (3, 5): async def _other_coro_func(): return "run" @@ -345,5 +344,4 @@ class Class(Base): async def do_coroutine(self): """A documented coroutine function""" - - attr_coro_result = await _other_coro_func() + attr_coro_result = await _other_coro_func() # NOQA diff --git a/tests/roots/test-add_enumerable_node/enumerable_node.py b/tests/roots/test-add_enumerable_node/enumerable_node.py index eb6381fad..1338c9125 100644 --- a/tests/roots/test-add_enumerable_node/enumerable_node.py +++ b/tests/roots/test-add_enumerable_node/enumerable_node.py @@ -2,7 +2,6 @@ from docutils import nodes from docutils.parsers.rst import Directive -from sphinx.util.nodes import split_explicit_title class my_figure(nodes.figure): diff --git a/tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py b/tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py index c50c0d2df..6f493c3a3 100644 --- a/tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py +++ b/tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py @@ -2,6 +2,7 @@ import os import sys + from docutils.parsers import Parser sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-add_source_parser/conf.py b/tests/roots/test-add_source_parser/conf.py index 5fc0c63d2..805f80fcc 100644 --- a/tests/roots/test-add_source_parser/conf.py +++ b/tests/roots/test-add_source_parser/conf.py @@ -2,6 +2,7 @@ import os import sys + from docutils.parsers import Parser sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-api-set-translator/conf.py b/tests/roots/test-api-set-translator/conf.py index 3c1606646..c1ad24e56 100644 --- a/tests/roots/test-api-set-translator/conf.py +++ b/tests/roots/test-api-set-translator/conf.py @@ -1,16 +1,17 @@ # -*- coding: utf-8 -*- -## set this by test +# set this by test # import os # import sys # sys.path.insert(0, os.path.abspath('.')) +from docutils.writers.docutils_xml import XMLTranslator + from sphinx.writers.html import HTMLTranslator from sphinx.writers.latex import LaTeXTranslator from sphinx.writers.manpage import ManualPageTranslator from sphinx.writers.texinfo import TexinfoTranslator from sphinx.writers.text import TextTranslator from sphinx.writers.websupport import WebSupportTranslator -from docutils.writers.docutils_xml import XMLTranslator project = 'test' diff --git a/tests/roots/test-api-set-translator/translator.py b/tests/roots/test-api-set-translator/translator.py index 015b4aa23..9be1c7add 100644 --- a/tests/roots/test-api-set-translator/translator.py +++ b/tests/roots/test-api-set-translator/translator.py @@ -2,5 +2,6 @@ from sphinx.writers.html import HTMLTranslator + class ExtHTMLTranslator(HTMLTranslator): pass diff --git a/tests/roots/test-apidoc-toc/mypackage/main.py b/tests/roots/test-apidoc-toc/mypackage/main.py index 5d3da04b9..b3fa386fc 100755 --- a/tests/roots/test-apidoc-toc/mypackage/main.py +++ b/tests/roots/test-apidoc-toc/mypackage/main.py @@ -2,7 +2,6 @@ import os import mod_resource - import mod_something diff --git a/tests/roots/test-apidoc-toc/mypackage/no_init/foo.py b/tests/roots/test-apidoc-toc/mypackage/no_init/foo.py index ce059b276..ece50cbef 100644 --- a/tests/roots/test-apidoc-toc/mypackage/no_init/foo.py +++ b/tests/roots/test-apidoc-toc/mypackage/no_init/foo.py @@ -1 +1 @@ -MESSAGE="There's no __init__.py in this folder, hence we should be left out" +MESSAGE = "There's no __init__.py in this folder, hence we should be left out" diff --git a/tests/roots/test-apidoc-toc/mypackage/something/__init__.py b/tests/roots/test-apidoc-toc/mypackage/something/__init__.py index 259184ba3..6401e43ec 100644 --- a/tests/roots/test-apidoc-toc/mypackage/something/__init__.py +++ b/tests/roots/test-apidoc-toc/mypackage/something/__init__.py @@ -1 +1 @@ -"Subpackage Something" \ No newline at end of file +"Subpackage Something" diff --git a/tests/roots/test-apidoc-trailing-underscore/package_/module_.py b/tests/roots/test-apidoc-trailing-underscore/package_/module_.py index 9902551ee..e16461c21 100644 --- a/tests/roots/test-apidoc-trailing-underscore/package_/module_.py +++ b/tests/roots/test-apidoc-trailing-underscore/package_/module_.py @@ -1,7 +1,9 @@ """ A module with a trailing underscore """ + class SomeClass_: """ A class with a trailing underscore """ + def some_function_(some_arg_): """ A function with a trailing underscore in name and argument """ diff --git a/tests/roots/test-autosummary/conf.py b/tests/roots/test-autosummary/conf.py index 5cb589cda..46cf4fa1a 100644 --- a/tests/roots/test-autosummary/conf.py +++ b/tests/roots/test-autosummary/conf.py @@ -1,4 +1,5 @@ -import sys, os +import os +import sys sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-autosummary/dummy_module.py b/tests/roots/test-autosummary/dummy_module.py index d24d7604f..93d482b59 100644 --- a/tests/roots/test-autosummary/dummy_module.py +++ b/tests/roots/test-autosummary/dummy_module.py @@ -8,6 +8,7 @@ C.C2 """ + def withSentence(): '''I have a sentence which spans multiple lines. Then I have @@ -15,6 +16,7 @@ def withSentence(): ''' pass + def noSentence(): '''this doesn't start with a capital. so it's not considered @@ -22,6 +24,7 @@ def noSentence(): ''' pass + def emptyLine(): '''This is the real summary diff --git a/tests/roots/test-autosummary/underscore_module_.py b/tests/roots/test-autosummary/underscore_module_.py index c3da50542..c18697cd2 100644 --- a/tests/roots/test-autosummary/underscore_module_.py +++ b/tests/roots/test-autosummary/underscore_module_.py @@ -1,12 +1,15 @@ """ module with trailing underscores everywhere """ + + class class_(object): """ Class """ def method_(_arg): """ Method """ pass + def function_(_arg): """ Function """ pass diff --git a/tests/roots/test-config/conf.py b/tests/roots/test-config/conf.py index 1e583d1e0..4c2ea9fc5 100644 --- a/tests/roots/test-config/conf.py +++ b/tests/roots/test-config/conf.py @@ -8,13 +8,19 @@ value5 = 3 # parent type value6 = () # other sequence type, also raises value7 = ['foo'] # explicitly permitted + class A(object): pass + + class B(A): pass + + class C(A): pass + value8 = C() # sibling type # both have no default or permissible types diff --git a/tests/roots/test-correct-year/conf.py b/tests/roots/test-correct-year/conf.py index 9b554aabe..4cb2912f5 100644 --- a/tests/roots/test-correct-year/conf.py +++ b/tests/roots/test-correct-year/conf.py @@ -1,3 +1,2 @@ copyright = u'2006-2009, Author' - diff --git a/tests/roots/test-directive-code/conf.py b/tests/roots/test-directive-code/conf.py index 6601c76a9..aac0bc36a 100644 --- a/tests/roots/test-directive-code/conf.py +++ b/tests/roots/test-directive-code/conf.py @@ -3,4 +3,3 @@ master_doc = 'index' exclude_patterns = ['_build'] numfig = True - diff --git a/tests/roots/test-double-inheriting-theme/conf.py b/tests/roots/test-double-inheriting-theme/conf.py index 1d7de0e6d..0ca019838 100644 --- a/tests/roots/test-double-inheriting-theme/conf.py +++ b/tests/roots/test-double-inheriting-theme/conf.py @@ -1,7 +1,5 @@ # -*- coding: utf-8 -*- -import sys, os - templates_path = ['_templates'] master_doc = 'index' html_theme = 'base_theme2' diff --git a/tests/roots/test-ext-autodoc/autodoc_dummy_bar.py b/tests/roots/test-ext-autodoc/autodoc_dummy_bar.py index d79d1691f..151818b36 100644 --- a/tests/roots/test-ext-autodoc/autodoc_dummy_bar.py +++ b/tests/roots/test-ext-autodoc/autodoc_dummy_bar.py @@ -1,5 +1,6 @@ from bug2437.autodoc_dummy_foo import Foo + class Bar(object): """Dummy class Bar with alias.""" my_name = Foo diff --git a/tests/roots/test-ext-autodoc/autodoc_dummy_module.py b/tests/roots/test-ext-autodoc/autodoc_dummy_module.py index c05d96e0d..5cc427ea4 100644 --- a/tests/roots/test-ext-autodoc/autodoc_dummy_module.py +++ b/tests/roots/test-ext-autodoc/autodoc_dummy_module.py @@ -1,6 +1,6 @@ -from dummy import * +from dummy import * # NOQA def test(): """Dummy function using dummy.*""" - dummy_function() + dummy_function() # NOQA diff --git a/tests/roots/test-ext-autodoc/conf.py b/tests/roots/test-ext-autodoc/conf.py index 9f026eb8d..979a70983 100644 --- a/tests/roots/test-ext-autodoc/conf.py +++ b/tests/roots/test-ext-autodoc/conf.py @@ -1,4 +1,5 @@ -import sys, os +import os +import sys sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-ext-autodoc/target/__init__.py b/tests/roots/test-ext-autodoc/target/__init__.py index b657f595f..2452d3d89 100644 --- a/tests/roots/test-ext-autodoc/target/__init__.py +++ b/tests/roots/test-ext-autodoc/target/__init__.py @@ -1,7 +1,9 @@ # -*- coding: utf-8 -*- import enum + from six import StringIO, add_metaclass + from sphinx.ext.autodoc import add_documenter # NOQA diff --git a/tests/roots/test-ext-autosummary/autosummary_dummy_module.py b/tests/roots/test-ext-autosummary/autosummary_dummy_module.py index c76e73302..5506d0bc9 100644 --- a/tests/roots/test-ext-autosummary/autosummary_dummy_module.py +++ b/tests/roots/test-ext-autosummary/autosummary_dummy_module.py @@ -1,4 +1,4 @@ -from os import * +from os import * # NOQA class Foo: diff --git a/tests/roots/test-ext-autosummary/conf.py b/tests/roots/test-ext-autosummary/conf.py index f4d696cc9..55c769c6f 100644 --- a/tests/roots/test-ext-autosummary/conf.py +++ b/tests/roots/test-ext-autosummary/conf.py @@ -1,4 +1,5 @@ -import sys, os +import os +import sys sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-ext-doctest-with-autodoc/conf.py b/tests/roots/test-ext-doctest-with-autodoc/conf.py index 1b8773f6f..a5d0d622d 100644 --- a/tests/roots/test-ext-doctest-with-autodoc/conf.py +++ b/tests/roots/test-ext-doctest-with-autodoc/conf.py @@ -1,5 +1,5 @@ -from os import path import sys +from os import path sys.path.insert(0, path.abspath(path.dirname(__file__))) diff --git a/tests/roots/test-ext-ifconfig/conf.py b/tests/roots/test-ext-ifconfig/conf.py index d205fe9f5..dc3c93b22 100644 --- a/tests/roots/test-ext-ifconfig/conf.py +++ b/tests/roots/test-ext-ifconfig/conf.py @@ -6,6 +6,7 @@ exclude_patterns = ['_build'] confval1 = True + def setup(app): app.add_config_value('confval1', False, None) app.add_config_value('confval2', False, None) diff --git a/tests/roots/test-ext-viewcode/conf.py b/tests/roots/test-ext-viewcode/conf.py index c2b358fb5..08522791b 100644 --- a/tests/roots/test-ext-viewcode/conf.py +++ b/tests/roots/test-ext-viewcode/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- -import sys import os +import sys sys.path.insert(0, os.path.abspath('.')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] @@ -9,7 +9,7 @@ master_doc = 'index' exclude_patterns = ['_build'] -if 'test_linkcode' in tags: +if 'test_linkcode' in tags: # NOQA extensions.remove('sphinx.ext.viewcode') extensions.append('sphinx.ext.linkcode') diff --git a/tests/roots/test-ext-viewcode/spam/__init__.py b/tests/roots/test-ext-viewcode/spam/__init__.py index 2c8603c1e..dffa85b91 100644 --- a/tests/roots/test-ext-viewcode/spam/__init__.py +++ b/tests/roots/test-ext-viewcode/spam/__init__.py @@ -1,7 +1,4 @@ from __future__ import absolute_import -from .mod1 import func1, Class1 -from .mod2 import ( - func2, - Class2, -) +from .mod1 import func1, Class1 # NOQA +from .mod2 import func2, Class2 # NOQA diff --git a/tests/roots/test-ext-viewcode/spam/mod1.py b/tests/roots/test-ext-viewcode/spam/mod1.py index f876d0134..22cc1a0de 100644 --- a/tests/roots/test-ext-viewcode/spam/mod1.py +++ b/tests/roots/test-ext-viewcode/spam/mod1.py @@ -2,9 +2,11 @@ mod1 """ + def decorator(f): return f + @decorator def func1(a, b): """ @@ -19,6 +21,7 @@ class Class1(object): this is Class1 """ + class Class3(object): """ this is Class3 diff --git a/tests/roots/test-ext-viewcode/spam/mod2.py b/tests/roots/test-ext-viewcode/spam/mod2.py index 5953c94fe..92d196177 100644 --- a/tests/roots/test-ext-viewcode/spam/mod2.py +++ b/tests/roots/test-ext-viewcode/spam/mod2.py @@ -2,9 +2,11 @@ mod2 """ + def decorator(f): return f + @decorator def func2(a, b): """ diff --git a/tests/roots/test-image-in-parsed-literal/conf.py b/tests/roots/test-image-in-parsed-literal/conf.py index d208b8385..6c2d881a0 100644 --- a/tests/roots/test-image-in-parsed-literal/conf.py +++ b/tests/roots/test-image-in-parsed-literal/conf.py @@ -10,4 +10,3 @@ rst_epilog = ''' :align: middle :alt: alternative_text ''' - diff --git a/tests/roots/test-image-in-section/conf.py b/tests/roots/test-image-in-section/conf.py index 7da44fdae..77f31b515 100644 --- a/tests/roots/test-image-in-section/conf.py +++ b/tests/roots/test-image-in-section/conf.py @@ -9,4 +9,3 @@ rst_epilog = ''' :height: 15pt :alt: alternative_text ''' - diff --git a/tests/roots/test-inheritance/conf.py b/tests/roots/test-inheritance/conf.py index f1ddb4ad6..26cadca50 100644 --- a/tests/roots/test-inheritance/conf.py +++ b/tests/roots/test-inheritance/conf.py @@ -1,4 +1,5 @@ -import sys, os +import os +import sys sys.path.insert(0, os.path.abspath('.')) diff --git a/tests/roots/test-inheritance/dummy/test.py b/tests/roots/test-inheritance/dummy/test.py index cafa07886..318a3ed42 100644 --- a/tests/roots/test-inheritance/dummy/test.py +++ b/tests/roots/test-inheritance/dummy/test.py @@ -10,21 +10,26 @@ """ + class A(object): pass + class B(A): pass + class C(A): pass + class D(B, C): pass + class E(B): pass + class F(C): pass - diff --git a/tests/roots/test-maxlistdepth/conf.py b/tests/roots/test-maxlistdepth/conf.py index 5a43b67bf..41d8a201e 100644 --- a/tests/roots/test-maxlistdepth/conf.py +++ b/tests/roots/test-maxlistdepth/conf.py @@ -5,9 +5,9 @@ html_theme = 'classic' exclude_patterns = ['_build'] latex_documents = [ - ('index', 'SphinxTests.tex', 'Testing maxlistdepth=10', - 'Georg Brandl', 'howto'), - ] + ('index', 'SphinxTests.tex', 'Testing maxlistdepth=10', + 'Georg Brandl', 'howto'), +] latex_elements = { 'maxlistdepth': '10', diff --git a/tests/roots/test-root/autodoc_missing_imports.py b/tests/roots/test-root/autodoc_missing_imports.py index 19d4c6a05..4f83579a4 100644 --- a/tests/roots/test-root/autodoc_missing_imports.py +++ b/tests/roots/test-root/autodoc_missing_imports.py @@ -1,16 +1,19 @@ -import missing_module -from missing_module import missing_name -import missing_package1.missing_module1 -from missing_package2 import missing_module2 -from missing_package3.missing_module3 import missing_name -import sphinx.missing_module4 -from sphinx.missing_module4 import missing_name2 +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 sphinx.missing_module4 # NOQA +from sphinx.missing_module4 import missing_name2 # NOQA + @missing_name def decoratedFunction(): - """decoratedFunction docstring""" - return None + """decoratedFunction docstring""" + return None + class TestAutodoc(object): """TestAutodoc docstring.""" @@ -19,4 +22,5 @@ class TestAutodoc(object): """TestAutodoc::decoratedMethod docstring""" return None + sphinx.missing_module4.missing_function(len(missing_name2)) diff --git a/tests/roots/test-root/autodoc_target.py b/tests/roots/test-root/autodoc_target.py index bd00bf183..62ca9f691 100644 --- a/tests/roots/test-root/autodoc_target.py +++ b/tests/roots/test-root/autodoc_target.py @@ -1,7 +1,9 @@ # -*- coding: utf-8 -*- import enum + from six import StringIO, add_metaclass + from sphinx.ext.autodoc import add_documenter # NOQA diff --git a/tests/roots/test-root/conf.py b/tests/roots/test-root/conf.py index 04cd87d7b..e2d8928fe 100644 --- a/tests/roots/test-root/conf.py +++ b/tests/roots/test-root/conf.py @@ -1,6 +1,13 @@ # -*- coding: utf-8 -*- -import sys, os +import os +import sys + +from docutils import nodes +from docutils.parsers.rst import Directive + +from sphinx import addnodes + sys.path.append(os.path.abspath('.')) @@ -76,15 +83,10 @@ autodoc_mock_imports = [ ] # modify tags from conf.py -tags.add('confpytag') +tags.add('confpytag') # NOQA + # -- extension API - -from docutils import nodes -from docutils.parsers.rst import Directive -from sphinx import addnodes - - def userdesc_parse(env, sig, signode): x, y = sig.split(':') signode += addnodes.desc_name(x, x) diff --git a/tests/roots/test-root/ext.py b/tests/roots/test-root/ext.py index 34a73cb86..5665bea90 100644 --- a/tests/roots/test-root/ext.py +++ b/tests/roots/test-root/ext.py @@ -1,4 +1,5 @@ # Test extension module + def setup(app): app.add_config_value('value_from_ext', [], False) diff --git a/tests/roots/test-root/parsermod.py b/tests/roots/test-root/parsermod.py index 3e5330ac8..dfc699944 100644 --- a/tests/roots/test-root/parsermod.py +++ b/tests/roots/test-root/parsermod.py @@ -1,5 +1,5 @@ -from docutils.parsers import Parser from docutils import nodes +from docutils.parsers import Parser class Parser(Parser): diff --git a/tests/roots/test-setup/setup.py b/tests/roots/test-setup/setup.py index 3ba5b6f05..3cd86415a 100644 --- a/tests/roots/test-setup/setup.py +++ b/tests/roots/test-setup/setup.py @@ -1,4 +1,5 @@ from distutils.core import setup + from sphinx.setup_command import BuildDoc cmdclass = {'build_sphinx': BuildDoc} diff --git a/tests/roots/test-stylesheets/conf.py b/tests/roots/test-stylesheets/conf.py index 208ca8243..0696e35c2 100644 --- a/tests/roots/test-stylesheets/conf.py +++ b/tests/roots/test-stylesheets/conf.py @@ -4,9 +4,9 @@ master_doc = 'index' html_theme = 'classic' templates_path = ['_templates'] + def setup(app): app.add_stylesheet('persistent.css') app.add_stylesheet('default.css', title="Default") app.add_stylesheet('alternate1.css', title="Alternate", alternate=True) app.add_stylesheet('alternate2.css', alternate=True) - diff --git a/tests/roots/test-templating/conf.py b/tests/roots/test-templating/conf.py index ff8207454..4a21054ed 100644 --- a/tests/roots/test-templating/conf.py +++ b/tests/roots/test-templating/conf.py @@ -9,4 +9,3 @@ exclude_patterns = ['_build'] extensions = ['sphinx.ext.autosummary'] autosummary_generate = ['autosummary_templating'] - diff --git a/tests/roots/test-theming/conf.py b/tests/roots/test-theming/conf.py index ca62a94e3..15911eb3a 100644 --- a/tests/roots/test-theming/conf.py +++ b/tests/roots/test-theming/conf.py @@ -4,4 +4,3 @@ html_theme = 'test-theme' html_theme_path = ['.', 'test_theme'] master_doc = 'index' exclude_patterns = ['_build'] - diff --git a/tests/roots/test-theming/setup.py b/tests/roots/test-theming/setup.py index 34299647d..77a5ada13 100644 --- a/tests/roots/test-theming/setup.py +++ b/tests/roots/test-theming/setup.py @@ -4,13 +4,11 @@ from setuptools import setup, find_packages setup( - name='test-theme', - packages=find_packages(), - include_package_data=True, - entry_points=""" - [sphinx_themes] - path = test_theme:get_path - """, + name='test-theme', + packages=find_packages(), + include_package_data=True, + entry_points=""" + [sphinx_themes] + path = test_theme:get_path + """, ) - - diff --git a/tests/roots/test-theming/test_theme/__init__.py b/tests/roots/test-theming/test_theme/__init__.py index 2d63e888f..3474a8289 100644 --- a/tests/roots/test-theming/test_theme/__init__.py +++ b/tests/roots/test-theming/test_theme/__init__.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- import os + def get_path(): return os.path.dirname(os.path.abspath(__file__)) diff --git a/tests/test_application.py b/tests/test_application.py index c4c2e579b..075acc80c 100644 --- a/tests/test_application.py +++ b/tests/test_application.py @@ -8,14 +8,13 @@ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ +import pytest from docutils import nodes from sphinx.application import ExtensionError from sphinx.domains import Domain -from sphinx.util import logging - from sphinx.testing.util import strip_escseq -import pytest +from sphinx.util import logging def test_events(app, status, warning): diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index 7de5a2910..4025beaa9 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -11,15 +11,14 @@ """ import sys -from six import PY3 -from sphinx.testing.util import SphinxTestApp, Struct # NOQA import pytest - from docutils.statemachine import ViewList +from six import PY3 from sphinx.ext.autodoc import AutoDirective, add_documenter, \ ModuleLevelDocumenter, FunctionDocumenter, cut_lines, between, ALL +from sphinx.testing.util import SphinxTestApp, Struct # NOQA from sphinx.util import logging app = None diff --git a/tests/test_build.py b/tests/test_build.py index 30237c2e0..47d76b2a2 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -10,13 +10,14 @@ """ import pickle -from docutils import nodes +import sys +from textwrap import dedent + import mock import pytest -from textwrap import dedent -from sphinx.errors import SphinxError -import sys +from docutils import nodes +from sphinx.errors import SphinxError from sphinx.testing.path import path diff --git a/tests/test_build_applehelp.py b/tests/test_build_applehelp.py index 31d4ca4df..ed0022ce1 100644 --- a/tests/test_build_applehelp.py +++ b/tests/test_build_applehelp.py @@ -14,6 +14,7 @@ import plistlib import pytest + from sphinx.testing.path import path # Use plistlib.load in 3.4 and above diff --git a/tests/test_build_gettext.py b/tests/test_build_gettext.py index 58ac7409c..18731855f 100644 --- a/tests/test_build_gettext.py +++ b/tests/test_build_gettext.py @@ -10,9 +10,9 @@ """ from __future__ import print_function +import gettext import os import re -import gettext from subprocess import Popen, PIPE import pytest diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 184bddd94..cdbdafe27 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -11,15 +11,15 @@ import os import re +import xml.etree.cElementTree as ElementTree from itertools import cycle, chain +import pytest +from html5lib import getTreeBuilder, HTMLParser from six import PY3 -from sphinx.util.inventory import InventoryFile from sphinx.testing.util import remove_unicode_literals, strip_escseq -import xml.etree.cElementTree as ElementTree -from html5lib import getTreeBuilder, HTMLParser -import pytest +from sphinx.util.inventory import InventoryFile TREE_BUILDER = getTreeBuilder('etree', implementation=ElementTree) @@ -1251,7 +1251,8 @@ def test_html_sidebar(app, status, warning): 'index.html': [(".//em/a[@href='https://example.com/man.1']", "", True), (".//em/a[@href='https://example.com/ls.1']", "", True), (".//em/a[@href='https://example.com/sphinx.']", "", True)] - })) + +})) @pytest.mark.sphinx('html', testroot='manpage_url', confoverrides={ 'manpages_url': 'https://example.com/{page}.{section}'}) @pytest.mark.test_params(shared_result='test_build_html_manpage_url') diff --git a/tests/test_build_html5.py b/tests/test_build_html5.py index ec8885116..6f0338113 100644 --- a/tests/test_build_html5.py +++ b/tests/test_build_html5.py @@ -18,11 +18,10 @@ import xml.etree.cElementTree as ElementTree import pytest from html5lib import getTreeBuilder, HTMLParser +from test_build_html import flat_dict, tail_check, check_xpath from sphinx.util.docutils import is_html5_writer_available -from test_build_html import flat_dict, tail_check, check_xpath - TREE_BUILDER = getTreeBuilder('etree', implementation=ElementTree) HTML_PARSER = HTMLParser(TREE_BUILDER, namespaceHTMLElements=False) diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py index 294c4fc0d..4b02b7c54 100644 --- a/tests/test_build_latex.py +++ b/tests/test_build_latex.py @@ -13,19 +13,18 @@ from __future__ import print_function import os import re from itertools import product -from subprocess import Popen, PIPE from shutil import copyfile +from subprocess import Popen, PIPE -from six import PY3 import pytest +from six import PY3 +from test_build_html import ENV_WARNINGS from sphinx.errors import SphinxError -from sphinx.util.osutil import cd, ensuredir -from sphinx.util import docutils -from sphinx.writers.latex import LaTeXTranslator - from sphinx.testing.util import remove_unicode_literals, strip_escseq -from test_build_html import ENV_WARNINGS +from sphinx.util import docutils +from sphinx.util.osutil import cd, ensuredir +from sphinx.writers.latex import LaTeXTranslator LATEX_ENGINES = ['pdflatex', 'lualatex', 'xelatex'] diff --git a/tests/test_build_texinfo.py b/tests/test_build_texinfo.py index 114f194fe..7d3538126 100644 --- a/tests/test_build_texinfo.py +++ b/tests/test_build_texinfo.py @@ -14,13 +14,12 @@ import os import re from subprocess import Popen, PIPE -from six import PY3 import pytest - -from sphinx.writers.texinfo import TexinfoTranslator +from six import PY3 +from test_build_html import ENV_WARNINGS from sphinx.testing.util import remove_unicode_literals, strip_escseq -from test_build_html import ENV_WARNINGS +from sphinx.writers.texinfo import TexinfoTranslator TEXINFO_WARNINGS = ENV_WARNINGS + """\ diff --git a/tests/test_build_text.py b/tests/test_build_text.py index 85b518007..f89187c85 100644 --- a/tests/test_build_text.py +++ b/tests/test_build_text.py @@ -8,9 +8,10 @@ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ -import pytest +import pytest from docutils.utils import column_width + from sphinx.writers.text import MAXWIDTH diff --git a/tests/test_config.py b/tests/test_config.py index 3f38c7ab8..be227819e 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -9,9 +9,9 @@ :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ -from six import PY3, iteritems -import pytest import mock +import pytest +from six import PY3, iteritems import sphinx from sphinx.config import Config diff --git a/tests/test_directive_code.py b/tests/test_directive_code.py index f62f44f13..5b48b1d61 100644 --- a/tests/test_directive_code.py +++ b/tests/test_directive_code.py @@ -9,9 +9,10 @@ :license: BSD, see LICENSE for details. """ -import pytest import os +import pytest + from sphinx.config import Config from sphinx.directives.code import LiteralIncludeReader from sphinx.testing.util import etree_parse diff --git a/tests/test_directive_only.py b/tests/test_directive_only.py index 010eae384..5b55bc370 100644 --- a/tests/test_directive_only.py +++ b/tests/test_directive_only.py @@ -11,8 +11,8 @@ import re -from docutils import nodes import pytest +from docutils import nodes @pytest.mark.sphinx('text', testroot='directive-only') diff --git a/tests/test_docutilsconf.py b/tests/test_docutilsconf.py index 91bf8fc95..2332dcf50 100644 --- a/tests/test_docutilsconf.py +++ b/tests/test_docutilsconf.py @@ -13,6 +13,7 @@ import re import sys import pytest + from sphinx.testing.path import path diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index 3561e76ce..b6de66989 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -11,13 +11,13 @@ import re -from six import text_type import pytest +from six import text_type +import sphinx.domains.cpp as cppDomain from sphinx import addnodes from sphinx.domains.cpp import DefinitionParser, DefinitionError, NoOldIdError from sphinx.domains.cpp import Symbol, _max_id, _id_prefix -import sphinx.domains.cpp as cppDomain def parse(name, string): diff --git a/tests/test_domain_js.py b/tests/test_domain_js.py index a609dcefe..9f5d70486 100644 --- a/tests/test_domain_js.py +++ b/tests/test_domain_js.py @@ -10,12 +10,11 @@ """ import pytest -from mock import Mock from docutils import nodes +from mock import Mock from sphinx import addnodes from sphinx.domains.javascript import JavaScriptDomain - from sphinx.testing.util import assert_node diff --git a/tests/test_domain_py.py b/tests/test_domain_py.py index 0c1d28dd9..8e93986fa 100644 --- a/tests/test_domain_py.py +++ b/tests/test_domain_py.py @@ -10,13 +10,12 @@ """ import pytest +from docutils import nodes from mock import Mock from six import text_type -from docutils import nodes from sphinx import addnodes from sphinx.domains.python import py_sig_re, _pseudo_parse_arglist, PythonDomain - from sphinx.testing.util import assert_node diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 06573fa38..dce7a5ddf 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -9,8 +9,8 @@ :license: BSD, see LICENSE for details. """ -from docutils import nodes import mock +from docutils import nodes from sphinx.domains.std import StandardDomain diff --git a/tests/test_environment.py b/tests/test_environment.py index 6f9ffec08..11364e89f 100644 --- a/tests/test_environment.py +++ b/tests/test_environment.py @@ -10,9 +10,9 @@ """ import pytest -from sphinx.testing.util import SphinxTestApp, path from sphinx.builders.html import StandaloneHTMLBuilder from sphinx.builders.latex import LaTeXBuilder +from sphinx.testing.util import SphinxTestApp, path app = env = None diff --git a/tests/test_environment_indexentries.py b/tests/test_environment_indexentries.py index 03e4d9662..c3da93ef1 100644 --- a/tests/test_environment_indexentries.py +++ b/tests/test_environment_indexentries.py @@ -10,11 +10,12 @@ """ from collections import namedtuple -from sphinx import locale -from sphinx.environment.adapters.indexentries import IndexEntries import mock +from sphinx import locale +from sphinx.environment.adapters.indexentries import IndexEntries + Environment = namedtuple('Environment', 'indexentries') dummy_builder = mock.Mock() diff --git a/tests/test_environment_toctree.py b/tests/test_environment_toctree.py index 26334858b..9989d7dd4 100644 --- a/tests/test_environment_toctree.py +++ b/tests/test_environment_toctree.py @@ -9,14 +9,14 @@ :license: BSD, see LICENSE for details. """ +import pytest from docutils import nodes from docutils.nodes import bullet_list, list_item, caption, comment, reference + from sphinx import addnodes from sphinx.addnodes import compact_paragraph, only from sphinx.builders.html import StandaloneHTMLBuilder from sphinx.environment.adapters.toctree import TocTree -import pytest - from sphinx.testing.util import assert_node diff --git a/tests/test_ext_apidoc.py b/tests/test_ext_apidoc.py index c8d10d2e7..836c20b04 100644 --- a/tests/test_ext_apidoc.py +++ b/tests/test_ext_apidoc.py @@ -16,7 +16,6 @@ from collections import namedtuple import pytest from sphinx.ext.apidoc import main as apidoc_main - from sphinx.testing.util import remove_unicode_literals diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py index 7a9666792..44470771d 100644 --- a/tests/test_ext_autodoc.py +++ b/tests/test_ext_autodoc.py @@ -10,7 +10,9 @@ """ import pickle + import pytest + from sphinx import addnodes diff --git a/tests/test_ext_doctest.py b/tests/test_ext_doctest.py index 482e60d53..d19d5b4e5 100644 --- a/tests/test_ext_doctest.py +++ b/tests/test_ext_doctest.py @@ -9,10 +9,11 @@ :license: BSD, see LICENSE for details. """ import pytest -from six import PY2 -from sphinx.ext.doctest import is_allowed_version -from packaging.version import InvalidVersion from packaging.specifiers import InvalidSpecifier +from packaging.version import InvalidVersion +from six import PY2 + +from sphinx.ext.doctest import is_allowed_version cleanup_called = 0 diff --git a/tests/test_ext_imgconverter.py b/tests/test_ext_imgconverter.py index 8f610377c..330c3eeed 100644 --- a/tests/test_ext_imgconverter.py +++ b/tests/test_ext_imgconverter.py @@ -9,9 +9,10 @@ :license: BSD, see LICENSE for details. """ -import pytest import os +import pytest + @pytest.mark.sphinx('latex', testroot='ext-imgconverter') @pytest.mark.xfail(os.name != 'posix', reason="Not working on windows") diff --git a/tests/test_ext_inheritance.py b/tests/test_ext_inheritance.py index fcf313a30..8a8de8369 100644 --- a/tests/test_ext_inheritance.py +++ b/tests/test_ext_inheritance.py @@ -10,7 +10,9 @@ """ import os + import pytest + from sphinx.ext.inheritance_diagram import InheritanceDiagram @@ -48,25 +50,24 @@ def test_inheritance_diagram(app, status, warning): for cls in graphs['basic_diagram'].class_info: # use in b/c traversing order is different sometimes assert cls in [ - ('dummy.test.A', 'dummy.test.A', [], None), - ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), - ('dummy.test.C', 'dummy.test.C', ['dummy.test.A'], None), - ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), - ('dummy.test.D', 'dummy.test.D', - ['dummy.test.B', 'dummy.test.C'], None), - ('dummy.test.B', 'dummy.test.B', ['dummy.test.A'], None) - ] + ('dummy.test.A', 'dummy.test.A', [], None), + ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), + ('dummy.test.C', 'dummy.test.C', ['dummy.test.A'], None), + ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), + ('dummy.test.D', 'dummy.test.D', ['dummy.test.B', 'dummy.test.C'], None), + ('dummy.test.B', 'dummy.test.B', ['dummy.test.A'], None) + ] # inheritance diagram using :parts: 1 option for cls in graphs['diagram_w_parts'].class_info: assert cls in [ - ('A', 'dummy.test.A', [], None), - ('F', 'dummy.test.F', ['C'], None), - ('C', 'dummy.test.C', ['A'], None), - ('E', 'dummy.test.E', ['B'], None), - ('D', 'dummy.test.D', ['B', 'C'], None), - ('B', 'dummy.test.B', ['A'], None) - ] + ('A', 'dummy.test.A', [], None), + ('F', 'dummy.test.F', ['C'], None), + ('C', 'dummy.test.C', ['A'], None), + ('E', 'dummy.test.E', ['B'], None), + ('D', 'dummy.test.D', ['B', 'C'], None), + ('B', 'dummy.test.B', ['A'], None) + ] # inheritance diagram with 1 top class # :top-classes: dummy.test.B @@ -79,15 +80,13 @@ def test_inheritance_diagram(app, status, warning): # for cls in graphs['diagram_w_1_top_class'].class_info: assert cls in [ - ('dummy.test.A', 'dummy.test.A', [], None), - ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), - ('dummy.test.C', 'dummy.test.C', ['dummy.test.A'], None), - ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), - ('dummy.test.D', 'dummy.test.D', - ['dummy.test.B', 'dummy.test.C'], None), - ('dummy.test.B', 'dummy.test.B', [], None) - ] - + ('dummy.test.A', 'dummy.test.A', [], None), + ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), + ('dummy.test.C', 'dummy.test.C', ['dummy.test.A'], None), + ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), + ('dummy.test.D', 'dummy.test.D', ['dummy.test.B', 'dummy.test.C'], None), + ('dummy.test.B', 'dummy.test.B', [], None) + ] # inheritance diagram with 2 top classes # :top-classes: dummy.test.B, dummy.test.C @@ -100,13 +99,12 @@ def test_inheritance_diagram(app, status, warning): # for cls in graphs['diagram_w_2_top_classes'].class_info: assert cls in [ - ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), - ('dummy.test.C', 'dummy.test.C', [], None), - ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), - ('dummy.test.D', 'dummy.test.D', - ['dummy.test.B', 'dummy.test.C'], None), - ('dummy.test.B', 'dummy.test.B', [], None) - ] + ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), + ('dummy.test.C', 'dummy.test.C', [], None), + ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), + ('dummy.test.D', 'dummy.test.D', ['dummy.test.B', 'dummy.test.C'], None), + ('dummy.test.B', 'dummy.test.B', [], None) + ] # inheritance diagram with 2 top classes and specifiying the entire module # rendering should be @@ -123,11 +121,10 @@ def test_inheritance_diagram(app, status, warning): # this is a known issue. for cls in graphs['diagram_module_w_2_top_classes'].class_info: assert cls in [ - ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), - ('dummy.test.C', 'dummy.test.C', [], None), - ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), - ('dummy.test.D', 'dummy.test.D', - ['dummy.test.B', 'dummy.test.C'], None), - ('dummy.test.B', 'dummy.test.B', [], None), - ('dummy.test.A', 'dummy.test.A', [], None), - ] + ('dummy.test.F', 'dummy.test.F', ['dummy.test.C'], None), + ('dummy.test.C', 'dummy.test.C', [], None), + ('dummy.test.E', 'dummy.test.E', ['dummy.test.B'], None), + ('dummy.test.D', 'dummy.test.D', ['dummy.test.B', 'dummy.test.C'], None), + ('dummy.test.B', 'dummy.test.B', [], None), + ('dummy.test.A', 'dummy.test.A', [], None), + ] diff --git a/tests/test_ext_intersphinx.py b/tests/test_ext_intersphinx.py index cc50c00c9..ff08ded1c 100644 --- a/tests/test_ext_intersphinx.py +++ b/tests/test_ext_intersphinx.py @@ -9,22 +9,22 @@ :license: BSD, see LICENSE for details. """ +import os import unittest +from io import BytesIO -from docutils import nodes import mock import pytest import requests -from io import BytesIO -import os +from docutils import nodes +from test_util_inventory import inventory_v2, inventory_v2_not_having_version from sphinx import addnodes -from sphinx.ext.intersphinx import setup as intersphinx_setup from sphinx.ext.intersphinx import ( load_mappings, missing_reference, _strip_basic_auth, _get_safe_url, fetch_inventory, INVENTORY_FILENAME, debug ) -from test_util_inventory import inventory_v2, inventory_v2_not_having_version +from sphinx.ext.intersphinx import setup as intersphinx_setup def fake_node(domain, type, target, content, **attrs): diff --git a/tests/test_ext_math.py b/tests/test_ext_math.py index 1cdf4d637..755a9e955 100644 --- a/tests/test_ext_math.py +++ b/tests/test_ext_math.py @@ -9,9 +9,8 @@ :license: BSD, see LICENSE for details. """ -import os -import re import errno +import re import subprocess import pytest @@ -37,10 +36,12 @@ def test_jsmath(app, status, warning): content = (app.outdir / 'math.html').text() assert '