Skip to content

refactor!(Pane.send_keys): Default suppress_history value to False #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 6, 2022
Merged

refactor!(Pane.send_keys): Default suppress_history value to False #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0d227a
refactor!(Pane.send_keys): Default suppress_history value to False
tony Aug 6, 2022
605e803
docs(CHANGES): Note send_keys default value change
tony Aug 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ $ pip install --user --upgrade --pre libtmux

- _Insert changes/features/fixes for next release here_

### Breaking changes

- `Pane.send_keys`: `suppress_history` default value changed from `True` to
`False`

### Tests and docs

- Initial [doctests] examples stubbed out {issue}`#394`
Expand Down
10 changes: 7 additions & 3 deletions libtmux/pane.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def send_keys(
self,
cmd: str,
enter: t.Optional[bool] = True,
suppress_history: t.Optional[bool] = True,
suppress_history: t.Optional[bool] = False,
literal: t.Optional[bool] = False,
) -> None:
r"""``$ tmux send-keys`` to the pane.
Expand All @@ -145,7 +145,11 @@ def send_keys(
enter : bool, optional
Send enter after sending the input, default True.
suppress_history : bool, optional
Don't add these keys to the shell history, default True.
Prepend a space to command to suppress shell history, default False.

.. versionchanged:: 0.14

Default changed from True to False.
literal : bool, optional
Send keys literally, default True.

Expand All @@ -155,7 +159,7 @@ def send_keys(
>>> pane.capture_pane()
['$']

>>> pane.send_keys('echo "Hello world"', suppress_history=False, enter=True)
>>> pane.send_keys('echo "Hello world"', enter=True)

>>> pane.capture_pane()
['$ echo "Hello world"', 'Hello world', '$']
Expand Down