proxmoxer-stubs - Type annotations for proxmoxer

proxmoxer is a Python library for interacting with the Proxmox REST API, whose compact implementation stands in contrast with the API’s large amount of endpoints.

The library’s implementation does not need to change when endpoints are added or amended in new Proxmox releases, but as a consequence, the few functions which handle those many endpoints have not been annotated in a way that resembles the returned data type of each specific endpoint.

proxmoxer-stubs provides external stub files and data containers for proxmoxer, which it generates from the API documentation’s specification for Proxmox versions 6 to 9.

Static type-checkers may then infer the types of a call chain like this:

typing.reveal_type(
    proxmoxer.ProxmoxAPI().cluster.notifications.endpoints.smtp("argument").get()["mode"]
)

Revealed type is "Literal['insecure'] | Literal['starttls'] | Literal['tls']"