|
27 | 27 | ------------------- |
28 | 28 | This module provides bulk operations for managing multiple indexed hooks: |
29 | 29 |
|
30 | | -- :meth:`~HooksMixin.get_hook_indices` - Get list of existing indices for a hook |
31 | | -- :meth:`~HooksMixin.get_hook_values` - Get all values as SparseArray |
32 | | -- :meth:`~HooksMixin.set_hooks_bulk` - Set multiple hooks at once |
33 | | -- :meth:`~HooksMixin.clear_hook` - Unset all indexed values for a hook |
34 | | -- :meth:`~HooksMixin.append_hook` - Append at next available index |
| 30 | +- :meth:`~HooksMixin.set_hooks` - Set multiple hooks at once |
35 | 31 | """ |
36 | 32 |
|
37 | 33 | from __future__ import annotations |
@@ -492,7 +488,7 @@ def get_hook_values( |
492 | 488 | result: SparseArray[str] = hook_array |
493 | 489 | return result |
494 | 490 |
|
495 | | - def set_hooks_bulk( |
| 491 | + def set_hooks( |
496 | 492 | self, |
497 | 493 | hook: str, |
498 | 494 | values: HookValues, |
@@ -528,39 +524,42 @@ def set_hooks_bulk( |
528 | 524 | -------- |
529 | 525 | Set hooks with explicit indices: |
530 | 526 |
|
531 | | - >>> session.set_hooks_bulk('session-renamed', { |
| 527 | + >>> session.set_hooks('session-renamed', { |
532 | 528 | ... 0: 'display-message "hook 0"', |
533 | 529 | ... 1: 'display-message "hook 1"', |
534 | 530 | ... }) |
535 | 531 | Session($...) |
536 | 532 |
|
537 | | - >>> session.get_hook_indices('session-renamed') |
| 533 | + >>> hooks = session.show_hook('session-renamed') |
| 534 | + >>> sorted(hooks.keys()) |
538 | 535 | [0, 1] |
539 | 536 |
|
540 | 537 | Set hooks from a list (sequential indices): |
541 | 538 |
|
542 | | - >>> session.set_hooks_bulk('after-new-window', [ |
| 539 | + >>> session.set_hooks('after-new-window', [ |
543 | 540 | ... 'select-pane -t 0', |
544 | 541 | ... 'send-keys "clear" Enter', |
545 | 542 | ... ]) |
546 | 543 | Session($...) |
547 | 544 |
|
548 | | - >>> session.get_hook_indices('after-new-window') |
| 545 | + >>> hooks = session.show_hook('after-new-window') |
| 546 | + >>> sorted(hooks.keys()) |
549 | 547 | [0, 1] |
550 | 548 |
|
551 | 549 | Replace all existing hooks with ``clear_existing=True``: |
552 | 550 |
|
553 | | - >>> session.set_hooks_bulk('session-renamed', {0: 'display-message "new"'}, |
554 | | - ... clear_existing=True) |
| 551 | + >>> session.set_hooks('session-renamed', {0: 'display-message "new"'}, |
| 552 | + ... clear_existing=True) |
555 | 553 | Session($...) |
556 | 554 |
|
557 | | - >>> session.get_hook_indices('session-renamed') |
| 555 | + >>> hooks = session.show_hook('session-renamed') |
| 556 | + >>> sorted(hooks.keys()) |
558 | 557 | [0] |
559 | 558 |
|
560 | | - >>> session.clear_hook('session-renamed') |
| 559 | + >>> session.unset_hook('session-renamed') |
561 | 560 | Session($...) |
562 | 561 |
|
563 | | - >>> session.clear_hook('after-new-window') |
| 562 | + >>> session.unset_hook('after-new-window') |
564 | 563 | Session($...) |
565 | 564 | """ |
566 | 565 | if clear_existing: |
|
0 commit comments