Replace asottile/reorder-python-imports with isort

black >=24 is incompatible with it since it adds a whitespace between
an initial docstring and the import section, which
reorder-python-imports does not like. This is something that is not
likely to be fixed. For reference:

asottile/reorder-python-imports#366
psf/black#4175

This substitution causes some reordering since isort separates
first-party imports from third-party ones by default. We're still
keeping the one line per import format to reduce merge conflicts.

data/salt_python_support.yaml

@@ -2,28 +2,28 @@
 3003:
   min:
     - 3
-    - 7
+    - 8
   max:
     - 3
     - 9
 3004:
   min:
     - 3
-    - 7
+    - 8
   max:
     - 3
     - 10
 3005:
   min:
     - 3
-    - 7
+    - 8
   max:
     - 3
     - 10
 3006:
   min:
     - 3
-    - 7
+    - 8
   max:
     - 3
     - 10

project/.pre-commit-config.yaml.j2

@@ -65,14 +65,14 @@ repos:
         ]
         exclude: src/{{ package_namespace_path }}{{ package_name }}/version.py
 
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.12.2
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
     hooks:
-      - id: reorder-python-imports
+      - id: isort
         args: [
-          --py{{ python_requires[:2] | join("") }}-plus,
+          --py {{ python_requires[:2] | join("") }},
         ]
-        exclude: src/{{ package_namespace_path }}{{ package_name }}/version.py
+        exclude: src/{{ package_namespace_path }}{{ package_name }}/(__init__|version).py
 
   - repo: https://github.com/psf/black
     rev: 24.2.0

project/.pre-commit-hooks/make-autodocs.py.j2

@@ -3,7 +3,6 @@ import os.path
 import subprocess
 from pathlib import Path
 
-
 repo_path = Path(subprocess.check_output(["git", "rev-parse", "--show-toplevel"]).decode().strip())
 src_dir = repo_path / "src" / {% if package_namespace -%} "{{ package_namespace }}" / {% endif -%} "{{ package_name }}"
 doc_dir = repo_path / "docs"

project/docs/index.rst.j2

@@ -16,7 +16,7 @@
   :maxdepth: 2
   :caption: Provided Modules
   :hidden:
-  {% for loader in loaders %}
+{% for loader in loaders %}
   ref/{{ loader.rstrip("s") + ("" if loader in singular_loader_dirs else "s") }}/index
   {%- endfor %}
 

project/pyproject.toml.j2

@@ -110,44 +110,50 @@ build_dir = "build/sphinx"
 [tool.black]
 line-length = 100
 
+[tool.isort]
+force_single_line = true
+skip = ["src/{{ package_namespace_path }}{{ package_name }}/__init__.py"]
+profile = "black"
+line_length = 100
+
 [tool.towncrier]
-    package = "{{ package_namespace_pkg }}{{ package_name }}"
-    filename = "CHANGELOG.md"
-    template = "changelog/.template.jinja"
-    directory = "changelog/"
-    start_string = "# Changelog\n"
-    underlines = ["", "", ""]
-    title_format = "## {version} ({project_date})"
+package = "{{ package_namespace_pkg }}{{ package_name }}"
+filename = "CHANGELOG.md"
+template = "changelog/.template.jinja"
+directory = "changelog/"
+start_string = "# Changelog\n"
+underlines = ["", "", ""]
+title_format = "## {version} ({project_date})"
 {%- if tracker_url %}
-    issue_format = "[#{issue}]({{ tracker_url }}/{issue})"
+issue_format = "[#{issue}]({{ tracker_url }}/{issue})"
 {%- endif %}
 
-    [[tool.towncrier.type]]
-        directory = "removed"
-        name = "Removed"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "deprecated"
-        name = "Deprecated"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "changed"
-        name = "Changed"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "fixed"
-        name = "Fixed"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "added"
-        name = "Added"
-        showcontent = true
-
-    [[tool.towncrier.type]]
-        directory = "security"
-        name = "Security"
-        showcontent = true
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "security"
+name = "Security"
+showcontent = true

project/src/{{ namespaced_package_path }}/{% if 'auth' in loaders %}auth{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt auth module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'beacon' in loaders %}beacons{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt beacon module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'cache' in loaders %}cache{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt cache module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'cloud' in loaders %}clouds{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt cloud module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'engine' in loaders %}engines{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt engine module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'executor' in loaders %}executors{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt executor module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'fileserver' in loaders %}fileservers{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt fileserver module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'grain' in loaders %}grains{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt grain module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'log_handler' in loaders %}log_handlers{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt log_handler module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'matcher' in loaders %}matchers{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt matcher module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'metaproxy' in loaders %}metaproxy{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt metaproxy module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'module' in loaders %}modules{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt execution module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'netapi' in loaders %}netapi{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt netapi module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'output' in loaders %}output{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt output module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'pillar' in loaders %}pillar{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt pillar module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'pkgdb' in loaders %}pkgdb{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt pkgdb module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'pkgfile' in loaders %}pkgfiles{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt pkgfile module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'proxy' in loaders %}proxy{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt proxy module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'queue' in loaders %}queues{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt queue module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'renderer' in loaders %}renderers{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt renderer module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'returner' in loaders %}returners{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt returner module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'roster' in loaders %}roster{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt roster module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'runner' in loaders %}runners{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt runner module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'sdb' in loaders %}sdb{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt SDB module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'serializer' in loaders %}serializers{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt serializer module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'state' in loaders %}states{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt state module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'thorium' in loaders %}thorium{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt thorium module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'token' in loaders %}tokens{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt token module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'top' in loaders %}tops{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt top module
 """
+
 import logging
 
 log = logging.getLogger(__name__)

project/src/{{ namespaced_package_path }}/{% if 'wheel' in loaders %}wheel{% endif %}/{{ package_name }}_mod.py.j2

@@ -1,6 +1,7 @@
 """
 Salt wheel module
 """
+
 import logging
 
 log = logging.getLogger(__name__)