tmux-python / tmux-python/tmuxp
Improve logging for workspacebuilder
Open
Nobody has claimed this yet.
WorkspaceBuilder
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 248
- Avg merge
- 2h 13m
- Merged PRs (30d)
- 1
Description
in re: debugging cases like #364
Requirements / blockers
Requires improvements for libtmux and its subprocess calls
Details
- There's no way to assert the message is raised - except maybe checking pytest's
caplogwith logging turned up to the max. - We need better introspection of events at the libtmux level:
- Being able to trace where in the config / workspacebuilder libtmux methods are being run
- and the
subprocesscalls totmux(1)within those
- and the
- Being able to trace where in the config / workspacebuilder libtmux methods are being run
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
Start by reviewing the config/workspacebuilder paths and libtmux's subprocess calls to tmux(1). Check whether pytest's caplog can assert the relevant messages and identify what event context is currently missing. Done means the required logging and tracing behavior is defined and testable across these paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100