Enforce import sorting

ff137 · web-flow · commit 3aa879ee8ea5 · 2024-10-15T20:06:49.000+02:00
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -28,3 +28,6 @@ jobs:
       - name: Run format check
         run: |
           pipenv run yapf --diff --recursive .
+
+      - name: Run isort check
+        run: pipenv run isort --check-only --diff .
diff --git a/.isort.cfg b/.isort.cfg
@@ -0,0 +1,5 @@
+[settings]
+combine_as_imports = true
+multi_line_output = 3
+include_trailing_comma = true
+src_paths = ["nats", "tests"]
diff --git a/Pipfile b/Pipfile
@@ -11,3 +11,4 @@ pytest-cov = "*"
 yapf = "*"
 toml = "*"  # see https://github.com/google/yapf/issues/936
 exceptiongroup = "*"
+isort = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/benchmark/latency_perf.py b/benchmark/latency_perf.py
@@ -2,7 +2,6 @@
 import asyncio
 import sys
 import time
-from random import randint
 
 import nats
 
diff --git a/benchmark/sub_perf.py b/benchmark/sub_perf.py
@@ -2,7 +2,6 @@
 import asyncio
 import sys
 import time
-from random import randint
 
 import nats
 
diff --git a/examples/advanced.py b/examples/advanced.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 from nats.errors import NoServersError, TimeoutError
 
diff --git a/examples/basic.py b/examples/basic.py
@@ -1,7 +1,8 @@
 import asyncio
+
 import nats
-from nats.errors import TimeoutError
 from common import args
+from nats.errors import TimeoutError
 
 
 async def main():
diff --git a/examples/client.py b/examples/client.py
@@ -1,8 +1,9 @@
 import asyncio
 from datetime import datetime
+
+from common import args
 from nats.aio.client import Client as NATS
 from nats.errors import ConnectionClosedError, TimeoutError
-from common import args
 
 
 class Client:
diff --git a/examples/clustered.py b/examples/clustered.py
@@ -1,7 +1,7 @@
 import asyncio
 from datetime import datetime
+
 import nats
-from nats.aio.client import Client as NATS
 from nats.aio.errors import ErrConnectionClosed, ErrNoServers, ErrTimeout
 
 
diff --git a/examples/component.py b/examples/component.py
@@ -1,6 +1,7 @@
 import asyncio
-import time
 import signal
+import time
+
 import nats
 
 
diff --git a/examples/connect.py b/examples/connect.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 from common import args
 
diff --git a/examples/context-manager.py b/examples/context-manager.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 from common import args
 
diff --git a/examples/drain-sub.py b/examples/drain-sub.py
@@ -1,6 +1,7 @@
 import asyncio
-from nats.aio.client import Client as NATS
+
 from common import args
+from nats.aio.client import Client as NATS
 
 
 async def main():
diff --git a/examples/example.py b/examples/example.py
@@ -1,8 +1,8 @@
 import asyncio
-from nats.aio.client import Client as NATS
-from nats.errors import ConnectionClosedError
 
 from common import args
+from nats.aio.client import Client as NATS
+from nats.errors import ConnectionClosedError
 
 
 async def main():
diff --git a/examples/jetstream.py b/examples/jetstream.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 from nats.errors import TimeoutError
 
diff --git a/examples/kv.py b/examples/kv.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 
 
diff --git a/examples/nats-pub/__main__.py b/examples/nats-pub/__main__.py
@@ -15,6 +15,7 @@
 import argparse
 import asyncio
 import sys
+
 import nats
 
 
diff --git a/examples/nats-req/__main__.py b/examples/nats-req/__main__.py
@@ -15,6 +15,7 @@
 import argparse
 import asyncio
 import sys
+
 import nats
 
 
diff --git a/examples/nats-sub/__main__.py b/examples/nats-sub/__main__.py
@@ -16,6 +16,7 @@
 import asyncio
 import signal
 import sys
+
 import nats
 
 
diff --git a/examples/publish.py b/examples/publish.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 from common import args
 
diff --git a/examples/service.py b/examples/service.py
@@ -1,5 +1,6 @@
 import asyncio
 import signal
