from chillet.clients import BaseClient

src.chillet.clients.BaseClient

Base building block for both sync and async clients.

Source code in src/chillet/clients.py
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
class BaseClient:
    """Base building block for both sync and async clients."""

    base_url: str
    """Base URL of the Palworld REST API (e.g. ``"http://127.0.0.1:8212"``)"""
    username: str
    """Username used for basic authentication"""
    password: str
    """Password used for basic authentication"""
    auth: tuple[str, str]
    """auth: Tuple used by httpx for basic authentication (``(username, password)``)"""
    timeout: httpx.Timeout
    """Default `httpx.Timeout` applied to all requests."""
    headers: dict[str, str]
    """Default headers sent with every request (defaults to ``{"Accept": "application/json"}``)"""

    def __init__(
        self,
        *,
        base_url: str,
        username: str,
        password: str,
        headers: dict[str, str] | None,
    ) -> None:
        self.base_url = base_url
        self.auth = (username, password)
        self.timeout = httpx.Timeout(connect=5.0, read=10.0, write=10.0, pool=10.0)
        self.headers = headers or {"Accept": "application/json"}

    @staticmethod
    @overload
    def handle_response(response: httpx.Response, response_model: type[ResponseT]) -> ResponseT: ...

    @staticmethod
    @overload
    def handle_response(response: httpx.Response, response_model: None = ...) -> None: ...

    @staticmethod
    def handle_response(
        response: httpx.Response, response_model: type[ResponseT] | None = None
    ) -> ResponseT | None:
        """Map an `httpx.Response` to a typed Pydantic model or `None`."""

        try:
            response.raise_for_status()
        except httpx.HTTPStatusError as e:
            try:
                detail = response.json()
            except Exception:
                detail = response.text
            raise httpx.HTTPStatusError(
                f"{e.request.method} {e.request.url} -> {response.status_code}: {detail}",
                request=e.request,
                response=response,
            ) from None

        if response_model is None:
            return None

        return response_model.model_validate(response.json())

auth = (username, password) instance-attribute

auth: Tuple used by httpx for basic authentication ((username, password))

base_url = base_url instance-attribute

Base URL of the Palworld REST API (e.g. "http://127.0.0.1:8212")

headers = headers or {'Accept': 'application/json'} instance-attribute

Default headers sent with every request (defaults to {"Accept": "application/json"})

password instance-attribute

Password used for basic authentication

timeout = httpx.Timeout(connect=5.0, read=10.0, write=10.0, pool=10.0) instance-attribute

Default httpx.Timeout applied to all requests.

username instance-attribute

Username used for basic authentication

handle_response(response, response_model=None) staticmethod

handle_response(
    response: httpx.Response,
    response_model: type[ResponseT],
) -> ResponseT
handle_response(
    response: httpx.Response, response_model: None = ...
) -> None

Map an httpx.Response to a typed Pydantic model or None.

Source code in src/chillet/clients.py
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@staticmethod
def handle_response(
    response: httpx.Response, response_model: type[ResponseT] | None = None
) -> ResponseT | None:
    """Map an `httpx.Response` to a typed Pydantic model or `None`."""

    try:
        response.raise_for_status()
    except httpx.HTTPStatusError as e:
        try:
            detail = response.json()
        except Exception:
            detail = response.text
        raise httpx.HTTPStatusError(
            f"{e.request.method} {e.request.url} -> {response.status_code}: {detail}",
            request=e.request,
            response=response,
        ) from None

    if response_model is None:
        return None

    return response_model.model_validate(response.json())
from chillet import PalworldClient

src.chillet.clients.PalworldClient

Bases: BaseClient

Synchronous client for the Palworld REST API.

Example
from chillet.clients import PalworldClient

with PalworldClient(username="admin", password="pass") as client:
    metrics = client.get_metrics()
    print(metrics.serverfps)
Source code in src/chillet/clients.py
 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
