Install

$ pip install supportsx

Description

A Python library that supplies runtime-checkable, fully parameterized, and well-documented protocols for nearly all dunder methods/attributes.

The goal of this library is to expand what is already available in the typing standard library and _typeshed library, as well as add a number of common union protocols. The full list of available protocols can be found in the documentation section.

Example

from typing import Any
import supportsx

def foo(
    value: supportsx.add[Any, int],
    ctm: supportsx.u.ctx_mngr
) -> None:
    with ctm:
        print(value + 1)

from typing import Any
from supportsx import *

def foo(
    value: SupportsAdd[Any, int],
    ctm: SupportsContextManager
) -> None:
    with ctm:
        print(value + 1)

As shown above, there are two ways of referencing each protocol. The preferred method is the one shown first (i.e. supportsx.* for primary protocols and supportsx.u.* for union protocols), as it helps keep the global namespace clear (although at the end of the day, it is up to you).

Documentation

Available Protocols

Below is an exhaustive list all available protocols, which methods/attributes they represent, and the available parameters:

Primary protocols

Union Protocols

Excluded Methods and Attributes

The following methods are available on all objects, and are thus excluded:

The following methods are available on all types, and are thus excluded:

The following attributes are available on all types, and are thus excluded:

Although __slots__ and __dict__ may not appear on an object, protocols for those objects are not currently supported by the Python specification due to the part they play in attribute access.