From 4bd1beded48dfa5150f13ed81df15035bce000d3 Mon Sep 17 00:00:00 2001 From: Matthew Woehlke Date: Tue, 13 Jun 2023 11:25:14 -0400 Subject: Utilities/Sphinx: Don't ignore flake8 E402 Refactor commit 1f39a3cd1a (Utilities/Sphinx: Restore explicit check for Sphinx 2.x or later) to avoid needing to suppress flake8 E402. While ignoring it with respect to the docutils/sphinx imports and the sphinx version check was correct, the need to disable it for the whole file was suboptimal. --- Utilities/Sphinx/.flake8 | 3 --- Utilities/Sphinx/cmake.py | 36 ++++++++++++++++++------------------ 2 files changed, 18 insertions(+), 21 deletions(-) delete mode 100644 Utilities/Sphinx/.flake8 diff --git a/Utilities/Sphinx/.flake8 b/Utilities/Sphinx/.flake8 deleted file mode 100644 index 7218008..0000000 --- a/Utilities/Sphinx/.flake8 +++ /dev/null @@ -1,3 +0,0 @@ -[flake8] -per-file-ignores = - cmake.py: E402 diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py index d3eb948..e6c2266 100644 --- a/Utilities/Sphinx/cmake.py +++ b/Utilities/Sphinx/cmake.py @@ -11,24 +11,24 @@ from typing import Any, List, Tuple, Type, cast import sphinx -# Require at least Sphinx 2.x. -# flake8 issues E402 for imports after this, but the purpose of this -# check is to fail more clearly if the imports below will fail. -assert sphinx.version_info >= (2,) - -from docutils.utils.code_analyzer import Lexer, LexerError -from docutils.parsers.rst import Directive, directives -from docutils.transforms import Transform -from docutils.nodes import Element, Node, TextElement, system_message -from docutils import io, nodes - -from sphinx.directives import ObjectDescription, nl_escape_re -from sphinx.domains import Domain, ObjType -from sphinx.roles import XRefRole -from sphinx.util.docutils import ReferenceRole -from sphinx.util.nodes import make_refnode -from sphinx.util import logging, ws_re -from sphinx import addnodes +# The following imports may fail if we don't have Sphinx 2.x or later. +if sphinx.version_info >= (2,): + from docutils.utils.code_analyzer import Lexer, LexerError + from docutils.parsers.rst import Directive, directives + from docutils.transforms import Transform + from docutils.nodes import Element, Node, TextElement, system_message + from docutils import io, nodes + + from sphinx.directives import ObjectDescription, nl_escape_re + from sphinx.domains import Domain, ObjType + from sphinx.roles import XRefRole + from sphinx.util.docutils import ReferenceRole + from sphinx.util.nodes import make_refnode + from sphinx.util import logging, ws_re + from sphinx import addnodes +else: + # Sphinx 2.x is required. + assert sphinx.version_info >= (2,) # END imports -- cgit v0.12 From 528cdc75519987a2004db94d1e7b0e445b1fb158 Mon Sep 17 00:00:00 2001 From: Matthew Woehlke Date: Tue, 13 Jun 2023 11:39:48 -0400 Subject: Utilities/Sphinx: Fix some flake8 gripes Reorder some imports to better conform to what flake8 wants. --- Utilities/Sphinx/cmake.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py index e6c2266..0afd705 100644 --- a/Utilities/Sphinx/cmake.py +++ b/Utilities/Sphinx/cmake.py @@ -5,7 +5,6 @@ import os import re - from dataclasses import dataclass from typing import Any, List, Tuple, Type, cast @@ -13,19 +12,19 @@ import sphinx # The following imports may fail if we don't have Sphinx 2.x or later. if sphinx.version_info >= (2,): - from docutils.utils.code_analyzer import Lexer, LexerError + from docutils import io, nodes + from docutils.nodes import Element, Node, TextElement, system_message from docutils.parsers.rst import Directive, directives from docutils.transforms import Transform - from docutils.nodes import Element, Node, TextElement, system_message - from docutils import io, nodes + from docutils.utils.code_analyzer import Lexer, LexerError + from sphinx import addnodes from sphinx.directives import ObjectDescription, nl_escape_re from sphinx.domains import Domain, ObjType from sphinx.roles import XRefRole + from sphinx.util import logging, ws_re from sphinx.util.docutils import ReferenceRole from sphinx.util.nodes import make_refnode - from sphinx.util import logging, ws_re - from sphinx import addnodes else: # Sphinx 2.x is required. assert sphinx.version_info >= (2,) @@ -47,10 +46,10 @@ else: # - manual/cmake-buildsystem.7.html # (with nested $<..>; relative and absolute paths, "::") +from pygments.lexer import bygroups # noqa I100 from pygments.lexers import CMakeLexer from pygments.token import (Comment, Name, Number, Operator, Punctuation, String, Text, Whitespace) -from pygments.lexer import bygroups # Notes on regular expressions below: # - [\.\+-] are needed for string constants like gtk+-2.0 -- cgit v0.12