class PalworldClient(BaseClient):
    """Synchronous client for the Palworld REST API.

    Example:
        ```python
        from chillet.clients import PalworldClient

        with PalworldClient(username="admin", password="pass") as client:
            metrics = client.get_metrics()
            print(metrics.serverfps)
        ```
    """

    client: httpx.Client

    def __init__(
        self,
        *,
        base_url: str = "http://127.0.0.1:8212",
        username: str = "admin",
        password: str,
        headers: dict[str, str] | None = None,
    ) -> None:
        super().__init__(base_url=base_url, username=username, password=password, headers=headers)
        self.client = httpx.Client(
            base_url=self.base_url, auth=self.auth, timeout=self.timeout, headers=self.headers
        )

    def __enter__(self) -> PalworldClient:
        return self

    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc: BaseException | None,
        tb: TracebackType | None,
    ) -> bool | None:
        self.close()
        return None

    def close(self) -> None:
        """Close the underlying `httpx.Client`."""

        self.client.close()

    @overload
    def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = ...,
        response_model: type[ResponseT],
    ) -> ResponseT: ...

    @overload
    def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = ...,
        response_model: None = ...,
    ) -> None: ...

    def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = None,
        response_model: type[ResponseT] | None = None,
    ) -> ResponseT | None:
        """Low-level request helper used by high-level methods.

        Args:
            method: HTTP method.
            path_template: Path part under `base_url` (e.g. ``"/v1/api/info"``).
            payload: Optional Pydantic request model; serialized as JSON.
            response_model: Optional response model type to validate into.

        Returns:
            Parsed response model or `None` (see `handle_response` contract).
        """

        json_data = None
        if payload:
            json_data = payload.model_dump(exclude_none=True)

        response = self.client.request(
            method,
            url=path_template,
            json=json_data,
        )
        return self.handle_response(response, response_model)

    def get_info(self) -> InfoResponse:
        return self.invoke("GET", "/v1/api/info", response_model=InfoResponse)

    def get_players(self) -> PlayersResponse:
        return self.invoke("GET", "/v1/api/players", response_model=PlayersResponse)

    def get_settings(self) -> SettingsResponse:
        return self.invoke("GET", "/v1/api/settings", response_model=SettingsResponse)

    def get_metrics(self) -> MetricsResponse:
        return self.invoke("GET", "/v1/api/metrics", response_model=MetricsResponse)

    def post_announce(self, message: str) -> None:
        payload = AnnounceRequest(message=message)
        self.invoke("POST", "/v1/api/announce", payload=payload)

    def post_kick(self, *, userid: str, message: str | None = None) -> None:
        payload = KickRequest(userid=userid, message=message)
        self.invoke("POST", "/v1/api/kick", payload=payload)

    def post_ban(self, *, userid: str, message: str | None = None) -> None:
        payload = BanRequest(userid=userid, message=message)
        self.invoke("POST", "/v1/api/ban", payload=payload)

    def post_unban(self, userid: str) -> None:
        payload = UnbanRequest(userid=userid)
        self.invoke("POST", "/v1/api/unban", payload=payload)

    def post_save(self) -> None:
        self.invoke("POST", "/v1/api/save")

    def post_shutdown(self, *, waittime: int, message: str | None = None) -> None:
        payload = ShutdownRequest(waittime=waittime, message=message)
        self.invoke("POST", "/v1/api/shutdown", payload=payload)

    def post_stop(self) -> None:
        self.invoke("POST", "/v1/api/stop")

close()

Close the underlying httpx.Client.

Source code in src/chillet/clients.py
138
139
140
141
def close(self) -> None:
    """Close the underlying `httpx.Client`."""

    self.client.close()

invoke(method, path_template, *, payload=None, response_model=None)

invoke(
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = ...,
    response_model: type[ResponseT],
) -> ResponseT
invoke(
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = ...,
    response_model: None = ...,
) -> None

Low-level request helper used by high-level methods.

Parameters:

Name Type Description Default
method HttpMethod

HTTP method.

required
path_template str

Path part under base_url (e.g. "/v1/api/info").

required
payload RequestT | None

Optional Pydantic request model; serialized as JSON.

None
response_model type[ResponseT] | None

Optional response model type to validate into.

None

Returns:

Type Description
ResponseT | None

Parsed response model or None (see handle_response contract).

Source code in src/chillet/clients.py
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
def invoke(
    self,
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = None,
    response_model: type[ResponseT] | None = None,
) -> ResponseT | None:
    """Low-level request helper used by high-level methods.

    Args:
        method: HTTP method.
        path_template: Path part under `base_url` (e.g. ``"/v1/api/info"``).
        payload: Optional Pydantic request model; serialized as JSON.
        response_model: Optional response model type to validate into.

    Returns:
        Parsed response model or `None` (see `handle_response` contract).
    """

    json_data = None
    if payload:
        json_data = payload.model_dump(exclude_none=True)

    response = self.client.request(
        method,
        url=path_template,
        json=json_data,
    )
    return self.handle_response(response, response_model)
from chillet import AsyncPalworldClient

src.chillet.clients.AsyncPalworldClient

Bases: BaseClient

Asynchronous client for the Palworld REST API.

Example
from chillet.clients import AsyncPalworldClient

async with AsyncPalworldClient(username="admin", password="pass") as client:
    metrics = await client.get_metrics()
    print(metrics.serverfps)
