Sort import statements within project

.pre-commit-config.yaml

@@ -18,13 +18,6 @@ repos:
   rev: 5.10.1
   hooks:
   - id: isort
-    args:
-    - --honor-noqa
-    exclude: |
-      (?x)
-      ^
-        .*
-      $
     stages: ["manual"]
 
 - repo: https://github.com/Lucas-C/pre-commit-hooks.git

docs/_ext/single_sourced_data.py

@@ -6,22 +6,29 @@
 from copy import copy
 from pathlib import Path
 from re import match
-from typing import Any, Dict, List, Tuple, Union
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Tuple
+from typing import Union
 
 from sphinx.application import Sphinx
 from sphinx.util import logging
 from sphinx.util.docutils import SphinxDirective
-from sphinx.util.nodes import nested_parse_with_titles, nodes
+from sphinx.util.nodes import nested_parse_with_titles
+from sphinx.util.nodes import nodes
+
+
+from docutils import statemachine  # isort: skip
 
-# isort: split
 
-from docutils import statemachine
+# isort: split
 
 import yaml
 
 from ansible_navigator import __version__
-from ansible_navigator.configuration_subsystem import NavigatorConfiguration
 from ansible_navigator.configuration_subsystem import Constants as C
+from ansible_navigator.configuration_subsystem import NavigatorConfiguration
 from ansible_navigator.configuration_subsystem.definitions import SettingsEntry
 from ansible_navigator.utils import oxfordcomma
 

docs/_ext/spelling_stub_ext.py

@@ -1,7 +1,9 @@
 # fmt: off
 """Sphinx extension for making the spelling directive noop."""
 
-from typing import Dict, List, Union
+from typing import Dict
+from typing import List
+from typing import Union
 
 from sphinx.application import Sphinx
 from sphinx.util.docutils import SphinxDirective

pyproject.toml

@@ -49,6 +49,15 @@
 [tool.black]
 line-length = 100
 
+[tool.isort]
+force_single_line = true # Force from .. import to be 1 per line, minimizing changes at time of implementation
+known_first_party = "ansible_navigator, key_value_store" # No effect at implementation, here anticipating future benefit
+lines_after_imports = 2 # Ensures consistency for cases when there's variable vs function/class definitions after imports
+lines_between_types = 1 # Separate import/from with 1 line, minimizing changes at time of implementation
+no_lines_before = "LOCALFOLDER"  # Keeps local imports bundled with first-party
+profile = "black" # Avoid conflict with black
+reverse_relative = true # Import local prior to parent
+skip_glob = ["tests/fixtures/common/collections*"] # Skip ansible content due to ansible-test sanity ruleset
 
 [tool.pylint]
     [tool.pylint.master]

setup.py

@@ -1,11 +1,13 @@
 """ setup """
 import glob
 import os
+
 from itertools import groupby
 from operator import itemgetter
 
 from setuptools import setup
 
+
 # valid files in share to be copied
 data_file_types = [".yml", ".py", ".json", ".md"]
 

share/ansible_navigator/utils/catalog_collections.py

@@ -9,7 +9,6 @@
 import subprocess
 import sys
 
-
 from collections import Counter
 from collections import OrderedDict
 from datetime import datetime
@@ -19,18 +18,22 @@
 from typing import List
 from typing import Tuple
 
-from ansible.utils.plugin_docs import get_docstring  # type: ignore
-
 import yaml
+
+from ansible.utils.plugin_docs import get_docstring  # type: ignore
 from yaml.error import YAMLError
 
+
 try:
     from yaml import CSafeLoader as SafeLoader
 except ImportError:
     from yaml import SafeLoader  # type: ignore
 
-from key_value_store import KeyValueStore  # type: ignore  # pylint: disable=import-error
+# pylint: disable=import-error
+from key_value_store import KeyValueStore  # type: ignore
+
 
+# pylint: enable=import-error
 
 PROCESSES = (multiprocessing.cpu_count() - 1) or 1
 

share/ansible_navigator/utils/image_introspect.py

@@ -1,16 +1,18 @@
 """introspect an image"""
 import json
+import multiprocessing
 import re
 import subprocess
 import sys
-import multiprocessing
-from types import SimpleNamespace
 
+from queue import Queue
+from types import SimpleNamespace
 from typing import Any
-from typing import Callable, List
+from typing import Callable
 from typing import Dict
+from typing import List
 from typing import Union
-from queue import Queue
+
 
 # pylint: disable=broad-except
 

src/ansible_navigator/__main__.py

