Merge pull request psycopg#1006 from psycopg/isort

Use isort to standardise imports

Author: dvarrazzo

.gitignore

@@ -23,3 +23,4 @@ wheelhouse/
 /psycopg_c/build/
 /psycopg_pool/build/
 /tools/build/pg_config_vcpkg_stub/build/
+/tools/isort-psycopg/build/

.pre-commit-config.yaml

@@ -32,3 +32,9 @@ repos:
         language: system
         entry: mypy --pretty --follow-imports=silent
         files: \.py[i]?$
+
+      - id: isort
+        name: isort
+        language: system
+        entry: isort
+        files: \.(py[i]?|pxd|pyx)$

docs/lib/pg3_docs.py

@@ -83,7 +83,7 @@ def monkeypatch_autodoc():
     """
     Patch autodoc in order to use information found by `recover_defined_module`.
     """
-    from sphinx.ext.autodoc import Documenter, AttributeDocumenter
+    from sphinx.ext.autodoc import AttributeDocumenter, Documenter
 
     orig_doc_get_real_modname = Documenter.get_real_modname
     orig_attr_get_real_modname = AttributeDocumenter.get_real_modname

docs/lib/ticket_role.py

@@ -10,6 +10,7 @@
 """
 
 import re
+
 from docutils import nodes, utils
 from docutils.parsers.rst import roles
 

psycopg/psycopg/__init__.py

@@ -7,36 +7,30 @@
 import logging
 
 from . import pq  # noqa: F401 import early to stabilize side effects
-from . import types
-from . import postgres
+from . import dbapi20, postgres, types
 from ._tpc import Xid
-from .copy import Copy, AsyncCopy
+from .copy import AsyncCopy, Copy
 from ._enums import IsolationLevel
 from .cursor import Cursor
-from .errors import Warning, Error, InterfaceError, DatabaseError
-from .errors import DataError, OperationalError, IntegrityError
-from .errors import InternalError, ProgrammingError, NotSupportedError
+from .errors import DatabaseError, DataError, Error, IntegrityError, InterfaceError
+from .errors import InternalError, NotSupportedError, OperationalError
+from .errors import ProgrammingError, Warning
 from ._column import Column
-from ._pipeline import Pipeline, AsyncPipeline
+from .dbapi20 import BINARY, DATETIME, NUMBER, ROWID, STRING, Binary, Date
+from .dbapi20 import DateFromTicks, Time, TimeFromTicks, Timestamp, TimestampFromTicks
+from .version import __version__ as __version__  # noqa: F401
+from ._pipeline import AsyncPipeline, Pipeline
 from .connection import Connection
-from .transaction import Rollback, Transaction, AsyncTransaction
+from .raw_cursor import AsyncRawCursor, AsyncRawServerCursor, RawCursor, RawServerCursor
+from .transaction import AsyncTransaction, Rollback, Transaction
 from .cursor_async import AsyncCursor
 from ._capabilities import Capabilities, capabilities
-from .server_cursor import AsyncServerCursor, ServerCursor
 from .client_cursor import AsyncClientCursor, ClientCursor
-from .raw_cursor import AsyncRawCursor, RawCursor
-from .raw_cursor import AsyncRawServerCursor, RawServerCursor
+from .server_cursor import AsyncServerCursor, ServerCursor
 from ._connection_base import BaseConnection, Notify
 from ._connection_info import ConnectionInfo
 from .connection_async import AsyncConnection
 
-from . import dbapi20
-from .dbapi20 import BINARY, DATETIME, NUMBER, ROWID, STRING
-from .dbapi20 import Binary, Date, DateFromTicks, Time, TimeFromTicks
-from .dbapi20 import Timestamp, TimestampFromTicks
-
-from .version import __version__ as __version__  # noqa: F401
-
 # Set the logger to a quiet default, can be enabled if needed
 logger = logging.getLogger("psycopg")
 if logger.level == logging.NOTSET:

psycopg/psycopg/_adapters_map.py

@@ -6,10 +6,10 @@
 
 from __future__ import annotations
 
-from typing import Any, cast, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, cast
 
-from . import pq
 from . import errors as e
+from . import pq
 from .abc import Dumper, Loader
 from ._enums import PyFormat as PyFormat
 from ._compat import TypeVar

psycopg/psycopg/_capabilities.py

@@ -6,8 +6,7 @@
 
 from __future__ import annotations
 
-from . import pq
-from . import _cmodule
+from . import _cmodule, pq
 from .errors import NotSupportedError
 
 

psycopg/psycopg/_cmodule.py

@@ -8,6 +8,7 @@
 from __future__ import annotations
 
 from types import ModuleType
+
 from . import pq
 
 __version__: str | None = None

psycopg/psycopg/_column.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from operator import attrgetter
 from collections.abc import Sequence
 

psycopg/psycopg/_compat.py

@@ -7,9 +7,9 @@
 import sys
 
 if sys.version_info >= (3, 10):
-    from typing import TypeGuard, TypeAlias
+    from typing import TypeAlias, TypeGuard
 else:
-    from typing_extensions import TypeGuard, TypeAlias
+    from typing_extensions import TypeAlias, TypeGuard
 
 if sys.version_info >= (3, 11):
     from typing import LiteralString, Self

psycopg/psycopg/_connection_base.py

@@ -8,18 +8,16 @@
 
 import sys
 import logging
-from typing import Callable, Generic, NamedTuple, TYPE_CHECKING
-from weakref import ref, ReferenceType
+from typing import TYPE_CHECKING, Callable, Generic, NamedTuple
+from weakref import ReferenceType, ref
 from warnings import warn
 from functools import partial
 from collections import deque
 
-from . import pq
 from . import errors as e
-from . import postgres
-from . import generators
+from . import generators, postgres, pq
 from .abc import PQGen, PQGenConn, Query
-from .sql import Composable, SQL
+from .sql import SQL, Composable
 from ._tpc import Xid
 from .rows import Row
 from .adapt import AdaptersMap
@@ -32,9 +30,10 @@
 from ._connection_info import ConnectionInfo
 
 if TYPE_CHECKING:
-    from .pq.abc import PGconn, PGresult
     from psycopg_pool.base import BasePool
 
+    from .pq.abc import PGconn, PGresult
+
 # Row Type variable for Cursor (when it needs to be distinguished from the
 # connection's one)
 CursorRow = TypeVar("CursorRow")

psycopg/psycopg/_conninfo_attempts.py

@@ -15,9 +15,7 @@
 
 from . import errors as e
 from .abc import ConnDict, ConnMapping
-from ._conninfo_utils import get_param, is_ip_address, get_param_def
-from ._conninfo_utils import split_attempts
-
+from ._conninfo_utils import get_param, get_param_def, is_ip_address, split_attempts
 
 logger = logging.getLogger("psycopg")
 

psycopg/psycopg/_conninfo_attempts_async.py

@@ -12,8 +12,7 @@
 
 from . import errors as e
 from .abc import ConnDict, ConnMapping
-from ._conninfo_utils import get_param, is_ip_address, get_param_def
-from ._conninfo_utils import split_attempts
+from ._conninfo_utils import get_param, get_param_def, is_ip_address, split_attempts
 
 if True:  # ASYNC:
     import asyncio

psycopg/psycopg/_conninfo_utils.py

@@ -11,9 +11,9 @@
 from ipaddress import ip_address
 from dataclasses import dataclass
 
+from . import errors as e
 from . import pq
 from .abc import ConnDict, ConnMapping
-from . import errors as e
 
 
 def split_attempts(params: ConnMapping) -> list[ConnDict]:

psycopg/psycopg/_copy.py

@@ -11,15 +11,15 @@
 
 from abc import ABC, abstractmethod
 from types import TracebackType
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from collections.abc import Iterator, Sequence
 
-from . import pq
 from . import errors as e
+from . import pq
 from ._compat import Self
-from ._copy_base import BaseCopy, MAX_BUFFER_SIZE, QUEUE_SIZE, PREFER_FLUSH
-from .generators import copy_to, copy_end
-from ._acompat import spawn, gather, Queue, Worker
+from ._acompat import Queue, Worker, gather, spawn
+from ._copy_base import MAX_BUFFER_SIZE, PREFER_FLUSH, QUEUE_SIZE, BaseCopy
+from .generators import copy_end, copy_to
 
 if TYPE_CHECKING:
     from .abc import Buffer

psycopg/psycopg/_copy_async.py

@@ -8,15 +8,15 @@
 
 from abc import ABC, abstractmethod
 from types import TracebackType
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from collections.abc import AsyncIterator, Sequence
 
-from . import pq
 from . import errors as e
+from . import pq
 from ._compat import Self
-from ._copy_base import BaseCopy, MAX_BUFFER_SIZE, QUEUE_SIZE, PREFER_FLUSH
-from .generators import copy_to, copy_end
-from ._acompat import aspawn, agather, AQueue, AWorker
+from ._acompat import AQueue, AWorker, agather, aspawn
+from ._copy_base import MAX_BUFFER_SIZE, PREFER_FLUSH, QUEUE_SIZE, BaseCopy
+from .generators import copy_end, copy_to
 
 if TYPE_CHECKING:
     from .abc import Buffer

psycopg/psycopg/_copy_base.py

@@ -10,12 +10,12 @@
 import sys
 import struct
 from abc import ABC, abstractmethod
-from typing import Any, Generic, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Generic
 from collections.abc import Sequence
 
-from . import pq
 from . import adapt
 from . import errors as e
+from . import pq
 from .abc import Buffer, ConnectionType, PQGen, Transformer
 from .pq.misc import connection_summary
 from ._cmodule import _psycopg

psycopg/psycopg/_cursor_base.py

@@ -6,22 +6,21 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, Any, Generic, NoReturn
 from functools import partial
-from typing import Any, Generic, NoReturn
 from collections.abc import Iterable, Sequence
-from typing import TYPE_CHECKING
 
-from . import pq
 from . import adapt
 from . import errors as e
-from .abc import ConnectionType, Query, Params, PQGen
+from . import pq
+from .abc import ConnectionType, Params, PQGen, Query
 from .rows import Row, RowMaker
-from ._capabilities import capabilities
 from ._column import Column
 from .pq.misc import connection_summary
-from ._queries import PostgresQuery, PostgresClientQuery
+from ._queries import PostgresClientQuery, PostgresQuery
 from ._preparing import Prepare
 from .generators import execute, fetch, send
+from ._capabilities import capabilities
 
 if TYPE_CHECKING:
     from .abc import Transformer

psycopg/psycopg/_dns.py

@@ -11,21 +11,21 @@
 import re
 import warnings
 from random import randint
-from typing import Any, DefaultDict, NamedTuple, TYPE_CHECKING
-from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any, DefaultDict, NamedTuple
 from collections import defaultdict
+from collections.abc import Sequence
 
 try:
-    from dns.resolver import Resolver, Cache
-    from dns.asyncresolver import Resolver as AsyncResolver
+    from dns.resolver import Cache, Resolver
     from dns.exception import DNSException
+    from dns.asyncresolver import Resolver as AsyncResolver
 except ImportError:
     raise ImportError(
         "the module psycopg._dns requires the package 'dnspython' installed"
     )
 
-from . import errors as e
 from . import conninfo
+from . import errors as e
 
 if TYPE_CHECKING:
     from dns.rdtypes.IN.SRV import SRV

psycopg/psycopg/_encodings.py

@@ -7,13 +7,13 @@
 from __future__ import annotations
 
 import re
-import string
 import codecs
-from typing import Any, TYPE_CHECKING
+import string
+from typing import TYPE_CHECKING, Any
 from functools import cache
 
-from .pq._enums import ConnStatus
 from .errors import NotSupportedError
+from .pq._enums import ConnStatus
 
 if TYPE_CHECKING:
     from ._connection_base import BaseConnection

psycopg/psycopg/_pipeline.py

@@ -8,21 +8,21 @@
 
 import logging
 from types import TracebackType
-from typing import Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from collections import deque
 
-from . import pq
 from . import errors as e
+from . import pq
 from .abc import PipelineCommand, PQGen
 from ._compat import Self, TypeAlias
 from .pq.misc import connection_summary
-from .generators import pipeline_communicate, fetch_many, send
+from .generators import fetch_many, pipeline_communicate, send
 from ._capabilities import capabilities
 
 if TYPE_CHECKING:
     from .pq.abc import PGresult
-    from .connection import Connection
     from ._preparing import Key, Prepare  # noqa: F401
+    from .connection import Connection
     from ._cursor_base import BaseCursor  # noqa: F401
     from ._connection_base import BaseConnection
     from .connection_async import AsyncConnection

psycopg/psycopg/_preparing.py

@@ -7,8 +7,8 @@
 from __future__ import annotations
 
 from enum import IntEnum, auto
-from typing import Any, TYPE_CHECKING
-from collections import deque, OrderedDict
+from typing import TYPE_CHECKING, Any
+from collections import OrderedDict, deque
 from collections.abc import Sequence
 
 from . import pq

psycopg/psycopg/_py_transformer.py

@@ -11,14 +11,14 @@
 
 from __future__ import annotations
 
-from typing import Any, DefaultDict, TYPE_CHECKING
-from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any, DefaultDict
 from collections import defaultdict
+from collections.abc import Sequence
 
-from . import pq
 from . import abc
 from . import errors as e
-from .abc import Buffer, LoadFunc, AdaptContext, PyFormat, NoneType
+from . import pq
+from .abc import AdaptContext, Buffer, LoadFunc, NoneType, PyFormat
 from .rows import Row, RowMaker
 from ._oids import INVALID_OID, TEXT_OID
 from ._compat import TypeAlias