Source code in src/chillet/clients.py
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
class AsyncPalworldClient(BaseClient):
    """Asynchronous client for the Palworld REST API.

    Example:
        ```python
        from chillet.clients import AsyncPalworldClient

        async with AsyncPalworldClient(username="admin", password="pass") as client:
            metrics = await client.get_metrics()
            print(metrics.serverfps)
        ```
    """

    client: httpx.AsyncClient

    def __init__(
        self,
        *,
        base_url: str = "http://127.0.0.1:8212",
        username: str = "admin",
        password: str,
        headers: dict[str, str] | None = None,
    ) -> None:
        super().__init__(base_url=base_url, username=username, password=password, headers=headers)
        self.client = httpx.AsyncClient(
            base_url=self.base_url, auth=self.auth, timeout=self.timeout, headers=self.headers
        )

    async def __aenter__(self) -> AsyncPalworldClient:
        await self.client.__aenter__()
        return self

    async def __aexit__(
        self,
        exc_type: type[BaseException] | None,
        exc: BaseException | None,
        tb: TracebackType | None,
    ) -> bool | None:
        await self.aclose()
        return None

    async def aclose(self) -> None:
        """Close the underlying `httpx.AsyncClient`."""

        await self.client.aclose()

    @overload
    async def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = ...,
        response_model: type[ResponseT],
    ) -> ResponseT: ...

    @overload
    async def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = ...,
        response_model: None = ...,
    ) -> None: ...

    async def invoke(
        self,
        method: HttpMethod,
        path_template: str,
        *,
        payload: RequestT | None = None,
        response_model: type[ResponseT] | None = None,
    ) -> ResponseT | None:
        """Low-level request helper used by high-level methods.

        Args:
            method: HTTP method.
            path_template: Path part under `base_url` (e.g. ``"/v1/api/info"``).
            payload: Optional Pydantic request model; serialized as JSON.
            response_model: Optional response model type to validate into.

        Returns:
            Parsed response model or `None` (see `handle_response` contract).
        """

        json_data = None
        if payload:
            json_data = payload.model_dump(exclude_none=True)

        response = await self.client.request(
            method,
            url=path_template,
            json=json_data,
        )
        return self.handle_response(response, response_model)

    async def get_info(self) -> InfoResponse:
        return await self.invoke("GET", "/v1/api/info", response_model=InfoResponse)

    async def get_players(self) -> PlayersResponse:
        return await self.invoke("GET", "/v1/api/players", response_model=PlayersResponse)

    async def get_settings(self) -> SettingsResponse:
        return await self.invoke("GET", "/v1/api/settings", response_model=SettingsResponse)

    async def get_metrics(self) -> MetricsResponse:
        return await self.invoke("GET", "/v1/api/metrics", response_model=MetricsResponse)

    async def post_announce(self, message: str) -> None:
        payload = AnnounceRequest(message=message)
        await self.invoke("POST", "/v1/api/announce", payload=payload)

    async def post_kick(self, *, userid: str, message: str | None = None) -> None:
        payload = KickRequest(userid=userid, message=message)
        await self.invoke("POST", "/v1/api/kick", payload=payload)

    async def post_ban(self, *, userid: str, message: str | None = None) -> None:
        payload = BanRequest(userid=userid, message=message)
        await self.invoke("POST", "/v1/api/ban", payload=payload)

    async def post_unban(self, userid: str) -> None:
        payload = UnbanRequest(userid=userid)
        await self.invoke("POST", "/v1/api/unban", payload=payload)

    async def post_save(self) -> None:
        await self.invoke("POST", "/v1/api/save")

    async def post_shutdown(self, *, waittime: int, message: str | None = None) -> None:
        payload = ShutdownRequest(waittime=waittime, message=message)
        await self.invoke("POST", "/v1/api/shutdown", payload=payload)

    async def post_stop(self) -> None:
        await self.invoke("POST", "/v1/api/stop")

aclose() async

Close the underlying httpx.AsyncClient.

Source code in src/chillet/clients.py
274
275
276
277
async def aclose(self) -> None:
    """Close the underlying `httpx.AsyncClient`."""

    await self.client.aclose()

invoke(method, path_template, *, payload=None, response_model=None) async

invoke(
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = ...,
    response_model: type[ResponseT],
) -> ResponseT
invoke(
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = ...,
    response_model: None = ...,
) -> None

Low-level request helper used by high-level methods.

Parameters:

Name Type Description Default
method HttpMethod

HTTP method.

required
path_template str

Path part under base_url (e.g. "/v1/api/info").

required
payload RequestT | None

Optional Pydantic request model; serialized as JSON.

None
response_model type[ResponseT] | None

Optional response model type to validate into.

None

Returns:

Type Description
ResponseT | None

Parsed response model or None (see handle_response contract).

Source code in src/chillet/clients.py
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
async def invoke(
    self,
    method: HttpMethod,
    path_template: str,
    *,
    payload: RequestT | None = None,
    response_model: type[ResponseT] | None = None,
) -> ResponseT | None:
    """Low-level request helper used by high-level methods.

    Args:
        method: HTTP method.
        path_template: Path part under `base_url` (e.g. ``"/v1/api/info"``).
        payload: Optional Pydantic request model; serialized as JSON.
        response_model: Optional response model type to validate into.

    Returns:
        Parsed response model or `None` (see `handle_response` contract).
    """

    json_data = None
    if payload:
        json_data = payload.model_dump(exclude_none=True)

    response = await self.client.request(
        method,
        url=path_template,
        json=json_data,
    )
    return self.handle_response(response, response_model)