Azure / Azure/azure-functions-python-library
Inconsistent naming get_json() in EventGridEvent and EventGridOutputEvent
- Vorherrschende Sprache
- Python
- Sterne
- 179
- Forks
- 79
- Ø Merge
- 2 T. 8 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
Both mentioned classes have methods called `get_json` which return the classes `__data` field. This seems odd for two reasons:
1. They don't actually return JSON but a dict (if the typing hints in `__init__` are correct). In any case this is a major source of confusion.
2. All other getters are implemented as properties. (So why not just do the same here?)
https://github.com/Azure/azure-functions-python-library/blob/44712a77ce6ba68065d1c16ed6015bb998ddfe48/azure/functions/_eventgrid.py#L33-L34
https://github.com/Azure/azure-functions-python-library/blob/44712a77ce6ba68065d1c16ed6015bb998ddfe48/azure/functions/_eventgrid.py#L86-L87
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginnen Sie in azure/functions/_eventgrid.py bei den Zeilen 33–34 und 86–87 und vergleichen Sie dann diese Zugriffsmethoden mit den anderen Gettern auf EventGridEvent und EventGridOutputEvent. Sorgen Sie für eine konsistente Benennung und ein konsistentes Property-Verhalten und bestätigen Sie dabei, dass die resultierende API widerspiegelt, ob der Wert ein dict und nicht JSON ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- backend-api-design, cloud
- Issue-Typ
- Refactoring
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100