browserbase 1.7.0__tar.gz → 1.9.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {browserbase-1.7.0 → browserbase-1.9.0}/.gitignore +1 -0
- browserbase-1.9.0/.release-please-manifest.json +3 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/CHANGELOG.md +67 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/CONTRIBUTING.md +1 -1
- {browserbase-1.7.0 → browserbase-1.9.0}/PKG-INFO +2 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/api.md +13 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/pyproject.toml +3 -3
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_base_client.py +4 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_client.py +23 -1
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_compat.py +9 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_files.py +54 -4
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_models.py +80 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_qs.py +6 -7
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_types.py +3 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/__init__.py +1 -1
- browserbase-1.9.0/src/browserbase/_utils/_path.py +127 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_utils.py +37 -25
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_version.py +1 -1
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/contexts.py +7 -7
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/extensions.py +8 -7
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/projects.py +5 -4
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/__init__.py +14 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/downloads.py +3 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/logs.py +3 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/recording.py +3 -2
- browserbase-1.9.0/src/browserbase/resources/sessions/replays.py +266 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/sessions.py +41 -9
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/sessions/uploads.py +6 -5
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/search_web_response.py +0 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session.py +1 -1
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_create_params.py +9 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_list_params.py +1 -1
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/__init__.py +1 -0
- browserbase-1.9.0/src/browserbase/types/sessions/replay_retrieve_response.py +25 -0
- browserbase-1.9.0/tests/api_resources/sessions/test_replays.py +242 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_sessions.py +6 -2
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_client.py +48 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_extract_files.py +28 -1
- browserbase-1.9.0/tests/test_files.py +148 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_models.py +57 -3
- browserbase-1.9.0/tests/test_utils/test_path.py +89 -0
- browserbase-1.7.0/.release-please-manifest.json +0 -3
- browserbase-1.7.0/tests/test_deepcopy.py +0 -58
- browserbase-1.7.0/tests/test_files.py +0 -51
- {browserbase-1.7.0 → browserbase-1.9.0}/LICENSE +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/MIGRATION.md +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/README.md +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/SECURITY.md +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/bin/check-release-environment +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/bin/publish-pypi +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/.keep +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/e2e/README.md +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/e2e/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/e2e/test_playwright.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/e2e/test_selenium.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/extensions/.gitignore +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/extensions/browserbase-test/hello.html +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/extensions/browserbase-test/images/logo.png +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/extensions/browserbase-test/manifest.json +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/extensions/browserbase-test/scripts/content.js +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/packages/logo.png +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_basic.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_captcha.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_contexts.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_downloads.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_extensions.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_proxy.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/playwright_upload.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/examples/selenium_basic.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/noxfile.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/release-please-config.json +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/requirements-dev.lock +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/requirements.lock +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_constants.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_exceptions.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_resource.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_streaming.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_compat.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_datetime_parse.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_json.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_logs.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_proxy.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_reflection.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_resources_proxy.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_streams.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_sync.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_transform.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/_utils/_typing.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/lib/.keep +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/py.typed +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/fetch_api.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/resources/search.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/context.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/context_create_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/context_create_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/context_update_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/extension.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/extension_create_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/fetch_api_create_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/fetch_api_create_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/project.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/project_list_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/project_usage.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/search_web_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_create_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_list_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_live_urls.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_retrieve_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/session_update_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/log_list_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/recording_retrieve_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/session_log.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/session_recording.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/upload_create_params.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/src/browserbase/types/sessions/upload_create_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/sessions/__init__.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/sessions/test_downloads.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/sessions/test_logs.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/sessions/test_recording.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/sessions/test_uploads.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_contexts.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_extensions.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_fetch_api.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_projects.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/api_resources/test_search.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/conftest.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/sample_file.txt +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_qs.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_required_args.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_response.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_streaming.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_transform.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_utils/test_datetime_parse.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_utils/test_json.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_utils/test_proxy.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/test_utils/test_typing.py +0 -0
- {browserbase-1.7.0 → browserbase-1.9.0}/tests/utils.py +0 -0
|
@@ -1,5 +1,72 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.9.0 (2026-05-13)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.8.0...v1.9.0](https://github.com/browserbase/sdk-python/compare/v1.8.0...v1.9.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* [CORE-1928][apps/api] Add `PENDING` as a valid session state ([4f1248d](https://github.com/browserbase/sdk-python/commit/4f1248dfb1bf79194f65854a6fcd6a0d53433ba1))
|
|
10
|
+
* [CORE-1979] [apps/api] Regenerate OpenAPI spec to match current routes ([0e366a6](https://github.com/browserbase/sdk-python/commit/0e366a6a0a01e2ce8e661d73f9fa312e56d1a582))
|
|
11
|
+
* **api:** add replays ([58e18df](https://github.com/browserbase/sdk-python/commit/58e18df7d7b0376234a322a197584a7163eba4b4))
|
|
12
|
+
* **internal/types:** support eagerly validating pydantic iterators ([9d56949](https://github.com/browserbase/sdk-python/commit/9d569494a2050437404866315561e341f8e38a92))
|
|
13
|
+
* support setting headers via env ([308d35e](https://github.com/browserbase/sdk-python/commit/308d35edb58454e542fcf58f379061fb742bd83b))
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* **client:** add missing f-string prefix in file type error message ([e01f048](https://github.com/browserbase/sdk-python/commit/e01f0484313315bb9d99338b8486054d53f2b46b))
|
|
19
|
+
* **client:** preserve hardcoded query params when merging with user params ([953fd3e](https://github.com/browserbase/sdk-python/commit/953fd3ecd54a7ffc2ee390eac67f2063df89b8e9))
|
|
20
|
+
* ensure file data are only sent as 1 parameter ([a837357](https://github.com/browserbase/sdk-python/commit/a83735708037eec6cb4807e4220ca7452b5b6503))
|
|
21
|
+
* use correct field name format for multipart file arrays ([9488fb3](https://github.com/browserbase/sdk-python/commit/9488fb39a656b0aaaf740ccec0a9dce57b996b02))
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Performance Improvements
|
|
25
|
+
|
|
26
|
+
* **client:** optimize file structure copying in multipart requests ([4146f22](https://github.com/browserbase/sdk-python/commit/4146f22bb6c054e7491e4c10021dff3e9e2c8824))
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Chores
|
|
30
|
+
|
|
31
|
+
* **internal:** more robust bootstrap script ([83d1f68](https://github.com/browserbase/sdk-python/commit/83d1f686936e4593c3017c719056573089bbd1e0))
|
|
32
|
+
* **internal:** reformat pyproject.toml ([979436a](https://github.com/browserbase/sdk-python/commit/979436a2cb86944f8bf400a2e623e946188d87c1))
|
|
33
|
+
* **tests:** bump steady to v0.22.1 ([bafb680](https://github.com/browserbase/sdk-python/commit/bafb68055a4f36ef6b7d6a308606db9e8d33257b))
|
|
34
|
+
|
|
35
|
+
## 1.8.0 (2026-04-06)
|
|
36
|
+
|
|
37
|
+
Full Changelog: [v1.7.0...v1.8.0](https://github.com/browserbase/sdk-python/compare/v1.7.0...v1.8.0)
|
|
38
|
+
|
|
39
|
+
### Features
|
|
40
|
+
|
|
41
|
+
* [CORE-000][apps/api] Add verified to SDK ([1579bf9](https://github.com/browserbase/sdk-python/commit/1579bf91b323f565abc7bdf54a131cd3e8e2f4d9))
|
|
42
|
+
* **internal:** implement indices array format for query and form serialization ([17a85d5](https://github.com/browserbase/sdk-python/commit/17a85d54d36f45acf242d066b13c49e90b4a2777))
|
|
43
|
+
* Update search docs by removing description from typebox schemas ([7913112](https://github.com/browserbase/sdk-python/commit/7913112d697666bf4381119f5962c284bd91b410))
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Bug Fixes
|
|
47
|
+
|
|
48
|
+
* **deps:** bump minimum typing-extensions version ([962e72a](https://github.com/browserbase/sdk-python/commit/962e72a121f27a603f92311917426c9aee84d805))
|
|
49
|
+
* **pydantic:** do not pass `by_alias` unless set ([3e6a912](https://github.com/browserbase/sdk-python/commit/3e6a912dc0a117c2deb229bb5230d2294de3b129))
|
|
50
|
+
* sanitize endpoint path params ([8a63eb5](https://github.com/browserbase/sdk-python/commit/8a63eb5e275eb25849f22cf210d42487e8283078))
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Chores
|
|
54
|
+
|
|
55
|
+
* **ci:** skip lint on metadata-only changes ([80a6a3c](https://github.com/browserbase/sdk-python/commit/80a6a3c61b73be9c2f99fbdd20b2e47e9024fec5))
|
|
56
|
+
* **internal:** tweak CI branches ([9901c59](https://github.com/browserbase/sdk-python/commit/9901c595fa68e1ab213ac22eb06aeebc722edb03))
|
|
57
|
+
* **internal:** update gitignore ([2e3ba9b](https://github.com/browserbase/sdk-python/commit/2e3ba9b833a663b2b355b2b4a4f4d698de731e5e))
|
|
58
|
+
* **tests:** bump steady to v0.19.4 ([f81180d](https://github.com/browserbase/sdk-python/commit/f81180d7502d612aaaab8665740f2cc133da1e80))
|
|
59
|
+
* **tests:** bump steady to v0.19.5 ([10d0b70](https://github.com/browserbase/sdk-python/commit/10d0b70f04059ff66f199b9512ffb4ab11699262))
|
|
60
|
+
* **tests:** bump steady to v0.19.6 ([f9d4f90](https://github.com/browserbase/sdk-python/commit/f9d4f900ca05f245a5ac91b26df8e8a4520ec1d3))
|
|
61
|
+
* **tests:** bump steady to v0.19.7 ([27c797d](https://github.com/browserbase/sdk-python/commit/27c797da65010f04a0cd3d2f42cfef5d6eeb8105))
|
|
62
|
+
* **tests:** bump steady to v0.20.1 ([17f2e35](https://github.com/browserbase/sdk-python/commit/17f2e357b8c9f09c34eec9a3f7a055b3f9c72d14))
|
|
63
|
+
* **tests:** bump steady to v0.20.2 ([85ef397](https://github.com/browserbase/sdk-python/commit/85ef397598b8856217510a081fa5ebecc94819d3))
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### Refactors
|
|
67
|
+
|
|
68
|
+
* **tests:** switch from prism to steady ([39217ea](https://github.com/browserbase/sdk-python/commit/39217ea5ffd68b03900a6272378a3b3a8d5efc4a))
|
|
69
|
+
|
|
3
70
|
## 1.7.0 (2026-03-16)
|
|
4
71
|
|
|
5
72
|
Full Changelog: [v1.6.0...v1.7.0](https://github.com/browserbase/sdk-python/compare/v1.6.0...v1.7.0)
|
|
@@ -85,7 +85,7 @@ $ pip install ./path-to-wheel-file.whl
|
|
|
85
85
|
|
|
86
86
|
## Running tests
|
|
87
87
|
|
|
88
|
-
Most tests require you to [set up a mock server](https://github.com/
|
|
88
|
+
Most tests require you to [set up a mock server](https://github.com/dgellow/steady) against the OpenAPI spec to run the tests.
|
|
89
89
|
|
|
90
90
|
```sh
|
|
91
91
|
$ ./scripts/mock
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: browserbase
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.9.0
|
|
4
4
|
Summary: The official Python library for the Browserbase API
|
|
5
5
|
Project-URL: Homepage, https://github.com/browserbase/sdk-python
|
|
6
6
|
Project-URL: Repository, https://github.com/browserbase/sdk-python
|
|
@@ -27,7 +27,7 @@ Requires-Dist: distro<2,>=1.7.0
|
|
|
27
27
|
Requires-Dist: httpx<1,>=0.23.0
|
|
28
28
|
Requires-Dist: pydantic<3,>=1.9.0
|
|
29
29
|
Requires-Dist: sniffio
|
|
30
|
-
Requires-Dist: typing-extensions<5,>=4.
|
|
30
|
+
Requires-Dist: typing-extensions<5,>=4.14
|
|
31
31
|
Provides-Extra: aiohttp
|
|
32
32
|
Requires-Dist: aiohttp; extra == 'aiohttp'
|
|
33
33
|
Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
|
|
@@ -128,3 +128,16 @@ from browserbase.types.sessions import UploadCreateResponse
|
|
|
128
128
|
Methods:
|
|
129
129
|
|
|
130
130
|
- <code title="post /v1/sessions/{id}/uploads">client.sessions.uploads.<a href="./src/browserbase/resources/sessions/uploads.py">create</a>(id, \*\*<a href="src/browserbase/types/sessions/upload_create_params.py">params</a>) -> <a href="./src/browserbase/types/sessions/upload_create_response.py">UploadCreateResponse</a></code>
|
|
131
|
+
|
|
132
|
+
## Replays
|
|
133
|
+
|
|
134
|
+
Types:
|
|
135
|
+
|
|
136
|
+
```python
|
|
137
|
+
from browserbase.types.sessions import ReplayRetrieveResponse
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Methods:
|
|
141
|
+
|
|
142
|
+
- <code title="get /v1/sessions/{id}/replays">client.sessions.replays.<a href="./src/browserbase/resources/sessions/replays.py">retrieve</a>(id) -> <a href="./src/browserbase/types/sessions/replay_retrieve_response.py">ReplayRetrieveResponse</a></code>
|
|
143
|
+
- <code title="get /v1/sessions/{id}/replays/{pageId}">client.sessions.replays.<a href="./src/browserbase/resources/sessions/replays.py">retrieve_page</a>(page_id, \*, id) -> BinaryAPIResponse</code>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "browserbase"
|
|
3
|
-
version = "1.
|
|
3
|
+
version = "1.9.0"
|
|
4
4
|
description = "The official Python library for the Browserbase API"
|
|
5
5
|
dynamic = ["readme"]
|
|
6
6
|
license = "Apache-2.0"
|
|
@@ -11,7 +11,7 @@ authors = [
|
|
|
11
11
|
dependencies = [
|
|
12
12
|
"httpx>=0.23.0, <1",
|
|
13
13
|
"pydantic>=1.9.0, <3",
|
|
14
|
-
"typing-extensions>=4.
|
|
14
|
+
"typing-extensions>=4.14, <5",
|
|
15
15
|
"anyio>=3.5.0, <5",
|
|
16
16
|
"distro>=1.7.0, <2",
|
|
17
17
|
"sniffio",
|
|
@@ -177,7 +177,7 @@ show_error_codes = true
|
|
|
177
177
|
#
|
|
178
178
|
# We also exclude our `tests` as mypy doesn't always infer
|
|
179
179
|
# types correctly and Pyright will still catch any type errors.
|
|
180
|
-
exclude = [
|
|
180
|
+
exclude = ["src/browserbase/_files.py", "_dev/.*.py", "tests/.*"]
|
|
181
181
|
|
|
182
182
|
strict_equality = true
|
|
183
183
|
implicit_reexport = true
|
|
@@ -540,6 +540,10 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
|
|
|
540
540
|
files = cast(HttpxRequestFiles, ForceMultipartDict())
|
|
541
541
|
|
|
542
542
|
prepared_url = self._prepare_url(options.url)
|
|
543
|
+
# preserve hard-coded query params from the url
|
|
544
|
+
if params and prepared_url.query:
|
|
545
|
+
params = {**dict(prepared_url.params.items()), **params}
|
|
546
|
+
prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
|
|
543
547
|
if "_" in prepared_url.host:
|
|
544
548
|
# work around https://github.com/encode/httpx/discussions/2880
|
|
545
549
|
kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}
|
|
@@ -19,7 +19,11 @@ from ._types import (
|
|
|
19
19
|
RequestOptions,
|
|
20
20
|
not_given,
|
|
21
21
|
)
|
|
22
|
-
from ._utils import
|
|
22
|
+
from ._utils import (
|
|
23
|
+
is_given,
|
|
24
|
+
is_mapping_t,
|
|
25
|
+
get_async_library,
|
|
26
|
+
)
|
|
23
27
|
from ._compat import cached_property
|
|
24
28
|
from ._version import __version__
|
|
25
29
|
from ._streaming import Stream as Stream, AsyncStream as AsyncStream
|
|
@@ -95,6 +99,15 @@ class Browserbase(SyncAPIClient):
|
|
|
95
99
|
if base_url is None:
|
|
96
100
|
base_url = f"https://api.browserbase.com"
|
|
97
101
|
|
|
102
|
+
custom_headers_env = os.environ.get("BROWSERBASE_CUSTOM_HEADERS")
|
|
103
|
+
if custom_headers_env is not None:
|
|
104
|
+
parsed: dict[str, str] = {}
|
|
105
|
+
for line in custom_headers_env.split("\n"):
|
|
106
|
+
colon = line.find(":")
|
|
107
|
+
if colon >= 0:
|
|
108
|
+
parsed[line[:colon].strip()] = line[colon + 1 :].strip()
|
|
109
|
+
default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})}
|
|
110
|
+
|
|
98
111
|
super().__init__(
|
|
99
112
|
version=__version__,
|
|
100
113
|
base_url=base_url,
|
|
@@ -299,6 +312,15 @@ class AsyncBrowserbase(AsyncAPIClient):
|
|
|
299
312
|
if base_url is None:
|
|
300
313
|
base_url = f"https://api.browserbase.com"
|
|
301
314
|
|
|
315
|
+
custom_headers_env = os.environ.get("BROWSERBASE_CUSTOM_HEADERS")
|
|
316
|
+
if custom_headers_env is not None:
|
|
317
|
+
parsed: dict[str, str] = {}
|
|
318
|
+
for line in custom_headers_env.split("\n"):
|
|
319
|
+
colon = line.find(":")
|
|
320
|
+
if colon >= 0:
|
|
321
|
+
parsed[line[:colon].strip()] = line[colon + 1 :].strip()
|
|
322
|
+
default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})}
|
|
323
|
+
|
|
302
324
|
super().__init__(
|
|
303
325
|
version=__version__,
|
|
304
326
|
base_url=base_url,
|
|
@@ -2,7 +2,7 @@ from __future__ import annotations
|
|
|
2
2
|
|
|
3
3
|
from typing import TYPE_CHECKING, Any, Union, Generic, TypeVar, Callable, cast, overload
|
|
4
4
|
from datetime import date, datetime
|
|
5
|
-
from typing_extensions import Self, Literal
|
|
5
|
+
from typing_extensions import Self, Literal, TypedDict
|
|
6
6
|
|
|
7
7
|
import pydantic
|
|
8
8
|
from pydantic.fields import FieldInfo
|
|
@@ -131,6 +131,10 @@ def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str:
|
|
|
131
131
|
return model.model_dump_json(indent=indent)
|
|
132
132
|
|
|
133
133
|
|
|
134
|
+
class _ModelDumpKwargs(TypedDict, total=False):
|
|
135
|
+
by_alias: bool
|
|
136
|
+
|
|
137
|
+
|
|
134
138
|
def model_dump(
|
|
135
139
|
model: pydantic.BaseModel,
|
|
136
140
|
*,
|
|
@@ -142,6 +146,9 @@ def model_dump(
|
|
|
142
146
|
by_alias: bool | None = None,
|
|
143
147
|
) -> dict[str, Any]:
|
|
144
148
|
if (not PYDANTIC_V1) or hasattr(model, "model_dump"):
|
|
149
|
+
kwargs: _ModelDumpKwargs = {}
|
|
150
|
+
if by_alias is not None:
|
|
151
|
+
kwargs["by_alias"] = by_alias
|
|
145
152
|
return model.model_dump(
|
|
146
153
|
mode=mode,
|
|
147
154
|
exclude=exclude,
|
|
@@ -149,7 +156,7 @@ def model_dump(
|
|
|
149
156
|
exclude_defaults=exclude_defaults,
|
|
150
157
|
# warnings are not supported in Pydantic v1
|
|
151
158
|
warnings=True if PYDANTIC_V1 else warnings,
|
|
152
|
-
|
|
159
|
+
**kwargs,
|
|
153
160
|
)
|
|
154
161
|
return cast(
|
|
155
162
|
"dict[str, Any]",
|
|
@@ -3,8 +3,8 @@ from __future__ import annotations
|
|
|
3
3
|
import io
|
|
4
4
|
import os
|
|
5
5
|
import pathlib
|
|
6
|
-
from typing import overload
|
|
7
|
-
from typing_extensions import TypeGuard
|
|
6
|
+
from typing import Sequence, cast, overload
|
|
7
|
+
from typing_extensions import TypeVar, TypeGuard
|
|
8
8
|
|
|
9
9
|
import anyio
|
|
10
10
|
|
|
@@ -17,7 +17,9 @@ from ._types import (
|
|
|
17
17
|
HttpxFileContent,
|
|
18
18
|
HttpxRequestFiles,
|
|
19
19
|
)
|
|
20
|
-
from ._utils import is_tuple_t, is_mapping_t, is_sequence_t
|
|
20
|
+
from ._utils import is_list, is_mapping, is_tuple_t, is_mapping_t, is_sequence_t
|
|
21
|
+
|
|
22
|
+
_T = TypeVar("_T")
|
|
21
23
|
|
|
22
24
|
|
|
23
25
|
def is_base64_file_input(obj: object) -> TypeGuard[Base64FileInput]:
|
|
@@ -97,7 +99,7 @@ async def async_to_httpx_files(files: RequestFiles | None) -> HttpxRequestFiles
|
|
|
97
99
|
elif is_sequence_t(files):
|
|
98
100
|
files = [(key, await _async_transform_file(file)) for key, file in files]
|
|
99
101
|
else:
|
|
100
|
-
raise TypeError("Unexpected file type input {type(files)}, expected mapping or sequence")
|
|
102
|
+
raise TypeError(f"Unexpected file type input {type(files)}, expected mapping or sequence")
|
|
101
103
|
|
|
102
104
|
return files
|
|
103
105
|
|
|
@@ -121,3 +123,51 @@ async def async_read_file_content(file: FileContent) -> HttpxFileContent:
|
|
|
121
123
|
return await anyio.Path(file).read_bytes()
|
|
122
124
|
|
|
123
125
|
return file
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
def deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]]) -> _T:
|
|
129
|
+
"""Copy only the containers along the given paths.
|
|
130
|
+
|
|
131
|
+
Used to guard against mutation by extract_files without copying the entire structure.
|
|
132
|
+
Only dicts and lists that lie on a path are copied; everything else
|
|
133
|
+
is returned by reference.
|
|
134
|
+
|
|
135
|
+
For example, given paths=[["foo", "files", "file"]] and the structure:
|
|
136
|
+
{
|
|
137
|
+
"foo": {
|
|
138
|
+
"bar": {"baz": {}},
|
|
139
|
+
"files": {"file": <content>}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
The root dict, "foo", and "files" are copied (they lie on the path).
|
|
143
|
+
"bar" and "baz" are returned by reference (off the path).
|
|
144
|
+
"""
|
|
145
|
+
return _deepcopy_with_paths(item, paths, 0)
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
def _deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]], index: int) -> _T:
|
|
149
|
+
if not paths:
|
|
150
|
+
return item
|
|
151
|
+
if is_mapping(item):
|
|
152
|
+
key_to_paths: dict[str, list[Sequence[str]]] = {}
|
|
153
|
+
for path in paths:
|
|
154
|
+
if index < len(path):
|
|
155
|
+
key_to_paths.setdefault(path[index], []).append(path)
|
|
156
|
+
|
|
157
|
+
# if no path continues through this mapping, it won't be mutated and copying it is redundant
|
|
158
|
+
if not key_to_paths:
|
|
159
|
+
return item
|
|
160
|
+
|
|
161
|
+
result = dict(item)
|
|
162
|
+
for key, subpaths in key_to_paths.items():
|
|
163
|
+
if key in result:
|
|
164
|
+
result[key] = _deepcopy_with_paths(result[key], subpaths, index + 1)
|
|
165
|
+
return cast(_T, result)
|
|
166
|
+
if is_list(item):
|
|
167
|
+
array_paths = [path for path in paths if index < len(path) and path[index] == "<array>"]
|
|
168
|
+
|
|
169
|
+
# if no path expects a list here, nothing will be mutated inside it - return by reference
|
|
170
|
+
if not array_paths:
|
|
171
|
+
return cast(_T, item)
|
|
172
|
+
return cast(_T, [_deepcopy_with_paths(entry, array_paths, index + 1) for entry in item])
|
|
173
|
+
return item
|
|
@@ -25,7 +25,9 @@ from typing_extensions import (
|
|
|
25
25
|
ClassVar,
|
|
26
26
|
Protocol,
|
|
27
27
|
Required,
|
|
28
|
+
Annotated,
|
|
28
29
|
ParamSpec,
|
|
30
|
+
TypeAlias,
|
|
29
31
|
TypedDict,
|
|
30
32
|
TypeGuard,
|
|
31
33
|
final,
|
|
@@ -79,7 +81,15 @@ from ._compat import (
|
|
|
79
81
|
from ._constants import RAW_RESPONSE_HEADER
|
|
80
82
|
|
|
81
83
|
if TYPE_CHECKING:
|
|
84
|
+
from pydantic import GetCoreSchemaHandler, ValidatorFunctionWrapHandler
|
|
85
|
+
from pydantic_core import CoreSchema, core_schema
|
|
82
86
|
from pydantic_core.core_schema import ModelField, ModelSchema, LiteralSchema, ModelFieldsSchema
|
|
87
|
+
else:
|
|
88
|
+
try:
|
|
89
|
+
from pydantic_core import CoreSchema, core_schema
|
|
90
|
+
except ImportError:
|
|
91
|
+
CoreSchema = None
|
|
92
|
+
core_schema = None
|
|
83
93
|
|
|
84
94
|
__all__ = ["BaseModel", "GenericModel"]
|
|
85
95
|
|
|
@@ -396,6 +406,76 @@ class BaseModel(pydantic.BaseModel):
|
|
|
396
406
|
)
|
|
397
407
|
|
|
398
408
|
|
|
409
|
+
class _EagerIterable(list[_T], Generic[_T]):
|
|
410
|
+
"""
|
|
411
|
+
Accepts any Iterable[T] input (including generators), consumes it
|
|
412
|
+
eagerly, and validates all items upfront.
|
|
413
|
+
|
|
414
|
+
Validation preserves the original container type where possible
|
|
415
|
+
(e.g. a set[T] stays a set[T]). Serialization (model_dump / JSON)
|
|
416
|
+
always emits a list — round-tripping through model_dump() will not
|
|
417
|
+
restore the original container type.
|
|
418
|
+
"""
|
|
419
|
+
|
|
420
|
+
@classmethod
|
|
421
|
+
def __get_pydantic_core_schema__(
|
|
422
|
+
cls,
|
|
423
|
+
source_type: Any,
|
|
424
|
+
handler: GetCoreSchemaHandler,
|
|
425
|
+
) -> CoreSchema:
|
|
426
|
+
(item_type,) = get_args(source_type) or (Any,)
|
|
427
|
+
item_schema: CoreSchema = handler.generate_schema(item_type)
|
|
428
|
+
list_of_items_schema: CoreSchema = core_schema.list_schema(item_schema)
|
|
429
|
+
|
|
430
|
+
return core_schema.no_info_wrap_validator_function(
|
|
431
|
+
cls._validate,
|
|
432
|
+
list_of_items_schema,
|
|
433
|
+
serialization=core_schema.plain_serializer_function_ser_schema(
|
|
434
|
+
cls._serialize,
|
|
435
|
+
info_arg=False,
|
|
436
|
+
),
|
|
437
|
+
)
|
|
438
|
+
|
|
439
|
+
@staticmethod
|
|
440
|
+
def _validate(v: Iterable[_T], handler: "ValidatorFunctionWrapHandler") -> Any:
|
|
441
|
+
original_type: type[Any] = type(v)
|
|
442
|
+
|
|
443
|
+
# Normalize to list so list_schema can validate each item
|
|
444
|
+
if isinstance(v, list):
|
|
445
|
+
items: list[_T] = v
|
|
446
|
+
else:
|
|
447
|
+
try:
|
|
448
|
+
items = list(v)
|
|
449
|
+
except TypeError as e:
|
|
450
|
+
raise TypeError("Value is not iterable") from e
|
|
451
|
+
|
|
452
|
+
# Validate items against the inner schema
|
|
453
|
+
validated: list[_T] = handler(items)
|
|
454
|
+
|
|
455
|
+
# Reconstruct original container type
|
|
456
|
+
if original_type is list:
|
|
457
|
+
return validated
|
|
458
|
+
# str(list) produces the list's repr, not a string built from items,
|
|
459
|
+
# so skip reconstruction for str and its subclasses.
|
|
460
|
+
if issubclass(original_type, str):
|
|
461
|
+
return validated
|
|
462
|
+
try:
|
|
463
|
+
return original_type(validated)
|
|
464
|
+
except (TypeError, ValueError):
|
|
465
|
+
# If the type cannot be reconstructed, just return the validated list
|
|
466
|
+
return validated
|
|
467
|
+
|
|
468
|
+
@staticmethod
|
|
469
|
+
def _serialize(v: Iterable[_T]) -> list[_T]:
|
|
470
|
+
"""Always serialize as a list so Pydantic's JSON encoder is happy."""
|
|
471
|
+
if isinstance(v, list):
|
|
472
|
+
return v
|
|
473
|
+
return list(v)
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
EagerIterable: TypeAlias = Annotated[Iterable[_T], _EagerIterable]
|
|
477
|
+
|
|
478
|
+
|
|
399
479
|
def _construct_field(value: object, field: FieldInfo, key: str) -> object:
|
|
400
480
|
if value is None:
|
|
401
481
|
return field_get_default(field)
|
|
@@ -2,17 +2,13 @@ from __future__ import annotations
|
|
|
2
2
|
|
|
3
3
|
from typing import Any, List, Tuple, Union, Mapping, TypeVar
|
|
4
4
|
from urllib.parse import parse_qs, urlencode
|
|
5
|
-
from typing_extensions import
|
|
5
|
+
from typing_extensions import get_args
|
|
6
6
|
|
|
7
|
-
from ._types import NotGiven, not_given
|
|
7
|
+
from ._types import NotGiven, ArrayFormat, NestedFormat, not_given
|
|
8
8
|
from ._utils import flatten
|
|
9
9
|
|
|
10
10
|
_T = TypeVar("_T")
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
ArrayFormat = Literal["comma", "repeat", "indices", "brackets"]
|
|
14
|
-
NestedFormat = Literal["dots", "brackets"]
|
|
15
|
-
|
|
16
12
|
PrimitiveData = Union[str, int, float, bool, None]
|
|
17
13
|
# this should be Data = Union[PrimitiveData, "List[Data]", "Tuple[Data]", "Mapping[str, Data]"]
|
|
18
14
|
# https://github.com/microsoft/pyright/issues/3555
|
|
@@ -101,7 +97,10 @@ class Querystring:
|
|
|
101
97
|
items.extend(self._stringify_item(key, item, opts))
|
|
102
98
|
return items
|
|
103
99
|
elif array_format == "indices":
|
|
104
|
-
|
|
100
|
+
items = []
|
|
101
|
+
for i, item in enumerate(value):
|
|
102
|
+
items.extend(self._stringify_item(f"{key}[{i}]", item, opts))
|
|
103
|
+
return items
|
|
105
104
|
elif array_format == "brackets":
|
|
106
105
|
items = []
|
|
107
106
|
key = key + "[]"
|
|
@@ -47,6 +47,9 @@ AnyMapping = Mapping[str, object]
|
|
|
47
47
|
ModelT = TypeVar("ModelT", bound=pydantic.BaseModel)
|
|
48
48
|
_T = TypeVar("_T")
|
|
49
49
|
|
|
50
|
+
ArrayFormat = Literal["comma", "repeat", "indices", "brackets"]
|
|
51
|
+
NestedFormat = Literal["dots", "brackets"]
|
|
52
|
+
|
|
50
53
|
|
|
51
54
|
# Approximates httpx internal ProxiesTypes and RequestFiles types
|
|
52
55
|
# while adding support for `PathLike` instances
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
from ._path import path_template as path_template
|
|
1
2
|
from ._sync import asyncify as asyncify
|
|
2
3
|
from ._proxy import LazyProxy as LazyProxy
|
|
3
4
|
from ._utils import (
|
|
@@ -23,7 +24,6 @@ from ._utils import (
|
|
|
23
24
|
coerce_integer as coerce_integer,
|
|
24
25
|
file_from_path as file_from_path,
|
|
25
26
|
strip_not_given as strip_not_given,
|
|
26
|
-
deepcopy_minimal as deepcopy_minimal,
|
|
27
27
|
get_async_library as get_async_library,
|
|
28
28
|
maybe_coerce_float as maybe_coerce_float,
|
|
29
29
|
get_required_header as get_required_header,
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import re
|
|
4
|
+
from typing import (
|
|
5
|
+
Any,
|
|
6
|
+
Mapping,
|
|
7
|
+
Callable,
|
|
8
|
+
)
|
|
9
|
+
from urllib.parse import quote
|
|
10
|
+
|
|
11
|
+
# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E).
|
|
12
|
+
_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$")
|
|
13
|
+
|
|
14
|
+
_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}")
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
def _quote_path_segment_part(value: str) -> str:
|
|
18
|
+
"""Percent-encode `value` for use in a URI path segment.
|
|
19
|
+
|
|
20
|
+
Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe.
|
|
21
|
+
https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
|
|
22
|
+
"""
|
|
23
|
+
# quote() already treats unreserved characters (letters, digits, and -._~)
|
|
24
|
+
# as safe, so we only need to add sub-delims, ':', and '@'.
|
|
25
|
+
# Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted.
|
|
26
|
+
return quote(value, safe="!$&'()*+,;=:@")
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
def _quote_query_part(value: str) -> str:
|
|
30
|
+
"""Percent-encode `value` for use in a URI query string.
|
|
31
|
+
|
|
32
|
+
Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe.
|
|
33
|
+
https://datatracker.ietf.org/doc/html/rfc3986#section-3.4
|
|
34
|
+
"""
|
|
35
|
+
return quote(value, safe="!$'()*+,;:@/?")
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def _quote_fragment_part(value: str) -> str:
|
|
39
|
+
"""Percent-encode `value` for use in a URI fragment.
|
|
40
|
+
|
|
41
|
+
Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe.
|
|
42
|
+
https://datatracker.ietf.org/doc/html/rfc3986#section-3.5
|
|
43
|
+
"""
|
|
44
|
+
return quote(value, safe="!$&'()*+,;=:@/?")
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
def _interpolate(
|
|
48
|
+
template: str,
|
|
49
|
+
values: Mapping[str, Any],
|
|
50
|
+
quoter: Callable[[str], str],
|
|
51
|
+
) -> str:
|
|
52
|
+
"""Replace {name} placeholders in `template`, quoting each value with `quoter`.
|
|
53
|
+
|
|
54
|
+
Placeholder names are looked up in `values`.
|
|
55
|
+
|
|
56
|
+
Raises:
|
|
57
|
+
KeyError: If a placeholder is not found in `values`.
|
|
58
|
+
"""
|
|
59
|
+
# re.split with a capturing group returns alternating
|
|
60
|
+
# [text, name, text, name, ..., text] elements.
|
|
61
|
+
parts = _PLACEHOLDER_RE.split(template)
|
|
62
|
+
|
|
63
|
+
for i in range(1, len(parts), 2):
|
|
64
|
+
name = parts[i]
|
|
65
|
+
if name not in values:
|
|
66
|
+
raise KeyError(f"a value for placeholder {{{name}}} was not provided")
|
|
67
|
+
val = values[name]
|
|
68
|
+
if val is None:
|
|
69
|
+
parts[i] = "null"
|
|
70
|
+
elif isinstance(val, bool):
|
|
71
|
+
parts[i] = "true" if val else "false"
|
|
72
|
+
else:
|
|
73
|
+
parts[i] = quoter(str(values[name]))
|
|
74
|
+
|
|
75
|
+
return "".join(parts)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
def path_template(template: str, /, **kwargs: Any) -> str:
|
|
79
|
+
"""Interpolate {name} placeholders in `template` from keyword arguments.
|
|
80
|
+
|
|
81
|
+
Args:
|
|
82
|
+
template: The template string containing {name} placeholders.
|
|
83
|
+
**kwargs: Keyword arguments to interpolate into the template.
|
|
84
|
+
|
|
85
|
+
Returns:
|
|
86
|
+
The template with placeholders interpolated and percent-encoded.
|
|
87
|
+
|
|
88
|
+
Safe characters for percent-encoding are dependent on the URI component.
|
|
89
|
+
Placeholders in path and fragment portions are percent-encoded where the `segment`
|
|
90
|
+
and `fragment` sets from RFC 3986 respectively are considered safe.
|
|
91
|
+
Placeholders in the query portion are percent-encoded where the `query` set from
|
|
92
|
+
RFC 3986 §3.3 is considered safe except for = and & characters.
|
|
93
|
+
|
|
94
|
+
Raises:
|
|
95
|
+
KeyError: If a placeholder is not found in `kwargs`.
|
|
96
|
+
ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments).
|
|
97
|
+
"""
|
|
98
|
+
# Split the template into path, query, and fragment portions.
|
|
99
|
+
fragment_template: str | None = None
|
|
100
|
+
query_template: str | None = None
|
|
101
|
+
|
|
102
|
+
rest = template
|
|
103
|
+
if "#" in rest:
|
|
104
|
+
rest, fragment_template = rest.split("#", 1)
|
|
105
|
+
if "?" in rest:
|
|
106
|
+
rest, query_template = rest.split("?", 1)
|
|
107
|
+
path_template = rest
|
|
108
|
+
|
|
109
|
+
# Interpolate each portion with the appropriate quoting rules.
|
|
110
|
+
path_result = _interpolate(path_template, kwargs, _quote_path_segment_part)
|
|
111
|
+
|
|
112
|
+
# Reject dot-segments (. and ..) in the final assembled path. The check
|
|
113
|
+
# runs after interpolation so that adjacent placeholders or a mix of static
|
|
114
|
+
# text and placeholders that together form a dot-segment are caught.
|
|
115
|
+
# Also reject percent-encoded dot-segments to protect against incorrectly
|
|
116
|
+
# implemented normalization in servers/proxies.
|
|
117
|
+
for segment in path_result.split("/"):
|
|
118
|
+
if _DOT_SEGMENT_RE.match(segment):
|
|
119
|
+
raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed")
|
|
120
|
+
|
|
121
|
+
result = path_result
|
|
122
|
+
if query_template is not None:
|
|
123
|
+
result += "?" + _interpolate(query_template, kwargs, _quote_query_part)
|
|
124
|
+
if fragment_template is not None:
|
|
125
|
+
result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part)
|
|
126
|
+
|
|
127
|
+
return result
|