Install isort

.github/workflows/tests.yml

@@ -36,6 +36,8 @@ jobs:
         run: poetry install
       - name: Check formatting
         run: poetry run black --check .
+      - name: Check import order
+        run: poetry run isort --check-only .
   test:
     name: Test
     runs-on: ${{ matrix.os }}

mkdocs_awesome_pages_plugin/meta.py

@@ -2,10 +2,10 @@
 import re
 from enum import Enum
 from pathlib import PurePath
-from typing import Optional, List, Union, Any, Iterator
+from typing import Any, Iterator, List, Optional, Union
 
-from mkdocs.structure.files import Files
 import yaml
+from mkdocs.structure.files import Files
 from wcmatch import glob
 
 

mkdocs_awesome_pages_plugin/navigation.py

@@ -1,23 +1,22 @@
 import warnings
+from typing import Dict, List, Optional, Set, Union
 
 import mkdocs.utils
 import mkdocs.utils.meta
-from natsort import natsort_keygen
-from typing import List, Optional, Union, Set, Dict
-
+from mkdocs.structure.files import Files
+from mkdocs.structure.nav import Link
+from mkdocs.structure.nav import Navigation as MkDocsNavigation
 from mkdocs.structure.nav import (
-    Navigation as MkDocsNavigation,
     Section,
-    Link,
     _add_parent_links,
     _add_previous_and_next_links,
 )
-from mkdocs.structure.files import Files
 from mkdocs.structure.pages import Page
+from natsort import natsort_keygen
 
 from .meta import Meta, MetaNavItem, MetaNavRestItem, RestItemList
 from .options import Options
-from .utils import dirname, basename, join_paths
+from .utils import basename, dirname, join_paths
 
 NavigationItem = Union[Page, Section, Link]
 

mkdocs_awesome_pages_plugin/plugin.py

@@ -1,21 +1,18 @@
+import glob
 import os.path
 import warnings
-import glob
-from typing import List, Dict
+from typing import Dict, List
 
-from mkdocs.config import config_options, Config
+from mkdocs.config import Config, config_options
 from mkdocs.plugins import BasePlugin
-from mkdocs.structure.files import Files, File
-from mkdocs.structure.nav import (
-    Navigation as MkDocsNavigation,
-    get_navigation,
-    Section,
-    Link,
-)
+from mkdocs.structure.files import File, Files
+from mkdocs.structure.nav import Link
+from mkdocs.structure.nav import Navigation as MkDocsNavigation
+from mkdocs.structure.nav import Section, get_navigation
 from mkdocs.structure.pages import Page
 
 from .meta import DuplicateRestItemError, MetaNavRestItem, RestItemList
-from .navigation import AwesomeNavigation, get_by_type, NavigationItem
+from .navigation import AwesomeNavigation, NavigationItem, get_by_type
 from .options import Options
 
 

mkdocs_awesome_pages_plugin/tests/e2e/base.py

@@ -1,7 +1,7 @@
 import os
 import tempfile
 import warnings
-from typing import Iterable, Optional, List, Tuple, Union, Dict, TypeVar
+from typing import Dict, Iterable, List, Optional, Tuple, TypeVar, Union
 from unittest import TestCase
 
 import yaml

mkdocs_awesome_pages_plugin/tests/e2e/test_arrange.py

@@ -1,5 +1,5 @@
-from .base import E2ETestCase
 from ...navigation import NavEntryNotFound
+from .base import E2ETestCase
 
 
 class TestArrange(E2ETestCase):

mkdocs_awesome_pages_plugin/tests/e2e/test_hide.py

@@ -1,4 +1,5 @@
 from mkdocs_awesome_pages_plugin.navigation import HideInRootHasNoEffect
+
 from .base import E2ETestCase
 
 

mkdocs_awesome_pages_plugin/tests/e2e/test_mkdocs_nav.py

@@ -1,9 +1,9 @@
 import pytest
 from mkdocs import __version__ as mkdocs_version
 
-from .base import E2ETestCase
 from ...meta import DuplicateRestItemError
 from ...navigation import NavEntryNotFound
+from .base import E2ETestCase
 
 
 class TestMkdocsNav(E2ETestCase):

