Skip to content

boundinstance¤

boundinstance provides InstanceDescriptor, a descriptor that binds weakly to the instance it was accessed from. Assign an instance to a class attribute and subclass InstanceDescriptor to add methods; every access from an instance returns a fresh copy holding a weak reference back to that instance, reachable as enclosing. The instance never gains a strong reference back to itself, so no reference cycle, and nothing keeps it alive past its natural lifetime.

Install¤

pip install boundinstance

No runtime dependencies. Wheels are mypyc-compiled where available, with a pure-Python sdist as the fallback — see Wheels and platforms.

A first example¤

from boundinstance import InstanceDescriptor


class Plot(InstanceDescriptor["Potential"]):
    def label(self) -> str:
        return f"plot of {self.enclosing.name}"


class Potential:
    plot = Plot()

    def __init__(self, name: str) -> None:
        self.name = name


hernquist = Potential("hernquist")
assert hernquist.plot.label() == "plot of hernquist"

That's the whole surface: subclass InstanceDescriptor[EnclosingType], add methods that read self.enclosing, and attach an instance of the subclass as a class attribute.

Where to go next¤