+
 from nats.aio.client import Client as NATS
 
 
diff --git a/examples/simple.py b/examples/simple.py
@@ -1,4 +1,5 @@
 import asyncio
+
 import nats
 
 
diff --git a/examples/subscribe.py b/examples/subscribe.py
@@ -1,7 +1,8 @@
 import asyncio
 import signal
-from nats.aio.client import Client as NATS
+
 from common import args
+from nats.aio.client import Client as NATS
 
 
 async def main():
diff --git a/examples/tls.py b/examples/tls.py
@@ -1,5 +1,6 @@
 import asyncio
 import ssl
+
 from nats.aio.client import Client as NATS
 from nats.errors import TimeoutError
 
diff --git a/examples/wildcard.py b/examples/wildcard.py
@@ -1,6 +1,7 @@
 import asyncio
-from nats.aio.client import Client as NATS
+
 from common import args
+from nats.aio.client import Client as NATS
 
 
 async def run(loop):
diff --git a/nats/__init__.py b/nats/__init__.py
@@ -14,6 +14,7 @@
 from __future__ import annotations
 
 from typing import List, Union
+
 from .aio.client import Client as NATS
 
 
diff --git a/nats/aio/client.py b/nats/aio/client.py
@@ -20,27 +20,16 @@
 import json
 import logging
 import ssl
-import time
 import string
+import time
+from collections import UserString
 from dataclasses import dataclass
 from email.parser import BytesParser
+from io import BytesIO
 from random import shuffle
 from secrets import token_hex
-from typing import (
-    Any,
-    Awaitable,
-    Callable,
-    Dict,
-    List,
-    Literal,
-    Optional,
-    Tuple,
-    TypedDict,
-    Union,
-)
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Tuple, Union
 from urllib.parse import ParseResult, urlparse
-from collections import UserString
-from io import BytesIO
 
 try:
     from fast_mail_parser import parse_email
@@ -54,7 +43,6 @@
 from nats.protocol.parser import (
     AUTHORIZATION_VIOLATION,
     PERMISSIONS_ERR,
-    PING,
     PONG,
     STALE_CONNECTION,
     Parser,
@@ -537,6 +525,7 @@ def _setup_nkeys_connect(self) -> None:
     def _setup_nkeys_jwt_connect(self) -> None:
         assert self._user_credentials, "_user_credentials required"
         import os
+
         import nkeys
 
         creds: Credentials = self._user_credentials
@@ -641,7 +630,7 @@ def _setup_nkeys_seed_connect(self) -> None:
         assert (
             self._nkeys_seed or self._nkeys_seed_str
         ), "Client.connect must be called first"
-        import os
+
         import nkeys
 
         def _get_nkeys_seed() -> nkeys.KeyPair:
diff --git a/nats/aio/msg.py b/nats/aio/msg.py
@@ -16,7 +16,7 @@
 import datetime
 import json
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List, Optional, Dict, Union
+from typing import TYPE_CHECKING, Dict, List, Optional, Union
 
 from nats.errors import Error, MsgAlreadyAckdError, NotJSMessageError
 
diff --git a/nats/aio/subscription.py b/nats/aio/subscription.py
@@ -26,7 +26,6 @@
 from uuid import uuid4
 
 from nats import errors
-
 # Default Pending Limits of Subscriptions
 from nats.aio.msg import Msg
 
diff --git a/nats/aio/transport.py b/nats/aio/transport.py
@@ -3,8 +3,8 @@
 import abc
 import asyncio
 import ssl
+from typing import List, Optional, Union
 from urllib.parse import ParseResult
-from typing import List, Union, Optional
 
 try:
     import aiohttp
diff --git a/nats/js/api.py b/nats/js/api.py
@@ -16,7 +16,7 @@
 
 from dataclasses import dataclass, fields, replace
 from enum import Enum
-from typing import Any, Dict, Optional, TypeVar, List, Iterable, Iterator
+from typing import Any, Dict, Iterable, Iterator, List, Optional, TypeVar
 
 _NANOSECOND = 10**9
 
diff --git a/nats/js/client.py b/nats/js/client.py
@@ -19,7 +19,15 @@
 import time
 from email.parser import BytesParser
 from secrets import token_hex
-from typing import TYPE_CHECKING, Awaitable, Callable, Optional, List, Dict, Any
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Awaitable,
+    Callable,
+    Dict,
+    List,
+    Optional,
+)
 
 import nats.errors
 import nats.js.errors