@@ -5,5 +5,6 @@
 """
 from .cli import main
 
+
 if __name__ == "__main__":
     main()

src/ansible_navigator/_yaml.py

@@ -2,12 +2,13 @@
 # pylint: disable=unused-import
 import re
 
+from typing import Any
 from typing import NamedTuple
 from typing import Union
-from typing import Any
 
 import yaml  # noqa: F401
 
+
 try:
     from yaml import CDumper as Dumper
 except ImportError:

src/ansible_navigator/action_runner.py

@@ -5,14 +5,14 @@
 
 from ansible_navigator.actions import kegexes
 from ansible_navigator.actions import run_action
-
 from .app import App
 from .configuration_subsystem import ApplicationConfiguration
 from .steps import Steps
 from .ui_framework import Interaction
 from .ui_framework import UIConfig
 from .ui_framework import UserInterface
 
+
 if TYPE_CHECKING:
     from _curses import _CursesWindow  # pylint: disable=no-name-in-module
 

src/ansible_navigator/actions/__init__.py

@@ -2,8 +2,8 @@
 from typing import Any
 from typing import Callable
 from typing import Union
-from . import _actions as actions
 
+from . import _actions as actions
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..ui_framework import Interaction

src/ansible_navigator/actions/_actions.py

@@ -5,15 +5,16 @@
 import importlib
 import logging
 import re
-from collections import namedtuple
 
+from collections import namedtuple
 from typing import Any
 from typing import Callable
 from typing import Dict
 from typing import Generator
 from typing import List
 from typing import Tuple
 
+
 try:
     from importlib import resources
 except ImportError:

src/ansible_navigator/actions/collections.py

@@ -7,21 +7,19 @@
 
 from copy import deepcopy
 from json.decoder import JSONDecodeError
-
 from typing import Any
 from typing import Dict
 from typing import List
-from typing import Union
 from typing import Tuple
+from typing import Union
 
-from . import run_action
 from . import _actions as actions
+from . import run_action
 from ..app import App
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..runner import Command
 from ..steps import Step
-
 from ..ui_framework import CursesLinePart
 from ..ui_framework import CursesLines
 from ..ui_framework import Interaction

src/ansible_navigator/actions/config.py

@@ -12,26 +12,22 @@
 from typing import Tuple
 from typing import Union
 
-
-from . import run_action
 from . import _actions as actions
-
+from . import run_action
+from .._yaml import Loader
+from .._yaml import yaml
 from ..app import App
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..runner import AnsibleConfig
 from ..runner import Command
 from ..steps import Step
-
 from ..ui_framework import CursesLinePart
 from ..ui_framework import CursesLines
 from ..ui_framework import Interaction
 from ..ui_framework import nonblocking_notification
 from ..ui_framework import warning_notification
 
-from .._yaml import yaml
-from .._yaml import Loader
-
 
 def color_menu(colno: int, colname: str, entry: Dict[str, Any]) -> Tuple[int, int]:
     # pylint: disable=unused-argument

src/ansible_navigator/actions/doc.py

@@ -8,18 +8,17 @@
 
 from typing import Any
 from typing import Dict
-from typing import Tuple
 from typing import Optional
+from typing import Tuple
 from typing import Union
-from . import _actions as actions
 
+from . import _actions as actions
 from ..app import App
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..configuration_subsystem import Constants as C
-from ..runner import Command
 from ..runner import AnsibleDoc
-
+from ..runner import Command
 from ..ui_framework import CursesLinePart
 from ..ui_framework import CursesLines
 from ..ui_framework import Interaction

src/ansible_navigator/actions/exec.py

@@ -13,6 +13,7 @@
 from ..configuration_subsystem.definitions import Constants
 from ..runner import Command
 
+
 GeneratedCommand = Tuple[str, Optional[List[str]]]
 
 

src/ansible_navigator/actions/filter.py

@@ -1,5 +1,6 @@
 """:filter"""
 import logging
+
 from . import _actions as actions
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration

src/ansible_navigator/actions/help_doc.py

@@ -1,5 +1,6 @@
 """:help"""
 import os
+
 from . import _actions as actions
 from ..app import App
 from ..app_public import AppPublic

src/ansible_navigator/actions/images.py

@@ -4,23 +4,20 @@
 import shlex
 
 from functools import partial
-
 from typing import Any
 from typing import Dict
 from typing import List
 from typing import Tuple
 from typing import Union
 
-from . import run_action
 from . import _actions as actions
-
+from . import run_action
 from ..app import App
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..image_manager import inspect_all
 from ..runner import Command
 from ..steps import Step
-
 from ..ui_framework import CursesLinePart
 from ..ui_framework import CursesLines
 from ..ui_framework import Interaction

src/ansible_navigator/actions/inventory.py

@@ -12,9 +12,8 @@
 from typing import Tuple
 from typing import Union
 
-from . import run_action
 from . import _actions as actions
-
+from . import run_action
 from ..app import App
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration

src/ansible_navigator/actions/open_file.py

@@ -11,12 +11,12 @@
 from typing import List
 
 from . import _actions as actions
+from .._yaml import human_dump
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration
 from ..ui_framework import Interaction
 from ..ui_framework import Menu
 from ..utils import remove_dbl_un
-from .._yaml import human_dump
 
 
 class SuspendCurses:

src/ansible_navigator/actions/quit.py

@@ -1,6 +1,7 @@
 """:quit
 """
 import logging
+
 from . import _actions as actions
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration

src/ansible_navigator/actions/refresh.py

@@ -1,5 +1,6 @@
 """refresh"""
 import logging
+
 from . import _actions as actions
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration

src/ansible_navigator/actions/rerun.py

@@ -1,6 +1,7 @@
 """:rerun"""
 import copy
 import logging
+
 from . import _actions as actions
 from ..app_public import AppPublic
 from ..configuration_subsystem import ApplicationConfiguration