python / python/mypy

Problems with wrapper classes

Offen
#5,523 9 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature needs discussion priority-1-normal
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Let's say I have a Person class with a bunch of attributes; it comes from a library I don't control but for which type information exists. Now I have a PersonWrapper class which provides for defaults so that accessing missing attributes never raises an exception (think, use of instances in f-strings).

class PersonWrapper:
    def __init__(self, person: Person, default: Any = '') -> None:
        self.person = person
        self.default = default

    def __getattr__(self, attribute: str) -> Any:
        return getattr(self.person, attribute, self.default)

In general, any place I want to use a Person I might also want to use a PersonWrapper, so I have variables that can be assigned either a Person or a PersonWrapper. mypy seems not to be able to handle this, and I don't really know of any way to tell the type checker that it should treat Person and PersonWrapper as equivalent. For example, if I have this code:

def print_person(original_person: Person) -> None:
    person = PersonWrapper(original_person)
    # This attribute might be missing from the original person object.
    print(f'  Username: {person.username}')
    person = original_person
    # Only print this if the attribute exists.
    phone = getattr(person, 'phoneNumber', None)
    if phone:
        print(f'    Phone: {phone}')

mypy complains about the assignment of original_person to person:

error: Incompatible types in assignment (expression has type "Person", variable has type "PersonWrapper")

Because Person has some dynamic attribute access as well, I can't change the original assignment to:

    person: Person = cast(Person, PersonWrapper(original_person))

because then I get errors such as:

error: "Person" has no attribute "office"

The way I fix this is by changing the second assignment to use cast():

    person = cast(PersonWrapper, original_person)

This feels wrong, but maybe it's okay. What I think i'd like to do is to create an equivalence between PersonWrapper and Person, but then I'd probably still have to handle the dynamic parts of Person in some way. FWIW I didn't have much luck using Union[Person, PersonWrapper] either.

Is there a better way to handle wrapper classes?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem gemeldeten Person/PersonWrapper-Beispiel und dem Zusammenspiel von Zuweisungsinferenz, Union[Person, PersonWrapper], cast() und dynamischem getattr; es wird keine mypy-Quelldatei oder kein Test angegeben. Definiere das gewünschte Typisierungsverhalten und füge einen fokussierten Regressionstest hinzu, sobald ein Implementierungsort identifiziert wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.