Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

exception libtmux latest

MultipleObjectsReturned

A lookup expected one object and matched several.

Base types LibTmuxException
Source and package
Qualified name
libtmux.exc.MultipleObjectsReturned
Module
libtmux.exc
Package
libtmux
Source
src/libtmux/exc.py
exception libtmux.exc.MultipleObjectsReturned

Description#

Raised by get(). Unlike ObjectDoesNotExist, a default does not suppress it: a default is a stand-in for an object that is absent, and an ambiguous lookup is not an absent one. Silently answering with one of several equally valid matches is how you end up driving the wrong pane.

On a server-wide collection, several matches for a single id is ordinary and means the window is linked into more than one session. See winlinks for what to do about it.

Examples#

>>> from libtmux import exc
>>> str(exc.MultipleObjectsReturned())
'Multiple objects returned'

A lookup that matched too much reports how much, and for what:

>>> str(exc.MultipleObjectsReturned(count=2, query={"pane_id": "%0"}))
"Multiple objects returned (2): pane_id='%0'"

It is part of the LibTmuxException hierarchy, so except LibTmuxException catches it:

>>> issubclass(exc.MultipleObjectsReturned, exc.LibTmuxException)
True

Members1#

Inherited members1 member#

Reached through libtmux.exc.LibTmuxException.

Guides#

Pages that discuss MultipleObjectsReturned.

Esc

Type to search.

Reference previewOpen reference