python / python/mypy

Render @property-@name.setter pattern for rw properties in stubgenc

Offen
#15,315 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature topic-descriptors topic-stubgen
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Feature

Currently, stubgen renders the readwrite properties as a plain class field with inferred type. e.g.

in a pybind11 module

cls.def_property("my_property", &MyClass::GetProperty, &MyClass::SetProperty);

will result in

class MyClass:
    my_property: int

Could it be possible to render a @property-@name.setter pair instead, like:

class MyClass:
    @property
    def my_property(self) -> int: ...
    @my_property.setter
    def my_property(self, val: int) -> None: ...

Pitch

This way can more clearly reflect the fact that it is a property. I'm happy to help create a PR for this.

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 damit, die aktuelle Behandlung von Readwrite-Eigenschaften durch stubgenc zu lokalisieren, und untersuche, wie abgeleitete Klassenfelder ausgegeben werden. Die Arbeit ist abgeschlossen, wenn der generierte Stub das angeforderte Paar aus @property und @name.setter verwendet, wobei die Getter- und Setter-Annotationen wie im Issue gezeigt dargestellt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

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