Azure / Azure/azure-functions-python-library

Inconsistent naming get_json() in EventGridEvent and EventGridOutputEvent

Open
#159 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
179
Forks
79
Avg merge
2d 8h
Merged PRs (30d)
2

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.