Repository navigation
Pyright has issues with some things in 3.10.0 of the api #445
Description
Activity
Yeah, we've noticed both of these recently as well.
I think the BaseEntity typeddict is too strict for the use case of most shotgun codebases and should be replaced with a
Dict[str, Any].The spirit of using a TypedDict is nice, but in practice if you do
sg.find("Version", [...], ["code", "entity"]), you know thatcodeandentityboth exist. The TypedDict requiring that you use.get()instead of accessing it directly is unreasonable.Reacted by dkbarn- added a commit that references this issue
on Jun 15, 2026 class BaseEntity(TypedDict, total=False, extra_items=Any): id: int type: strwould fix the linting errors for extra keys, but needs
typing_extensions.TypedDictinstead of typing.TypedDictReacted by dkbarntotal=Falsemeans that the keys defined are not required, which does not match the API contract that is documented in theShotgun.findmethod. It says::returns: list of dictionaries representing each entity with the requested fields, and the defaults ``"id"`` and ``"type"`` which are always included.If "id" and "type" are always included, then the correct type definition would be:
class BaseEntity(TypedDict, extra_items=Any): id: int type: str
Pyright has issues with some things in 3.10.0 of the api
These two things are really common in our code
from shotgun_api3 import Shotgunhas this warning
"Shotgun" is not exported from module "shotgun_api3" Import from "shotgun_api3.shotgun" instead (Pyright)I assume since
__init__.pydoesn't define an__all__And when accessing any fields returned from the api
asset['code']Could not access item in TypedDict "code" is not a defined key in "BaseEntity" (Pyright)