@@ -29,17 +37,17 @@
 from nats.js.errors import (
     BadBucketError,
     BucketNotFoundError,
+    FetchTimeoutError,
     InvalidBucketNameError,
     NotFoundError,
-    FetchTimeoutError,
 )
 from nats.js.kv import KeyValue
 from nats.js.manager import JetStreamManager
 from nats.js.object_store import (
-    VALID_BUCKET_RE,
     OBJ_ALL_CHUNKS_PRE_TEMPLATE,
     OBJ_ALL_META_PRE_TEMPLATE,
     OBJ_STREAM_TEMPLATE,
+    VALID_BUCKET_RE,
     ObjectStore,
 )
 
diff --git a/nats/js/errors.py b/nats/js/errors.py
@@ -15,7 +15,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, NoReturn, Optional, Dict
+from typing import TYPE_CHECKING, Any, Dict, NoReturn, Optional
 
 import nats.errors
 from nats.js import api
diff --git a/nats/js/manager.py b/nats/js/manager.py
@@ -17,7 +17,7 @@
 import base64
 import json
 from email.parser import BytesParser
-from typing import TYPE_CHECKING, Any, List, Optional, Dict, Iterable
+from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional
 
 from nats.errors import NoRespondersError
 from nats.js import api
diff --git a/nats/js/object_store.py b/nats/js/object_store.py
@@ -12,26 +12,26 @@
 # limitations under the License.
 #
 
+import asyncio
 import base64
-import re
 import io
+import json
+import re
+from dataclasses import dataclass
 from datetime import datetime, timezone
 from hashlib import sha256
-from dataclasses import dataclass
-import json
-import asyncio
-from typing import TYPE_CHECKING, Optional, Union, List
+from typing import TYPE_CHECKING, List, Optional, Union
 
 import nats.errors
 from nats.js import api
 from nats.js.errors import (
     BadObjectMetaError,
     DigestMismatchError,
+    LinkIsABucketError,
+    NotFoundError,
     ObjectAlreadyExists,
     ObjectDeletedError,
     ObjectNotFoundError,
-    NotFoundError,
-    LinkIsABucketError,
 )
 from nats.js.kv import MSG_ROLLUP_SUBJECT
 
diff --git a/nats/micro/__init__.py b/nats/micro/__init__.py
@@ -13,11 +13,12 @@
 #
 
 from dataclasses import replace
-from nats.aio.client import Client
 from typing import Optional
 
+from nats.aio.client import Client
+
+from .request import Handler, Request
 from .service import Service, ServiceConfig
-from .request import Request, Handler
 
 
 async def add_service(
diff --git a/nats/micro/request.py b/nats/micro/request.py
diff --git a/nats/micro/service.py b/nats/micro/service.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/test_client.py b/tests/test_client.py
diff --git a/tests/test_client_async_await.py b/tests/test_client_async_await.py
diff --git a/tests/test_client_nkeys.py b/tests/test_client_nkeys.py
diff --git a/tests/test_client_v2.py b/tests/test_client_v2.py
diff --git a/tests/test_client_websocket.py b/tests/test_client_websocket.py
diff --git a/tests/test_compatibility.py b/tests/test_compatibility.py
diff --git a/tests/test_js.py b/tests/test_js.py
diff --git a/tests/test_micro_service.py b/tests/test_micro_service.py
diff --git a/tests/test_nuid.py b/tests/test_nuid.py
diff --git a/tests/test_parser.py b/tests/test_parser.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import asyncio`
	`2`	`+`
`2`	`3`	`import nats`
`3`	`4`	`from nats.errors import NoServersError, TimeoutError`
`4`	`5`