Início / coding / Perguntas / 79229227
Accepted
Matija Sirk
Asked: 2024-11-27 14:55:25 +0800 CST

Como anotar o tipo de Manager().from_queryset()?

  • 772

No Django eu tenho personalizado QuerySete Manager:

from django.db import models

class CustomQuerySet(models.QuerySet):
    def live(self):
        return self.filter(is_draft=False)

class CustomManager(models.Manager):
    def publish(self, instance: "MyModel"):
        instance.is_draft = False
        instance.save()

No meu modelo, quero usar ambos, então uso from_queryseto método:

class MyModel(models.Model):
    objects: CustomManager = CustomManager().from_queryset(CustomQuerySet)()

    is_draft = models.BooleanField(blank=True, default=True)

Como anotei objectscomo CustomManager, Pylance (via vscode) logicamente grita para mim que MyModel.objects.live()está errado, devido a Cannot access attribute "live" for class "CustomManager" Attribute "live" is unknown.

A remoção da anotação de tipo leva a uma reclamação semelhante: Cannot access attribute "live" for class "BaseManager[MyModel]" Attribute "live" is unknown.

Como fazer anotações objectspara MyModelque o Pylance saiba que objectstambém há CustomQuerySetmétodos disponíveis, e não somente CustomManagermétodos?

Olhar para o código-fonte do Django from_queryset constrói uma nova subclasse de CustomManageriterando pelos CustomQuerySetmétodos:

@classmethod
def from_queryset(cls, queryset_class, class_name=None):
    if class_name is None:
        class_name = "%sFrom%s" % (cls.__name__, queryset_class.__name__)
    return type(
        class_name,
        (cls,),
        {
            "_queryset_class": queryset_class,
            **cls._get_queryset_methods(queryset_class),
        },
    )

Então, como @chepner apontou em seu comentário, obtemos um subtipo estrutural de CustomManager, cujo _queryset_classatributo é CustomQuerySet. Então a questão fundamental é: como anotar o tipo dessa subclasse gerada dinamicamente de uma forma pelo menos boa o suficiente para que o verificador de tipos e o preenchimento automático funcionem?

As abordagens que analisei até agora são insatisfatórias:

  1. O Django não faz anotação de tipo no retorno de from_queryset.
  2. Django-types o anota como type[Self], que não possui CustomQuerySetmétodos.
  3. O mesmo com Django-stubs .
python

2 respostas

  1. Best Answer

    CustomManager.from_queryset(CustomQuerySet)cria uma nova subclasse de CustomManagerem tempo de execução que copia um conjunto de atributos de CustomQuerySet. Como tal, a solução "correta" seria definir um protocolo que enumera os atributos copiados pelo private Manager._get_queryset_methodsusado por from_queryset.

    Como isso provavelmente dá muito trabalho (e é frágil, pois depende de detalhes de implementação privados que podem mudar), o método mais amplo e rápido que você propõe de fingir que o objeto é uma instância de ambos CustomManagerpode CustomQuerySetser suficiente para suas necessidades.

    class ManagerQuerySet(CustomManager, CustomQuerySet):
    pass


class MyModel(models.Model):
    objects: ManagerQuerySet = CustomManager().from_queryset(CustomQuerySet)()

    is_draft = models.BooleanField(blank=True, default=True)

    (Realmente, from_querysetparece executar um tipo de herança "estrutural", que pode não ser completa, mas boa o suficiente para permitir a mentira branca de que a nova classe é uma subclasse nominal de CustomQuerySet.)

    • 1

  2. Não parece fazer muito sentido colocá-lo publish(..)no nível de gerente, já que alguém pode querer publicar todos os tipos de QuerySets.

    Normalmente você define isso com QuerySet:

    class CustomQuerySet(models.QuerySet):
    def live(self) -> CustomQuerySet['MyModel']:
        return self.filter(is_draft=False)

    def publish(self):
        return self.update(is_draft=False)

    e então você injeta CustomQuerySetcom:

    class MyModel(models.Model):
    objects: QuerySet['MyModel'] = CustomQuerySet.as_manager()

    Você pode então publicar um conjunto de itens com o QuerySet, como:

    MyModel.objects.filter(pk=1).publish()
    • 0

relate perguntas