Skip to content

Commit 28349a8

Browse files
tonytony
committed
MIGRATION(docs[deprecations]): Add Raises column to deprecation tables
why: Document when deprecated APIs start raising DeprecatedError as the final warning before removal. what: - Add "Raises" column with v0.51.0 to Method Renamings table - Add "Raises" column with v0.51.0 to Property Renamings table - Add "Raises" column with v0.51.0 to Parameter Changes table - Add "Raises" column with v0.51.0 to Query/Filter API Changes table - Add "Raises" column with v0.51.0 to Attribute Access Changes table
1 parent 48756be commit 28349a8

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

‎MIGRATION‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -26,66 +26,66 @@ sections below for detailed migration examples and code samples.
2626

2727
### Method Renamings
2828

29-
| Class | Deprecated | Replacement | Since |
30-
|-------|------------|-------------|-------|
31-
| Server | `kill_server()` | `kill()` | 0.30.0 (2024-02-16) |
32-
| Session | `attach_session()` | `attach()` | 0.30.0 (2024-02-16) |
33-
| Session | `kill_session()` | `kill()` | 0.30.0 (2024-02-16) |
34-
| Window | `select_window()` | `select()` | 0.30.0 (2024-02-16) |
35-
| Window | `kill_window()` | `kill()` | 0.30.0 (2024-02-16) |
36-
| Window | `split_window()` | `split()` | 0.33.0 (2024-03-17) |
37-
| Window | `set_window_option()` | `set_option()` | 0.50.0 (2025-11-30) |
38-
| Window | `show_window_option()` | `show_option()` | 0.50.0 (2025-11-30) |
39-
| Window | `show_window_options()` | `show_options()` | 0.50.0 (2025-11-30) |
40-
| Pane | `select_pane()` | `select()` | 0.30.0 (2024-02-16) |
41-
| Pane | `resize_pane()` | `resize()` | 0.28.0 (2024-02-14) |
42-
| Pane | `split_window()` | `split()` | 0.33.0 (2024-03-17) |
29+
| Class | Deprecated | Replacement | Since | Raises |
30+
|-------|------------|-------------|-------|--------|
31+
| Server | `kill_server()` | `kill()` | 0.30.0 (2024-02-16) | 0.51.0 |
32+
| Session | `attach_session()` | `attach()` | 0.30.0 (2024-02-16) | 0.51.0 |
33+
| Session | `kill_session()` | `kill()` | 0.30.0 (2024-02-16) | 0.51.0 |
34+
| Window | `select_window()` | `select()` | 0.30.0 (2024-02-16) | 0.51.0 |
35+
| Window | `kill_window()` | `kill()` | 0.30.0 (2024-02-16) | 0.51.0 |
36+
| Window | `split_window()` | `split()` | 0.33.0 (2024-03-17) | 0.51.0 |
37+
| Window | `set_window_option()` | `set_option()` | 0.50.0 (2025-11-30) | 0.51.0 |
38+
| Window | `show_window_option()` | `show_option()` | 0.50.0 (2025-11-30) | 0.51.0 |
39+
| Window | `show_window_options()` | `show_options()` | 0.50.0 (2025-11-30) | 0.51.0 |
40+
| Pane | `select_pane()` | `select()` | 0.30.0 (2024-02-16) | 0.51.0 |
41+
| Pane | `resize_pane()` | `resize()` | 0.28.0 (2024-02-14) | 0.51.0 |
42+
| Pane | `split_window()` | `split()` | 0.33.0 (2024-03-17) | 0.51.0 |
4343

4444
### Property Renamings
4545

46-
| Class | Deprecated | Replacement | Since |
47-
|-------|------------|-------------|-------|
48-
| Session | `attached_window` | `active_window` | 0.31.0 (2024-02-17) |
49-
| Session | `attached_pane` | `active_pane` | 0.31.0 (2024-02-17) |
50-
| Window | `attached_pane` | `active_pane` | 0.31.0 (2024-02-17) |
46+
| Class | Deprecated | Replacement | Since | Raises |
47+
|-------|------------|-------------|-------|--------|
48+
| Session | `attached_window` | `active_window` | 0.31.0 (2024-02-17) | 0.51.0 |
49+
| Session | `attached_pane` | `active_pane` | 0.31.0 (2024-02-17) | 0.51.0 |
50+
| Window | `attached_pane` | `active_pane` | 0.31.0 (2024-02-17) | 0.51.0 |
5151

5252
### Parameter Changes
5353