mkdocs_awesome_pages_plugin/tests/e2e/test_nav.py

@@ -1,6 +1,6 @@
-from .base import E2ETestCase
 from ...meta import DuplicateRestItemError
 from ...navigation import NavEntryNotFound
+from .base import E2ETestCase
 
 
 class TestNav(E2ETestCase):

mkdocs_awesome_pages_plugin/tests/e2e/test_title.py

@@ -1,5 +1,5 @@
-from .base import E2ETestCase
 from ...navigation import TitleInRootHasNoEffect
+from .base import E2ETestCase
 
 
 class TestPageTitle(E2ETestCase):

mkdocs_awesome_pages_plugin/tests/navigation/base.py

@@ -1,19 +1,19 @@
 import os.path
-from typing import List, Union, Optional
+from typing import List, Optional, Union
 from unittest import TestCase, mock
 
 from mkdocs.structure.files import File, Files
+from mkdocs.structure.nav import Link
+from mkdocs.structure.nav import Navigation as MkDocsNavigation
 from mkdocs.structure.nav import (
-    Navigation as MkDocsNavigation,
     Section,
-    Link,
     _add_parent_links,
     _add_previous_and_next_links,
 )
 from mkdocs.structure.pages import Page
 
 from ...meta import Meta
-from ...navigation import NavigationItem, AwesomeNavigation, get_by_type
+from ...navigation import AwesomeNavigation, NavigationItem, get_by_type
 from ...options import Options
 
 

mkdocs_awesome_pages_plugin/tests/navigation/test_arrange.py

@@ -1,6 +1,6 @@
-from .base import NavigationTestCase
 from ...meta import Meta
 from ...navigation import NavEntryNotFound
+from .base import NavigationTestCase
 
 
 class TestArrange(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_collapse.py

@@ -1,5 +1,5 @@
-from .base import NavigationTestCase
 from ...meta import Meta
+from .base import NavigationTestCase
 
 
 class TestCollapseGlobalDisabled(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_hide.py

@@ -1,6 +1,6 @@
-from .base import NavigationTestCase
 from ...meta import Meta
 from ...navigation import HideInRootHasNoEffect
+from .base import NavigationTestCase
 
 
 class TestHide(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_meta.py

@@ -6,11 +6,11 @@
 from mkdocs.structure.nav import Section
 from mkdocs.structure.pages import Page
 
-from .base import NavigationTestCase
 from ...meta import Meta, MetaNavRestItem, RestType
 from ...navigation import NavigationItem, NavigationMeta
 from ...options import Options
 from ...utils import normpath
+from .base import NavigationTestCase
 
 
 class TestCommonDirname(TestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_nav.py

@@ -1,6 +1,6 @@
-from .base import NavigationTestCase
 from ...meta import Meta, MetaNavItem, MetaNavRestItem
 from ...navigation import NavEntryNotFound
+from .base import NavigationTestCase
 
 
 class TestNav(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_order_and_sort.py

@@ -1,5 +1,5 @@
-from .base import NavigationTestCase
 from ...meta import Meta, MetaNavItem, MetaNavRestItem
+from .base import NavigationTestCase
 
 
 class TestOrderAndSort(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/navigation/test_title.py

@@ -1,6 +1,6 @@
-from .base import NavigationTestCase
 from ...meta import Meta
 from ...navigation import TitleInRootHasNoEffect
+from .base import NavigationTestCase
 
 
 class TestTitle(NavigationTestCase):

mkdocs_awesome_pages_plugin/tests/test_meta.py

@@ -3,7 +3,7 @@
 
 from mkdocs.structure.files import File, Files
 
-from ..meta import Meta, DuplicateRestItemError, MetaNavItem, MetaNavRestItem
+from ..meta import DuplicateRestItemError, Meta, MetaNavItem, MetaNavRestItem
 from .file_mock import FileMock
 
 

pyproject.toml

@@ -28,10 +28,14 @@ pytest = "^8.1.1"
 beautifulsoup4 = "^4.12.3"
 mock-open = "^1.4.0"
 black = { extras = ["d"], version = "^24.2.0" }
+isort = "^5.13.2"
 
 [tool.black]
 line-length = 120
 
+[tool.isort]
+profile = "black"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"