In February 2023's dev call, we had some discussion about if we should have HPyDict_GetItem (similar to PyDict_GetItem).
PyDict_GetItem has following semantic differences compared to the generic PyObject_GetItem:
It will suppress any error that occurs during dict key lookup. This includes error raised from the key object's __hash__ and __eq__ methods.
If the first argument is an instance of dict (uses PyDict_Check internally), then it the function will directly access the dict. This means, any overwritten __getitem__ will be ignored.
It returns a borrowed reference.
Arguments for having HPyDict_GetItem:
Usage Frequency: There is one major argument for having HPyDict_GetItem in HPy: PyDict_GetItem is used a lot. On my checkout of the top4000 packages, it is used 658 times (this includes PyDict_GetItemString).
Error Behavior: From a C point of view, it is very convenient to just check for NULL without clearing errors.
Performance: It shortcuts attribute lookup and dispatch and directly accesses the storage.
Arguments against:
Bad API: Everyone seems to agree that this is bad API because it is inconsistent compared to many other functions.
@hodgestar made two suggestions:
If the API is used for performance, the runtime should do the necessary optimizations internally. However, since the semantic is also a bit different, I think we at least need something like HPyBuiltin_GetItem (i.e. don't do an attribute lookup but access storage directly if it is an appropriate built-in type).
If the API is used because of the error behavior, we could introduce HPy_GetItem_NoError to make the behavior clear.
In February 2023's dev call, we had some discussion about if we should have
HPyDict_GetItem(similar toPyDict_GetItem).PyDict_GetItemhas following semantic differences compared to the genericPyObject_GetItem:__hash__and__eq__methods.dict(usesPyDict_Checkinternally), then it the function will directly access the dict. This means, any overwritten__getitem__will be ignored.Arguments for having
HPyDict_GetItem:HPyDict_GetItemin HPy:PyDict_GetItemis used a lot. On my checkout of the top4000 packages, it is used 658 times (this includesPyDict_GetItemString).NULLwithout clearing errors.Arguments against:
@hodgestar made two suggestions:
HPyBuiltin_GetItem(i.e. don't do an attribute lookup but access storage directly if it is an appropriate built-in type).HPy_GetItem_NoErrorto make the behavior clear.