Migration notes

Migration and deprecation notes for libtmux are here, see Changelog as well.

Welcome on board! 👋

1. 📌 For safety, always pin the package

2. 📖 Check the migration notes (You are here)

3. 📣 If you feel something got deprecated and it interrupted you - past, present, or future - voice your opinion on the tracker.

   We want to make libtmux fun, reliable, and useful for users.

   API changes can be painful.

   If we can do something to draw the sting, we’ll do it. We’re taking a balanced approach. That’s why these notes are here!

   (Please pin the package. 🙏)

Next release

Migration instructions for the upcoming release will be added here

0.17.0: Simplified attributes (2022-12-26)

Finding objects / relations

• 0.16 and below: session._windows(), session.list_windows(), etc.

  0.17 and after: session.windows

• 0.16 and below: session.find_where({'window_name': my_window})

  0.17 and after: session.windows.get(window_name=my_window, default=None)

  • If not found and not default, raises ObjectDoesNotExist

  • If multiple objects found, raises MultipleObjectsReturned

• 0.16 and below: session.where({'window_name': my_window})

  0.17 and after: session.windows.filter(window_name=my_window)

Accessing attributes

• 0.16 and below: window['id']

  0.17 and after: window.id

• 0.16 and below: window.get('id')

  0.17 and after: window.id

• 0.16 and below: window.get('id', None)

  0.17 and after: getattr(window, 'id', None)