Improved type hints

Author: pcisar

CHANGELOG.md

@@ -24,7 +24,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Test changed from `unittest` to `pytest`
 - Parameter `database` for `connect` and `create_database` now accepts `pathlib.Path` objects.
 - Removed all usage of `LoggingIdMixin` as it's no longer available in `firebird-base` v2.0.
-- Typy hints adjusted to Python 3.11 standards
+- Type hints adjusted to Python 3.11 standards
 
 ### Added
 

docs/changelog.txt

@@ -14,7 +14,7 @@ Version 2.0.0
 - Removed all usage of `LoggingIdMixin` as it's no longer available in `firebird-base` v2.0.
 - #41: Some `firebird.conf` parameters are missing in `fbapi.config_items`
 - Fix: Added validation-related info codes that were ommited in `.DatabaseInfoProvider3`.
-- Typy hints adjusted to Python 3.11 standards
+- Type hints adjusted to Python 3.11 standards
 - Fix: `.TPB.parse_buffer` handling of new READ COMMITTED READ CONSISTENCY.
 - Fix: `.DPB.parse_buffer` and `.SPB_ATTACH.parse_buffer`.
 - Fix: Introduce `.StatementInfoProvider4` for proper handling of FB v5 additions.

pyproject.toml

@@ -132,16 +132,23 @@ unfixable = [
   # Don't change single quotes to double
   "Q000"
 ]
+exclude = ["*_pb2.py", "*.pyi", "tests/*", "docs/*", "work/*"]
 
 [tool.ruff.lint.isort]
