Change Session.info type annotation from Mapping to MutableMapping (#144)

* Change `Session.info` type annotation from Mapping to MutableMapping

Fixes #143

* Change the `info` prop to MutableMapping in other classes as well

Author: Parnassius

sqlalchemy-stubs/engine/base.pyi

@@ -1,6 +1,7 @@
 from typing import Any
 from typing import Dict
 from typing import List
+from typing import MutableMapping
 from typing import Optional
 from typing import TypeVar
 from typing import Union
@@ -65,7 +66,7 @@ class Connection(Connectable):
     @property
     def default_isolation_level(self) -> Any: ...
     @property
-    def info(self) -> Dict[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
     def connect(self: _TConnection, close_with_result: bool = ...) -> _TConnection: ...  # type: ignore[override]
     def invalidate(self, exception: Optional[Any] = ...) -> None: ...
     def detach(self) -> None: ...

sqlalchemy-stubs/ext/asyncio/engine.pyi

@@ -2,6 +2,7 @@ from typing import Any
 from typing import Callable
 from typing import Generator
 from typing import Mapping
+from typing import MutableMapping
 from typing import NoReturn
 from typing import Optional
 from typing import TypeVar
@@ -48,7 +49,7 @@ class AsyncConnection(
     def connection(self) -> NoReturn: ...
     async def get_raw_connection(self) -> Any: ...
     @property
-    def info(self) -> Mapping[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
     def begin(self) -> AsyncTransaction: ...
     def begin_nested(self) -> AsyncTransaction: ...
     async def invalidate(self, exception: Optional[Any] = ...) -> None: ...

sqlalchemy-stubs/ext/asyncio/session.pyi

@@ -4,6 +4,7 @@ from typing import ContextManager
 from typing import Iterable
 from typing import Iterator
 from typing import Mapping
+from typing import MutableMapping
 from typing import Optional
 from typing import Sequence
 from typing import TypeVar
@@ -140,7 +141,7 @@ class AsyncSession:
         self: _TAsyncSession,
     ) -> ContextManager[_TAsyncSession]: ...
     @util.memoized_property
-    def info(self) -> Mapping[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
 
 class _AsyncSessionContextManager:
     async_session: AsyncSession = ...

sqlalchemy-stubs/orm/session.pyi

@@ -8,6 +8,7 @@ from typing import Iterable
 from typing import Iterator
 from typing import List
 from typing import Mapping
+from typing import MutableMapping
 from typing import Optional
 from typing import overload
 from typing import Sequence
@@ -70,7 +71,7 @@ class _SharedSessionProtocol(Protocol[_T]):
         self: _TSharedSessionProtocol,
     ) -> ContextManager[_TSharedSessionProtocol]: ...
     @util.memoized_property
-    def info(self) -> Mapping[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
     def __contains__(self, instance: Any) -> bool: ...
     def __iter__(self) -> Iterator[Any]: ...
     def add(self, instance: Any, _warn: bool = ...) -> None: ...
@@ -405,7 +406,7 @@ class Session(_SessionClassMethods):
         twophase: bool = ...,
         binds: Optional[Mapping[Any, Union[Connection, Engine]]] = ...,
         enable_baked_queries: bool = ...,
-        info: Optional[Mapping[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
         query_cls: Optional[
             Union[Type[Query[Any]], Callable[..., Query[Any]]]
         ] = ...,
@@ -422,7 +423,7 @@ class Session(_SessionClassMethods):
     def get_transaction(self) -> Optional[SessionTransaction]: ...
     def get_nested_transaction(self) -> Optional[SessionTransaction]: ...
     @util.memoized_property
-    def info(self) -> Mapping[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
     def begin(
         self,
         subtransactions: bool = ...,  # NOTE: Deprecated.
@@ -551,7 +552,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
         @overload
@@ -564,7 +565,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
         @overload
@@ -578,7 +579,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
     else:
@@ -590,7 +591,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
         @overload
@@ -601,7 +602,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
         @overload
@@ -613,7 +614,7 @@ class sessionmaker(_SessionClassMethods, Generic[_TSessionMakerType]):
             autoflush: bool = ...,
             autocommit: bool = ...,  # NOTE: Deprecated.
             expire_on_commit: bool = ...,
-            info: Optional[Mapping[Any, Any]] = ...,
+            info: Optional[MutableMapping[Any, Any]] = ...,
             **kw: Any,
         ) -> None: ...
     # NOTE: The return type of `begin()` isn't technically correct, but since

sqlalchemy-stubs/sql/schema.pyi

@@ -5,7 +5,7 @@ from typing import Generic
 from typing import Iterable
 from typing import Iterator
 from typing import List
-from typing import Mapping
+from typing import MutableMapping
 from typing import Optional
 from typing import overload
 from typing import Sequence
@@ -59,7 +59,7 @@ class SchemaItem(SchemaEventTarget, visitors.Visitable):
     create_drop_stringify_dialect: str = ...
     dispatch: DDLEvents
     @util.memoized_property
-    def info(self) -> Dict[Any, Any]: ...
+    def info(self) -> MutableMapping[Any, Any]: ...
 
 class Table(DialectKWArgs, SchemaItem, TableClause):
     __visit_name__: str = ...
@@ -165,7 +165,7 @@ class Column(DialectKWArgs, SchemaItem, ColumnClause[_TE]):
         doc: Optional[str] = ...,
         key: Optional[str] = ...,
         index: Optional[bool] = ...,
-        info: Mapping[Any, Any] = ...,
+        info: MutableMapping[Any, Any] = ...,
         nullable: bool = ...,
         onupdate: Optional[Any] = ...,
         primary_key: bool = ...,
@@ -188,7 +188,7 @@ class Column(DialectKWArgs, SchemaItem, ColumnClause[_TE]):
         doc: Optional[str] = ...,
         key: Optional[str] = ...,
         index: Optional[bool] = ...,
-        info: Mapping[Any, Any] = ...,
+        info: MutableMapping[Any, Any] = ...,
         nullable: bool = ...,
         onupdate: Optional[Any] = ...,
         primary_key: bool = ...,
@@ -213,7 +213,7 @@ class Column(DialectKWArgs, SchemaItem, ColumnClause[_TE]):
         doc: Optional[str] = ...,
         key: Optional[str] = ...,
         index: Optional[bool] = ...,
-        info: Mapping[Any, Any] = ...,
+        info: MutableMapping[Any, Any] = ...,
         nullable: bool = ...,
         onupdate: Optional[Any] = ...,
         primary_key: bool = ...,
@@ -237,7 +237,7 @@ class Column(DialectKWArgs, SchemaItem, ColumnClause[_TE]):
         doc: Optional[str] = ...,
         key: Optional[str] = ...,
         index: Optional[bool] = ...,
-        info: Mapping[Any, Any] = ...,
+        info: MutableMapping[Any, Any] = ...,
         nullable: bool = ...,
         onupdate: Optional[Any] = ...,
         primary_key: bool = ...,
@@ -279,7 +279,7 @@ class ForeignKey(DialectKWArgs, SchemaItem):
         initially: Optional[str] = ...,
         link_to_name: bool = ...,
         match: Optional[str] = ...,
-        info: Optional[Dict[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
         **dialect_kw: Any,
     ) -> None: ...
     def copy(self: _FK, schema: Optional[str] = ...) -> _FK: ...
@@ -459,7 +459,7 @@ class Constraint(DialectKWArgs, SchemaItem):
         deferrable: Optional[bool] = ...,
         initially: Optional[str] = ...,
         _create_rule: Optional[Any] = ...,
-        info: Optional[Dict[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
         _type_bound: bool = ...,
         **dialect_kw: Any,
     ) -> None: ...
@@ -495,7 +495,7 @@ class CheckConstraint(ColumnCollectionConstraint):
         deferrable: Optional[bool] = ...,
         initially: Optional[str] = ...,
         table: Optional[Table] = ...,
-        info: Optional[Dict[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
         _create_rule: Optional[Any] = ...,
         _autoattach: bool = ...,
         _type_bound: bool = ...,
@@ -528,7 +528,7 @@ class ForeignKeyConstraint(ColumnCollectionConstraint):
         link_to_name: bool = ...,
         match: Optional[str] = ...,
         table: Optional[Table] = ...,
-        info: Optional[Dict[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
         **dialect_kw: Any,
     ) -> None: ...
     @property
@@ -592,7 +592,7 @@ class MetaData(SchemaItem):
         schema: Optional[str] = ...,
         quote_schema: Optional[bool] = ...,
         naming_convention: Optional[Dict[str, str]] = ...,
-        info: Optional[Dict[Any, Any]] = ...,
+        info: Optional[MutableMapping[Any, Any]] = ...,
     ) -> None: ...
     def __contains__(self, table_or_key: Any) -> bool: ...
     def is_bound(self) -> bool: ...