sqltypes.Enum not generic enough

Abierto
  • ¿Algo no está bien?
#11,597 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

  • #13492 de @waterWang — cerrado sin fusionar

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
databases

Línea de trabajo

Comienza en lib/sqlalchemy/sql/sqltypes.py, en las definiciones de String y Enum, y luego lee la discusión enlazada sobre el error de pyright y los cambios de tipado propuestos. Comprueba el ejemplo que usa Enum(MyEnum, native_enum=False) y column_property; se considera terminado cuando el tipado genérico de Enum admite ese uso sin la queja de pyright indicada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug datatypes typing
Discussed in https://github.com/sqlalchemy/sqlalchemy/discussions/11548

The generic type for Enum needs to be a typevar for pyright:

from __future__ import annotations

import enum

from sqlalchemy import Enum
from sqlalchemy import func
from sqlalchemy.orm import column_property
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column

class MyEnum(enum.Enum):
    one = "one"
    two = "two"



class Base(DeclarativeBase):
    pass


class A(Base):
    __tablename__ = "a"

    id: Mapped[int] = mapped_column(primary_key=True)
    data: Mapped[MyEnum] = column_property(
        func.some_func(type_=Enum(MyEnum, native_enum=False))
    )

image

seems to pass in mypy

a quick fix looks like:

@@ -1179,8 +1186,9 @@ class SchemaType(SchemaEventTarget, TypeEngineMixin):
         elif dialect.name not in variant_mapping:
             return _we_are_the_impl(variant_mapping["_default"])
 
+_TEE = TypeVar("_TEE", bound=Union[str, enum.Enum])
 
-class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
+class Enum(String, SchemaType, Emulated, TypeEngine[_TEE]):
     """Generic Enum Type.
 
     The :class:`.Enum` type provides a set of possible string values
@@ -1483,7 +1491,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
             self.enum_class = None
             return enums, enums
 
-    def _resolve_for_literal(self, value: Any) -> Enum:
+    def _resolve_for_literal(self, value: Any) -> Enum[Any]:
         tv = type(value)
         typ = self._resolve_for_python_type(tv, tv, tv)
         assert typ is not None
@@ -1494,7 +1502,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
         python_type: Type[Any],
         matched_on: _MatchedOnType,
         matched_on_flattened: Type[Any],
-    ) -> Optional[Enum]:
+    ) -> Optional[Enum[Any]]:
         # "generic form" indicates we were placed in a type map
         # as ``sqlalchemy.Enum(enum.Enum)`` which indicates we need to
         # get enumerated values from the datatype
@@ -1538,7 +1546,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
 
         kw["length"] = NO_ARG if self.length == 0 else self.length
         return cast(
-            Enum,
+            Enum[Any],
             self._generic_type_affinity(_enums=enum_args, **kw),  # type: ignore  # noqa: E501
         )

to go further we might want to remove String from Enum's inherits, since pyright still complains about the signature

diff --git a/lib/sqlalchemy/sql/sqltypes.py b/lib/sqlalchemy/sql/sqltypes.py
index c20df07a6..f948ee01d 100644
--- a/lib/sqlalchemy/sql/sqltypes.py
+++ b/lib/sqlalchemy/sql/sqltypes.py
@@ -256,6 +256,13 @@ class String(Concatenable, TypeEngine[str]):
         return dbapi.STRING
 
 
+if TYPE_CHECKING:
+    class StringNoGeneric(Concatenable):
+        pass
+else:
+    StringNoGeneric = String
+
+
 class Text(String):
     """A variably sized string type.
 
@@ -1179,8 +1186,9 @@ class SchemaType(SchemaEventTarget, TypeEngineMixin):
         elif dialect.name not in variant_mapping:
             return _we_are_the_impl(variant_mapping["_default"])
 
+_TEE = TypeVar("_TEE", bound=Union[str, enum.Enum])
 
-class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
+class Enum(StringNoGeneric, SchemaType, Emulated, TypeEngine[_TEE]):
     """Generic Enum Type.
 
     The :class:`.Enum` type provides a set of possible string values
@@ -1483,7 +1491,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
             self.enum_class = None
             return enums, enums
 
-    def _resolve_for_literal(self, value: Any) -> Enum:
+    def _resolve_for_literal(self, value: Any) -> Enum[Any]:
         tv = type(value)
         typ = self._resolve_for_python_type(tv, tv, tv)
         assert typ is not None
@@ -1494,7 +1502,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
         python_type: Type[Any],
         matched_on: _MatchedOnType,
         matched_on_flattened: Type[Any],
-    ) -> Optional[Enum]:
+    ) -> Optional[Enum[Any]]:
         # "generic form" indicates we were placed in a type map
         # as ``sqlalchemy.Enum(enum.Enum)`` which indicates we need to
         # get enumerated values from the datatype
@@ -1538,7 +1546,7 @@ class Enum(String, SchemaType, Emulated, TypeEngine[Union[str, enum.Enum]]):
 
         kw["length"] = NO_ARG if self.length == 0 else self.length
         return cast(
-            Enum,
+            Enum[Any],
             self._generic_type_affinity(_enums=enum_args, **kw),  # type: ignore  # noqa: E501
         )
Lenguaje dominante
Python
Estrellas
12.3k
Forks
1.8k
Merge medio
2 d 10 h
PR fusionados (30 d)
9

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de sqlalchemy/sqlalchemy

Todos los issues de sqlalchemy/sqlalchemy

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.