-known-first-party = ["firebird.base"]
+known-first-party = ["firebird.driver", "firebird.base"]
 
 [tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
 "tests/**/*" = ["PLR2004", "S101", "TID252"]
+"fbapi.py" = ["N801", "E501"]
+"interfaces.py" = ["ARG001", "ARG002", "N801", "N803", "E501", "FBT001"]
+"hooks.py" = ["F401"]
+"core.py" = ["PLR2004", "DTZ007", "S104", "B028", "E501"]
+"config.py" = ["E501"]
+"__init__.py" = ["F401"]
 
 [tool.coverage.run]
 source_pkgs = ["firebird.driver", "tests"]

src/firebird/driver/__init__.py

@@ -37,28 +37,100 @@
 
 
 """
-from .config import driver_config, ServerConfig, DatabaseConfig, DriverConfig
-from .fbapi import load_api, get_api
-from .types import (Error, InterfaceError, DatabaseError, DataError,
-     OperationalError, IntegrityError, InternalError, ProgrammingError,
-     NotSupportedError, FirebirdWarning,
-     NetProtocol, DirectoryCode, PageSize, DBKeyScope, DbInfoCode, Features, ReplicaMode,
-     StmtInfoCode, ResultSetInfoCode, TraInfoCode, TraInfoIsolation, TraInfoReadCommitted,
-     TraInfoAccess, TraIsolation, TraReadCommitted, TraLockResolution, TraAccessMode,
-     TableShareMode, TableAccessMode, Isolation, DefaultAction, StatementType, BlobType,
-     DbAccessMode, DbSpaceReservation, DbWriteMode, ShutdownMode, OnlineMode,
-     ShutdownMethod,
-     CancelType, DecfloatRound, DecfloatTraps,
-     ServerCapability, SrvRepairFlag, SrvStatFlag, SrvBackupFlag,
-     SrvRestoreFlag, SrvNBackupFlag, SrvInfoCode, ConnectionFlag, EncryptionFlag,
-     apilevel, threadsafety, paramstyle, DESCRIPTION_NAME, DESCRIPTION_TYPE_CODE,
-     DESCRIPTION_DISPLAY_SIZE, DESCRIPTION_INTERNAL_SIZE, DESCRIPTION_PRECISION,
-     DESCRIPTION_SCALE, DESCRIPTION_NULL_OK, Date, Time, Timestamp, DateFromTicks,
-     TimeFromTicks, TimestampFromTicks, STRING, BINARY, NUMBER, DATETIME, ROWID,
-     get_timezone)
-from .core import (connect, create_database, connect_server, transaction, temp_database,
-     tpb, TPB, CHARSET_MAP, TIMEOUT, DistributedTransactionManager, Connection, Cursor,
-     Server, Statement, TransactionManager)
+from .config import DatabaseConfig, DriverConfig, ServerConfig, driver_config
+from .core import (
+    CHARSET_MAP,
+    TIMEOUT,
+    TPB,
+    Connection,
+    Cursor,
+    DistributedTransactionManager,
+    Server,
+    Statement,
+    TransactionManager,
+    connect,
+    connect_server,
+    create_database,
+    temp_database,
+    tpb,
+    transaction,
+)
+from .fbapi import get_api, load_api
+from .types import (
+    BINARY,
+    DATETIME,
+    DESCRIPTION_DISPLAY_SIZE,
+    DESCRIPTION_INTERNAL_SIZE,
+    DESCRIPTION_NAME,
+    DESCRIPTION_NULL_OK,
+    DESCRIPTION_PRECISION,
+    DESCRIPTION_SCALE,
+    DESCRIPTION_TYPE_CODE,
+    NUMBER,
+    ROWID,
+    STRING,
+    BlobType,
+    CancelType,
+    ConnectionFlag,
+    DatabaseError,
+    DataError,
+    Date,
+    DateFromTicks,
+    DbAccessMode,
+    DbInfoCode,
+    DBKeyScope,
+    DbSpaceReservation,
+    DbWriteMode,
+    DecfloatRound,
+    DecfloatTraps,
+    DefaultAction,
+    DirectoryCode,
+    EncryptionFlag,
+    Error,
+    Features,
+    FirebirdWarning,
+    IntegrityError,
+    InterfaceError,
+    InternalError,
+    Isolation,
+    NetProtocol,
+    NotSupportedError,
+    OnlineMode,
+    OperationalError,
+    PageSize,
+    ProgrammingError,
+    ReplicaMode,
+    ResultSetInfoCode,
+    ServerCapability,
+    ShutdownMethod,
+    ShutdownMode,
+    SrvBackupFlag,
+    SrvInfoCode,
+    SrvNBackupFlag,
+    SrvRepairFlag,
+    SrvRestoreFlag,
+    SrvStatFlag,
+    StatementType,
+    StmtInfoCode,
+    TableAccessMode,
+    TableShareMode,
+    Time,
+    TimeFromTicks,
+    Timestamp,
+    TimestampFromTicks,
+    TraAccessMode,
+    TraInfoAccess,
+    TraInfoCode,
+    TraInfoIsolation,
+    TraInfoReadCommitted,
+    TraIsolation,
+    TraLockResolution,
+    TraReadCommitted,
+    apilevel,
+    get_timezone,
+    paramstyle,
+    threadsafety,
+)
 
 #: Current driver version, SEMVER string.
 __VERSION__ = '2.0.0'

src/firebird/driver/config.py

@@ -46,16 +46,29 @@
 """
 
 from __future__ import annotations
-from typing import Iterable
+
 import os
-from firebird.base.config import Config, StrOption, IntOption, BoolOption, EnumOption, \
-     ConfigListOption, ListOption, ConfigParser, EnvExtendedInterpolation
-from .types import NetProtocol, DecfloatRound, DecfloatTraps
+from collections.abc import Iterable
+
+from firebird.base.config import (
+    BoolOption,
+    Config,
+    ConfigListOption,
+    ConfigParser,
+    EnumOption,
+    EnvExtendedInterpolation,
+    IntOption,
+    ListOption,
+    StrOption,
+)
+
+from .types import DecfloatRound, DecfloatTraps, NetProtocol
+
 
-class ServerConfig(Config): # pylint: disable=R0902
+class ServerConfig(Config):
     """Represents configuration options specific to a named Firebird server entry.
     """
-    def __init__(self, name: str, *, optional: bool=False, description: str=None):
+    def __init__(self, name: str, *, optional: bool=False, description: str | None=None):
         super().__init__(name, optional=optional, description=description)
         #: Server host machine specification
         self.host: StrOption = \
@@ -87,10 +100,10 @@ def __init__(self, name: str, *, optional: bool=False, description: str=None):
         self.encoding_errors: StrOption = \
             StrOption('encoding_errors', "Handler used for encoding errors", default='strict')
 
-class DatabaseConfig(Config): # pylint: disable=R0902
+class DatabaseConfig(Config):
     """Represents configuration options specific to a named Firebird database entry, including connection and creation parameters.
     """
-    def __init__(self, name: str, *, optional: bool=False, description: str=None):
+    def __init__(self, name: str, *, optional: bool=False, description: str | None=None):
         super().__init__(name, optional=optional, description=description)
         #: Name of server where database is located
         self.server: StrOption = \
@@ -218,7 +231,7 @@ def __init__(self, name: str):
         #: Registered databases
         self.databases: ConfigListOption = \
             ConfigListOption('databases', DatabaseConfig, "Registered databases")
-    def read(self, filenames: str | Iterable, encoding: str=None):
+    def read(self, filenames: str | Iterable, encoding: str | None=None):
         """Read configuration from a filename or an iterable of filenames.
 
         Files that cannot be opened are silently ignored; this is
@@ -249,7 +262,7 @@ def read_string(self, string: str) -> None:
         parser = ConfigParser(interpolation=EnvExtendedInterpolation())
         parser.read_string(string)
         self.load_config(parser)
-    def read_dict(self, dictionary: dict) -> None:
+    def read_dict(self, dictionary: dict[str, str]) -> None:
         """Read configuration from a dictionary.
 
         Keys are section names, values are dictionaries with keys and values
@@ -276,7 +289,7 @@ def get_database(self, name: str) -> DatabaseConfig:
             if db.name == name:
                 return db
         return None
-    def register_server(self, name: str, config: str=None) -> ServerConfig:
+    def register_server(self, name: str, config: str | None=None) -> ServerConfig:
         """Register server.
 
         Arguments:
@@ -298,7 +311,7 @@ def register_server(self, name: str, config: str=None) -> ServerConfig:
             parser.read_string(config)
             srv_config.load_config(parser, name)
         return srv_config
-    def register_database(self, name: str, config: str=None) -> DatabaseConfig:
+    def register_database(self, name: str, config: str | None=None) -> DatabaseConfig:
         """Register database.
 
         Arguments: