isort: Python import sorting

- Setup, enabled, and ran 'isort' as a new pre-commit hook across all Python files. This is more consistent than using IDE-specific solutions. - Bumped version of pre-commit hooks. Note that Python 3 is now required for running pre-commit due to latest pre-commit-hooks and isort versions. Specifically some isort v5 features drove this decision.
Kintyre · Mar 18, 2021 · a48d6af · a48d6af
1 parent ca32537
commit a48d6af
Show file tree

Hide file tree

Showing 60 changed files with 173 additions and 163 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,8 +17,14 @@ repos:
       args: [ '--fix=lf' ]
       exclude: (\.bat|\.csv)$
 
+- repo: https://github.com/PyCQA/isort.git
+  rev: 5.7.0
+  hooks:
+    - id: isort
+      exclude: (ksconf/ext/)
+
 - repo: https://github.com/pre-commit/mirrors-autopep8
-  rev: v1.5.4
+  rev: v1.5.6
   hooks:
     - id: autopep8
       exclude: (ksconf/ext/)

diff --git a/build.py b/build.py
@@ -1,10 +1,10 @@
 # Example app building script
 
+import argparse
 import sys
 from shutil import copy2, rmtree
-import argparse
 
-from ksconf.builder import BuildManager, VERBOSE, QUIET
+from ksconf.builder import QUIET, VERBOSE, BuildManager
 
 manager = BuildManager()
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,7 +13,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath(os.path.join('..','..')))
+
+sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
 #from recommonmark.parser import CommonMarkParser
 
 
@@ -22,7 +23,8 @@
 project = u'KSConf'
 copyright = u'2020, Kintyre Solutions'
 
-from ksconf import __version__ as release, __author__ as author
+from ksconf import __author__ as author  # noqa
+from ksconf import __version__ as release  # noqa
 
 # The short X.Y version
 version = ".".join(release.split(".")[:-1])
@@ -48,9 +50,9 @@
 templates_path = ['_templates']
 
 
-#source_parsers = {
+# source_parsers = {
 #    '.md' :  CommonMarkParser,
-#}
+# }
 
 
 # The suffix(es) of source filenames.
@@ -85,7 +87,7 @@
 #
 html_theme = 'alabaster'
 html_theme = 'classic'
-html_theme = os.environ.get("KSCONF_DOCS_THEME",'sphinx_rtd_theme')
+html_theme = os.environ.get("KSCONF_DOCS_THEME", 'sphinx_rtd_theme')
 
 print("Using theme:  {}".format(html_theme))
 
@@ -103,7 +105,7 @@
 html_context = {
     'css_files': [
         '_static/theme_overrides.css',  # override wide tables in RTD theme
-        ],
+    ],
 }
 
 # Custom sidebar templates, must be a dictionary that maps document names
@@ -128,13 +130,13 @@
 
 # https://protips.readthedocs.io/pdf-font.html
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
     'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
     'pointsize': '11pt',
 
-# Additional stuff for the LaTeX preamble.
+    # Additional stuff for the LaTeX preamble.
     'preamble': r'''
         \usepackage{charter}
         \usepackage[defaultsans]{lato}

diff --git a/ksconf/__init__.py b/ksconf/__init__.py
@@ -12,16 +12,15 @@
 
 """
 
-from __future__ import absolute_import
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 __author__ = "Lowell Alleman <lowell@kintyre.co>"
 __copyright__ = "(c) 2019 Kintyre Solutions, Inc"
 __license__ = "Apache Public License v2"
 
 # _version.py is autogenerated at build time.  But is missing on first call to setup.py
 try:
-    from ._version import version as __version__, build as __build__, vcs_info as __vcs_info__
+    from ._version import build as __build__, vcs_info as __vcs_info__, version as __version__
 except ImportError:     # pragma: no cover
     __version__ = None
     __build__ = None

diff --git a/ksconf/__main__.py b/ksconf/__main__.py
@@ -12,22 +12,19 @@
 
 """
 
-from __future__ import absolute_import
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 import argparse
-import sys
 import os
 import platform
-
+import sys
 from collections import defaultdict
 
 import ksconf
 import ksconf.util
 from ksconf.commands import DescriptionHelpFormatterPreserveLayout, get_all_ksconf_cmds
+from ksconf.consts import EXIT_CODE_ENV_BUSTED, EXIT_CODE_INTERNAL_ERROR, KSCONF_DEBUG
 from ksconf.util.completers import autocomplete
-from ksconf.consts import EXIT_CODE_INTERNAL_ERROR, EXIT_CODE_ENV_BUSTED, KSCONF_DEBUG
-
 
 # Workaround PY2:  WindowsError: [Error -2146893795] Provider DLL failed to initialize correctly
 # Someday need to re-evaluate this and see if it's reproducible on other machines....

diff --git a/ksconf/archive.py b/ksconf/archive.py
@@ -1,5 +1,4 @@
-from __future__ import absolute_import
-from __future__ import unicode_literals
+from __future__ import absolute_import, unicode_literals
 
 import os
 from collections import namedtuple

diff --git a/ksconf/builder/__init__.py b/ksconf/builder/__init__.py
@@ -12,9 +12,10 @@
 except ImportError:
     Callable = type
 
-from ksconf.consts import EXIT_CODE_INTERNAL_ERROR, KSCONF_DEBUG
 from ksconf.ext.six import text_type
 
+from ksconf.consts import EXIT_CODE_INTERNAL_ERROR, KSCONF_DEBUG
+
 if sys.version_info < (3, 6):
     from ksconf.util.file import pathlib_compat
     Popen = pathlib_compat(Popen)
@@ -141,6 +142,6 @@ def default_cli(build_manager, build_funct, argparse_parents=()):
         sys.exit(EXIT_CODE_INTERNAL_ERROR)
 
 
-# Used for type hints / avoid unused variable warnings moving to Python 3 only: # nopep8
+# Used for type hints / avoid unused variable warnings moving to Python 3 only: # noqa
 _ = BuildStep
 del _
diff --git a/ksconf/builder/cache.py b/ksconf/builder/cache.py
@@ -6,8 +6,9 @@
 from pathlib import Path, PurePath
 from shutil import copy2, rmtree
 
-from ksconf.builder import BuildCacheException
 from ksconf.ext.six import PY2, text_type
+
+from ksconf.builder import BuildCacheException
 from ksconf.util.file import file_hash, pathlib_compat
 
 if sys.version_info < (3, 6):

diff --git a/ksconf/builder/core.py b/ksconf/builder/core.py
@@ -29,12 +29,13 @@
 from pathlib import Path
 from shutil import copy2, rmtree
 
+from ksconf.ext.six import text_type
+
 from ksconf.builder import QUIET, VERBOSE, BuildCacheException, BuildStep
 from ksconf.builder.cache import CachedRun, FileSet
-from ksconf.ext.six import text_type
 
 try:
-    from typing import Callable, List, Any
+    from typing import Any, Callable, List
 except ImportError:
     Callable = List = Any = type
 

diff --git a/ksconf/builder/steps.py b/ksconf/builder/steps.py
@@ -2,14 +2,11 @@
 """
 from __future__ import absolute_import, unicode_literals
 
-
 import re
 import sys
-
-from ksconf.builder import BuildStep
-from ksconf.builder import VERBOSE, QUIET
 from shutil import copy2, rmtree
 
+from ksconf.builder import QUIET, VERBOSE, BuildStep
 
 if sys.version_info < (3, 6):
     # Allow these stdlib functions to work with pathlib

diff --git a/ksconf/commands/__init__.py b/ksconf/commands/__init__.py
@@ -14,8 +14,7 @@
 from ksconf import KsconfPluginWarning
 from ksconf.conf.parser import (ConfParserException, detect_by_bom, parse_conf,
                                 smart_write_conf, write_conf)
-from ksconf.consts import (EXIT_CODE_BAD_CONF_FILE, EXIT_CODE_NO_SUCH_FILE,
-                           SMART_CREATE)
+from ksconf.consts import EXIT_CODE_BAD_CONF_FILE, EXIT_CODE_NO_SUCH_FILE, SMART_CREATE
 from ksconf.util import debug_traceback, memoize
 
 __all__ = [

diff --git a/ksconf/commands/check.py b/ksconf/commands/check.py
@@ -13,8 +13,8 @@
 from collections import Counter
 
 from ksconf.commands import KsconfCmd, dedent
-from ksconf.conf.parser import parse_conf, PARSECONF_STRICT_NC, ConfParserException
-from ksconf.consts import EXIT_CODE_SUCCESS, EXIT_CODE_BAD_CONF_FILE, EXIT_CODE_INTERNAL_ERROR
+from ksconf.conf.parser import PARSECONF_STRICT_NC, ConfParserException, parse_conf
+from ksconf.consts import EXIT_CODE_BAD_CONF_FILE, EXIT_CODE_INTERNAL_ERROR, EXIT_CODE_SUCCESS
 from ksconf.util import debug_traceback
 from ksconf.util.completers import conf_files_completer
 from ksconf.util.file import _stdin_iter, expand_glob_list

diff --git a/ksconf/commands/combine.py b/ksconf/commands/combine.py
@@ -14,17 +14,17 @@
 import os
 import re
 
-from ksconf.layer import DirectLayerRoot, DotDLayerRoot, LayerConfig, LayerFilter
-from ksconf.commands import ConfFileProxy
-from ksconf.commands import KsconfCmd, dedent
+from ksconf.commands import ConfFileProxy, KsconfCmd, dedent
 from ksconf.conf.delta import show_text_diff
 from ksconf.conf.merge import merge_conf_files
 from ksconf.conf.parser import PARSECONF_MID, PARSECONF_STRICT
-from ksconf.consts import EXIT_CODE_MISSING_ARG, EXIT_CODE_COMBINE_MARKER_MISSING, SMART_NOCHANGE, \
-    EXIT_CODE_NO_SUCH_FILE, EXIT_CODE_BAD_ARGS
+from ksconf.consts import (EXIT_CODE_BAD_ARGS, EXIT_CODE_COMBINE_MARKER_MISSING,
+                           EXIT_CODE_MISSING_ARG, EXIT_CODE_NO_SUCH_FILE,
+                           SMART_NOCHANGE)
+from ksconf.layer import DirectLayerRoot, DotDLayerRoot, LayerConfig, LayerFilter
 from ksconf.util.compare import file_compare
 from ksconf.util.completers import DirectoriesCompleter
-from ksconf.util.file import expand_glob_list, relwalk, _is_binary_file, smart_copy
+from ksconf.util.file import _is_binary_file, expand_glob_list, relwalk, smart_copy
 
 CONTROLLED_DIR_MARKER = ".ksconf_controlled"
 

diff --git a/ksconf/commands/diff.py b/ksconf/commands/diff.py
@@ -11,7 +11,7 @@
 
 import argparse
 
-from ksconf.commands import KsconfCmd, dedent, ConfFileType
+from ksconf.commands import ConfFileType, KsconfCmd, dedent
 from ksconf.conf.delta import compare_cfgs, show_diff
 from ksconf.conf.parser import PARSECONF_MID_NC
 from ksconf.consts import EXIT_CODE_DIFF_EQUAL, EXIT_CODE_DIFF_NO_COMMON

diff --git a/ksconf/commands/filter.py b/ksconf/commands/filter.py
@@ -20,7 +20,7 @@
 import argparse
 import sys
 
-from ksconf.commands import KsconfCmd, dedent, ConfFileType
+from ksconf.commands import ConfFileType, KsconfCmd, dedent
 from ksconf.conf.parser import PARSECONF_MID_NC, write_conf_stream
 from ksconf.consts import EXIT_CODE_SUCCESS
 from ksconf.filter import FilteredList, FilterListWildcard, create_filtered_list

diff --git a/ksconf/commands/merge.py b/ksconf/commands/merge.py
@@ -12,9 +12,9 @@
 
 import os
 
-from ksconf.commands import KsconfCmd, dedent, ConfFileProxy, ConfFileType
+from ksconf.commands import ConfFileProxy, ConfFileType, KsconfCmd, dedent
 from ksconf.conf.merge import merge_conf_files
-from ksconf.conf.parser import PARSECONF_STRICT, PARSECONF_MID
+from ksconf.conf.parser import PARSECONF_MID, PARSECONF_STRICT
 from ksconf.consts import EXIT_CODE_SUCCESS
 from ksconf.util.completers import conf_files_completer
 

diff --git a/ksconf/commands/minimize.py b/ksconf/commands/minimize.py
@@ -18,13 +18,14 @@
 
 import ksconf.ext.six as six
 
-from ksconf.commands import KsconfCmd, dedent, ConfFileType
-from ksconf.conf.delta import compare_cfgs, DIFF_OP_DELETE, DIFF_OP_EQUAL, DiffStanza, \
-    DIFF_OP_INSERT, DIFF_OP_REPLACE, show_diff
-from ksconf.consts import EXIT_CODE_MISSING_ARG
+from ksconf.commands import ConfFileType, KsconfCmd, dedent
+from ksconf.conf.delta import (DIFF_OP_DELETE, DIFF_OP_EQUAL, DIFF_OP_INSERT,
+                               DIFF_OP_REPLACE, DiffStanza, compare_cfgs,
+                               show_diff)
 from ksconf.conf.merge import merge_conf_dicts
-from ksconf.conf.parser import GLOBAL_STANZA, _drop_stanza_comments
-from ksconf.conf.parser import PARSECONF_STRICT, PARSECONF_LOOSE
+from ksconf.conf.parser import (GLOBAL_STANZA, PARSECONF_LOOSE,
+                                PARSECONF_STRICT, _drop_stanza_comments)
+from ksconf.consts import EXIT_CODE_MISSING_ARG
 from ksconf.util.completers import conf_files_completer
 from ksconf.util.file import match_bwlist
 

diff --git a/ksconf/commands/package.py b/ksconf/commands/package.py
@@ -24,7 +24,7 @@
 import os
 
 from ksconf.commands import KsconfCmd, dedent
-from ksconf.consts import EXIT_CODE_SUCCESS, EXIT_CODE_BAD_ARGS
+from ksconf.consts import EXIT_CODE_BAD_ARGS, EXIT_CODE_SUCCESS
 from ksconf.package import AppPackager
 
 

diff --git a/ksconf/commands/promote.py b/ksconf/commands/promote.py
@@ -17,15 +17,16 @@
 
 from ksconf.ext.six.moves import input
 
-from ksconf.commands import ConfDirProxy
-from ksconf.commands import KsconfCmd, dedent, ConfFileType
-from ksconf.filter import FilteredList, create_filtered_list
-from ksconf.conf.delta import compare_cfgs, DIFF_OP_DELETE, summarize_cfg_diffs, show_diff, \
-    DIFF_OP_EQUAL, DiffStanza, DiffStzKey, DIFF_OP_INSERT, DIFF_OP_REPLACE
+from ksconf.commands import ConfDirProxy, ConfFileType, KsconfCmd, dedent
+from ksconf.conf.delta import (DIFF_OP_DELETE, DIFF_OP_EQUAL, DIFF_OP_INSERT,
+                               DIFF_OP_REPLACE, DiffStanza, DiffStzKey,
+                               compare_cfgs, show_diff, summarize_cfg_diffs)
 from ksconf.conf.merge import merge_conf_dicts
-from ksconf.conf.parser import PARSECONF_STRICT_NC, PARSECONF_STRICT
-from ksconf.consts import EXIT_CODE_FAILED_SAFETY_CHECK, EXIT_CODE_NOTHING_TO_DO, \
-    EXIT_CODE_USER_QUIT, EXIT_CODE_EXTERNAL_FILE_EDIT
+from ksconf.conf.parser import PARSECONF_STRICT, PARSECONF_STRICT_NC
+from ksconf.consts import (EXIT_CODE_EXTERNAL_FILE_EDIT,
+                           EXIT_CODE_FAILED_SAFETY_CHECK,
+                           EXIT_CODE_NOTHING_TO_DO, EXIT_CODE_USER_QUIT)
+from ksconf.filter import FilteredList, create_filtered_list
 from ksconf.util.completers import conf_files_completer
 from ksconf.util.file import _samefile, file_fingerprint
 

diff --git a/ksconf/commands/restexport.py b/ksconf/commands/restexport.py
@@ -25,11 +25,11 @@
 
 from ksconf.ext.six.moves.urllib.parse import quote
 
-from ksconf.util.rest import build_rest_url
-from ksconf.commands import KsconfCmd, dedent, ConfFileType
-from ksconf.conf.parser import PARSECONF_LOOSE, GLOBAL_STANZA
+from ksconf.commands import ConfFileType, KsconfCmd, dedent
+from ksconf.conf.parser import GLOBAL_STANZA, PARSECONF_LOOSE
 from ksconf.consts import EXIT_CODE_SUCCESS
 from ksconf.util.completers import conf_files_completer
+from ksconf.util.rest import build_rest_url
 
 
 class Literal(object):

diff --git a/ksconf/commands/restpublish.py b/ksconf/commands/restpublish.py
@@ -17,18 +17,17 @@
 from argparse import ArgumentParser
 
 import ksconf.ext.six as six
-
 from ksconf.ext.six.moves.urllib.parse import urlparse
 
-from ksconf.commands import KsconfCmd, dedent, ConfFileType, ConfFileProxy, \
-    add_splunkd_access_args, add_splunkd_namespace
-from ksconf.conf.parser import PARSECONF_LOOSE, GLOBAL_STANZA, conf_attr_boolean
-from ksconf.conf.delta import compare_stanzas, show_diff, DiffHeader, reduce_stanza, is_equal
+from ksconf.commands import (ConfFileProxy, ConfFileType, KsconfCmd,
+                             add_splunkd_access_args, add_splunkd_namespace,
+                             dedent)
+from ksconf.conf.delta import DiffHeader, compare_stanzas, is_equal, reduce_stanza, show_diff
 from ksconf.conf.meta import MetaData
+from ksconf.conf.parser import GLOBAL_STANZA, PARSECONF_LOOSE, conf_attr_boolean
 from ksconf.consts import EXIT_CODE_SUCCESS
 from ksconf.util.completers import conf_files_completer
 
-
 # Lazy loaded by _handle_imports()
 splunklib = None