54-
| Method(s) | Deprecated | Replacement | Since |
55-
|-----------|------------|-------------|-------|
56-
| Options/hooks methods | `g` | `global_` | 0.50.0 (2025-11-30) |
57-
| `split_window()` / `split()` | `percent` | `size` | 0.28.0 (2024-02-14) |
58-
| `split_window()` / `split()` | `vertical`/`horizontal` | `direction` (PaneDirection) | 0.33.0 (2024-03-17) |
59-
| `resize_pane()` | `-U`, `-D`, `-L`, `-R` | `adjustment_direction` | 0.28.0 (2024-02-14) |
60-
| `Server.get_by_id()` | `id` | `session_id` | 0.16.0 (2022-12-10) |
61-
| `Session.get_by_id()` | `id` | `window_id` | 0.16.0 (2022-12-10) |
62-
| `Window.get_by_id()` | `id` | `pane_id` | 0.16.0 (2022-12-10) |
54+
| Method(s) | Deprecated | Replacement | Since | Raises |
55+
|-----------|------------|-------------|-------|--------|
56+
| Options/hooks methods | `g` | `global_` | 0.50.0 (2025-11-30) | 0.51.0 |
57+
| `split_window()` / `split()` | `percent` | `size` | 0.28.0 (2024-02-14) | 0.51.0 |
58+
| `split_window()` / `split()` | `vertical`/`horizontal` | `direction` (PaneDirection) | 0.33.0 (2024-03-17) | 0.51.0 |
59+
| `resize_pane()` | `-U`, `-D`, `-L`, `-R` | `adjustment_direction` | 0.28.0 (2024-02-14) | 0.51.0 |
60+
| `Server.get_by_id()` | `id` | `session_id` | 0.16.0 (2022-12-10) | 0.51.0 |
61+
| `Session.get_by_id()` | `id` | `window_id` | 0.16.0 (2022-12-10) | 0.51.0 |
62+
| `Window.get_by_id()` | `id` | `pane_id` | 0.16.0 (2022-12-10) | 0.51.0 |
6363

6464
### Query/Filter API Changes
6565

66-
| Class | Deprecated | Replacement | Since |
67-
|-------|------------|-------------|-------|
68-
| Server | `list_sessions()` / `_list_sessions()` | `sessions` property | 0.17.0 (2022-12-26) |
69-
| Server | `where({...})` | `sessions.filter(**kwargs)` | 0.17.0 (2022-12-26) |
70-
| Server | `find_where({...})` | `sessions.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) |
71-
| Server | `get_by_id(id)` | `sessions.get(session_id=..., default=None)` | 0.16.0 (2022-12-10) |
72-
| Session | `list_windows()` / `_list_windows()` | `windows` property | 0.17.0 (2022-12-26) |
73-
| Session | `where({...})` | `windows.filter(**kwargs)` | 0.17.0 (2022-12-26) |
74-
| Session | `find_where({...})` | `windows.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) |
75-
| Session | `get_by_id(id)` | `windows.get(window_id=..., default=None)` | 0.16.0 (2022-12-10) |
76-
| Window | `list_panes()` / `_list_panes()` | `panes` property | 0.17.0 (2022-12-26) |
77-
| Window | `where({...})` | `panes.filter(**kwargs)` | 0.17.0 (2022-12-26) |
78-
| Window | `find_where({...})` | `panes.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) |
79-
| Window | `get_by_id(id)` | `panes.get(pane_id=..., default=None)` | 0.16.0 (2022-12-10) |
80-
| All | `children` property | `sessions`/`windows`/`panes` | 0.17.0 (2022-12-26) |
66+
| Class | Deprecated | Replacement | Since | Raises |
67+
|-------|------------|-------------|-------|--------|
68+
| Server | `list_sessions()` / `_list_sessions()` | `sessions` property | 0.17.0 (2022-12-26) | 0.51.0 |
69+
| Server | `where({...})` | `sessions.filter(**kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
70+
| Server | `find_where({...})` | `sessions.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
71+
| Server | `get_by_id(id)` | `sessions.get(session_id=..., default=None)` | 0.16.0 (2022-12-10) | 0.51.0 |
72+
| Session | `list_windows()` / `_list_windows()` | `windows` property | 0.17.0 (2022-12-26) | 0.51.0 |
73+
| Session | `where({...})` | `windows.filter(**kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
74+
| Session | `find_where({...})` | `windows.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
75+
| Session | `get_by_id(id)` | `windows.get(window_id=..., default=None)` | 0.16.0 (2022-12-10) | 0.51.0 |
76+
| Window | `list_panes()` / `_list_panes()` | `panes` property | 0.17.0 (2022-12-26) | 0.51.0 |
77+
| Window | `where({...})` | `panes.filter(**kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
78+
| Window | `find_where({...})` | `panes.get(default=None, **kwargs)` | 0.17.0 (2022-12-26) | 0.51.0 |
79+
| Window | `get_by_id(id)` | `panes.get(pane_id=..., default=None)` | 0.16.0 (2022-12-10) | 0.51.0 |
80+
| All | `children` property | `sessions`/`windows`/`panes` | 0.17.0 (2022-12-26) | 0.51.0 |
8181

8282
### Attribute Access Changes
8383

84-
| Pattern | Deprecated | Replacement | Since |
85-
|---------|------------|-------------|-------|
86-
| Dict key access | `obj['key']` | `obj.key` | 0.17.0 (2022-12-26) |
87-
| Dict get | `obj.get('key')` | `obj.key` | 0.17.0 (2022-12-26) |
88-
| Dict get w/ default | `obj.get('key', None)` | `getattr(obj, 'key', None)` | 0.17.0 (2022-12-26) |
84+
| Pattern | Deprecated | Replacement | Since | Raises |
85+
|---------|------------|-------------|-------|--------|
86+
| Dict key access | `obj['key']` | `obj.key` | 0.17.0 (2022-12-26) | 0.51.0 |
87+
| Dict get | `obj.get('key')` | `obj.key` | 0.17.0 (2022-12-26) | 0.51.0 |
88+
| Dict get w/ default | `obj.get('key', None)` | `getattr(obj, 'key', None)` | 0.17.0 (2022-12-26) | 0.51.0 |
8989

9090
### Removed Items
9191

0 commit comments

Comments
 (0)