tmux-python / tmux-python/libtmux
⚠️ Imports moving in v0.13: `libtmux.Server` -> `libtmux.server.Server`, etc
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 127
- Avg merge
- 2h 13m
- Merged PRs (30d)
- 1
Description
This can cause tricky circular imports / cyclic dependency issues that get in the way of mypy, MonkeyType, and our API documentation.
Looking for feedback on this.
Is it a deal-breaker for you?
Server
Before
from libtmux import Server
After
from libtmux.server import Server
Session
Before
from libtmux import Session
After
from libtmux.server import Server
Window
Before
from libtmux import Window
After
from libtmux.window import Window
Pane
Before
from libtmux import Pane
After
from libtmux.pane import Pane
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the proposed public imports for Server, Session, Window, and Pane, comparing the current libtmux imports with the libtmux.server, libtmux.window, and libtmux.pane paths shown. Consider the stated circular-import, mypy, MonkeyType, and API-documentation concerns. Done requires a maintainer decision on whether this import change is acceptable; the issue currently requests feedback rather than defining an implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100