-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathpty.py
More file actions
402 lines (341 loc) · 17.4 KB
/
pty.py
File metadata and controls
402 lines (341 loc) · 17.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing_extensions import Literal
import httpx
from ..types import pty_connect_params, pty_control_params
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from .._utils import path_template, maybe_transform, async_maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from .._base_client import make_request_options
from ..types.pty_connect_view import PtyConnectView
from ..types.pty_control_result_view import PtyControlResultView
__all__ = ["PtyResource", "AsyncPtyResource"]
class PtyResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> PtyResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/runloopai/api-client-python#accessing-raw-response-data-eg-headers
"""
return PtyResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> PtyResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/runloopai/api-client-python#with_streaming_response
"""
return PtyResourceWithStreamingResponse(self)
def connect(
self,
session_name: str,
*,
cols: int | Omit = omit,
rows: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PtyConnectView:
"""
Looks up the PTY session identified by the path session*name and either
reconnects to the existing session or creates it if it does not yet exist. The
session_name is a client-chosen session identifier, not an opaque server-issued
ID. It must be non-empty (1..=256 chars) and use only ASCII letters, digits, '-'
and '*'. A newly created PTY session starts an interactive bash shell on the
Devbox. Optional cols and rows query parameters apply an initial terminal size
before any I/O; they must both be present and in the range 1..=1000 to take
effect. The response returns a PtyConnectView containing connect_url (a
server-relative path to the WebSocket data plane), idle_ttl_seconds (how long
this session is retained after the last client disconnects), and the resulting
cols/rows. The interactive terminal byte stream is exchanged over the WebSocket
data plane and is not modeled in this OpenAPI contract; clients should connect
to connect_url and exchange raw binary frames for terminal I/O. The
single-attach contract is enforced when a client opens the WebSocket data plane,
not on this bootstrap call: bootstrap always succeeds for a valid session_name,
even if another client is currently attached. Rejection of a second concurrent
attach happens at WebSocket upgrade time. If the active client disconnects, the
session is preserved for the idle TTL so a later connect using the same
session_name resumes the same shell. After the TTL expires, after an explicit
close control action, or after the underlying Devbox lifecycle replaces the PTY
process (such as through suspend/resume), a later request with the same
session_name creates a fresh PTY session without the previous shell state.
Args:
cols: Optional initial terminal width in character cells (1..=1000). Defaults to 80
when omitted. Applied only if both cols and rows are provided; otherwise
ignored.
rows: Optional initial terminal height in character cells (1..=1000). Defaults to 24
when omitted. Applied only if both cols and rows are provided; otherwise
ignored.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not session_name:
raise ValueError(f"Expected a non-empty value for `session_name` but received {session_name!r}")
return self._get(
path_template("/pty/{session_name}", session_name=session_name),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"cols": cols,
"rows": rows,
},
pty_connect_params.PtyConnectParams,
),
),
cast_to=PtyConnectView,
)
def control(
self,
session_name: str,
*,
action: Literal["resize", "signal", "close"] | Omit = omit,
cols: int | Omit = omit,
rows: int | Omit = omit,
signal: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
idempotency_key: str | None = None,
) -> PtyControlResultView:
"""Applies a PTY control operation to an existing session.
The action field selects
the operation; the other fields in PtyControlParameters are interpreted only
when they are relevant to the chosen action.
resize: cols and rows are required and must each be in 1..=1000. A 0 or
out-of-range value returns 400. The new winsize is applied to the PTY master and
the kernel delivers SIGWINCH to the foreground process group.
signal: signal is the POSIX signal name (for example 'SIGTERM', 'SIGHUP',
'SIGINT', 'SIGUSR1'). Unknown signal names return 400. The signal is delivered
to the slave's foreground process group via killpg(2). If the shell has already
exited and there is no foreground process group, returns 400.
close: terminates the session. Sends SIGHUP to the foreground process group
(best-effort; ignored if the shell has already exited) and drops the session
from the server's session cache. A subsequent connect with the same session_name
will create a fresh PTY session.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not session_name:
raise ValueError(f"Expected a non-empty value for `session_name` but received {session_name!r}")
return self._post(
path_template("/pty/{session_name}/control", session_name=session_name),
body=maybe_transform(
{
"action": action,
"cols": cols,
"rows": rows,
"signal": signal,
},
pty_control_params.PtyControlParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=PtyControlResultView,
)
class AsyncPtyResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncPtyResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/runloopai/api-client-python#accessing-raw-response-data-eg-headers
"""
return AsyncPtyResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncPtyResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/runloopai/api-client-python#with_streaming_response
"""
return AsyncPtyResourceWithStreamingResponse(self)
async def connect(
self,
session_name: str,
*,
cols: int | Omit = omit,
rows: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> PtyConnectView:
"""
Looks up the PTY session identified by the path session*name and either
reconnects to the existing session or creates it if it does not yet exist. The
session_name is a client-chosen session identifier, not an opaque server-issued
ID. It must be non-empty (1..=256 chars) and use only ASCII letters, digits, '-'
and '*'. A newly created PTY session starts an interactive bash shell on the
Devbox. Optional cols and rows query parameters apply an initial terminal size
before any I/O; they must both be present and in the range 1..=1000 to take
effect. The response returns a PtyConnectView containing connect_url (a
server-relative path to the WebSocket data plane), idle_ttl_seconds (how long
this session is retained after the last client disconnects), and the resulting
cols/rows. The interactive terminal byte stream is exchanged over the WebSocket
data plane and is not modeled in this OpenAPI contract; clients should connect
to connect_url and exchange raw binary frames for terminal I/O. The
single-attach contract is enforced when a client opens the WebSocket data plane,
not on this bootstrap call: bootstrap always succeeds for a valid session_name,
even if another client is currently attached. Rejection of a second concurrent
attach happens at WebSocket upgrade time. If the active client disconnects, the
session is preserved for the idle TTL so a later connect using the same
session_name resumes the same shell. After the TTL expires, after an explicit
close control action, or after the underlying Devbox lifecycle replaces the PTY
process (such as through suspend/resume), a later request with the same
session_name creates a fresh PTY session without the previous shell state.
Args:
cols: Optional initial terminal width in character cells (1..=1000). Defaults to 80
when omitted. Applied only if both cols and rows are provided; otherwise
ignored.
rows: Optional initial terminal height in character cells (1..=1000). Defaults to 24
when omitted. Applied only if both cols and rows are provided; otherwise
ignored.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not session_name:
raise ValueError(f"Expected a non-empty value for `session_name` but received {session_name!r}")
return await self._get(
path_template("/pty/{session_name}", session_name=session_name),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=await async_maybe_transform(
{
"cols": cols,
"rows": rows,
},
pty_connect_params.PtyConnectParams,
),
),
cast_to=PtyConnectView,
)
async def control(
self,
session_name: str,
*,
action: Literal["resize", "signal", "close"] | Omit = omit,
cols: int | Omit = omit,
rows: int | Omit = omit,
signal: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
idempotency_key: str | None = None,
) -> PtyControlResultView:
"""Applies a PTY control operation to an existing session.
The action field selects
the operation; the other fields in PtyControlParameters are interpreted only
when they are relevant to the chosen action.
resize: cols and rows are required and must each be in 1..=1000. A 0 or
out-of-range value returns 400. The new winsize is applied to the PTY master and
the kernel delivers SIGWINCH to the foreground process group.
signal: signal is the POSIX signal name (for example 'SIGTERM', 'SIGHUP',
'SIGINT', 'SIGUSR1'). Unknown signal names return 400. The signal is delivered
to the slave's foreground process group via killpg(2). If the shell has already
exited and there is no foreground process group, returns 400.
close: terminates the session. Sends SIGHUP to the foreground process group
(best-effort; ignored if the shell has already exited) and drops the session
from the server's session cache. A subsequent connect with the same session_name
will create a fresh PTY session.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
idempotency_key: Specify a custom idempotency key for this request
"""
if not session_name:
raise ValueError(f"Expected a non-empty value for `session_name` but received {session_name!r}")
return await self._post(
path_template("/pty/{session_name}/control", session_name=session_name),
body=await async_maybe_transform(
{
"action": action,
"cols": cols,
"rows": rows,
"signal": signal,
},
pty_control_params.PtyControlParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
idempotency_key=idempotency_key,
),
cast_to=PtyControlResultView,
)
class PtyResourceWithRawResponse:
def __init__(self, pty: PtyResource) -> None:
self._pty = pty
self.connect = to_raw_response_wrapper(
pty.connect,
)
self.control = to_raw_response_wrapper(
pty.control,
)
class AsyncPtyResourceWithRawResponse:
def __init__(self, pty: AsyncPtyResource) -> None:
self._pty = pty
self.connect = async_to_raw_response_wrapper(
pty.connect,
)
self.control = async_to_raw_response_wrapper(
pty.control,
)
class PtyResourceWithStreamingResponse:
def __init__(self, pty: PtyResource) -> None:
self._pty = pty
self.connect = to_streamed_response_wrapper(
pty.connect,
)
self.control = to_streamed_response_wrapper(
pty.control,
)
class AsyncPtyResourceWithStreamingResponse:
def __init__(self, pty: AsyncPtyResource) -> None:
self._pty = pty
self.connect = async_to_streamed_response_wrapper(
pty.connect,
)
self.control = async_to_streamed_response_wrapper(
pty.control,
)