Skip to content

Commit 1083cf4

Browse files
Auto-update documentation (#19300)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 8fcec12 commit 1083cf4

File tree

8 files changed

+66
-36
lines changed

8 files changed

+66
-36
lines changed

docs/v3/api-ref/cli/dev.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ Build a docker image for development.
242242
</ResponseField>
243243

244244
<ResponseField name="--python-version">
245-
The Python version to build the container for. Defaults to the version of the host Python. [default: 3.9]
245+
The Python version to build the container for. Defaults to the version of the host Python. [default: 3.10]
246246
</ResponseField>
247247

248248
<ResponseField name="--flavor">

docs/v3/api-ref/cli/work-pool.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ EXPERIMENTAL: Inspect the storage configuration for a work pool.
650650

651651
<Accordion title="Arguments" defaultOpen>
652652
<ResponseField name="WORK_POOL_NAME" type="string" required>
653-
\[required]
653+
The name of the work pool to display storage configuration for. \[required]
654654
</ResponseField>
655655
</Accordion>
656656

docs/v3/api-ref/python/prefect-server-database-dependencies.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Injected database interface dependencies
1212

1313
## Functions
1414

15-
### `provide_database_interface` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
15+
### `provide_database_interface` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1616

1717
```python
1818
provide_database_interface() -> 'PrefectDBInterface'
@@ -25,7 +25,7 @@ If components of the interface are not set, defaults will be inferred
2525
based on the dialect of the connection URL.
2626

2727

28-
### `inject_db` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L143" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
28+
### `inject_db` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L142" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2929

3030
```python
3131
inject_db(fn: Callable[P, R]) -> Callable[P, R]
@@ -38,7 +38,7 @@ The decorated function _must_ take a `db` kwarg and if a db is passed
3838
when called it will be used instead of creating a new one.
3939

4040

41-
### `db_injector` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L178" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
41+
### `db_injector` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L177" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4242

4343
```python
4444
db_injector(func: Union[_DBMethod[T, P, R], _DBFunction[P, R]]) -> Union[_Method[T, P, R], _Function[P, R]]
@@ -65,7 +65,7 @@ iscoroutinefunction() test.
6565
- binding transparently.
6666

6767

68-
### `temporary_database_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L361" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
68+
### `temporary_database_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L346" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
6969

7070
```python
7171
temporary_database_config(tmp_database_config: Optional[BaseDatabaseConfiguration]) -> Generator[None, object, None]
@@ -80,7 +80,7 @@ be restored.
8080
- `tmp_database_config`: Prefect REST API database configuration to inject.
8181

8282

83-
### `temporary_query_components` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L382" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
83+
### `temporary_query_components` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L367" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8484

8585
```python
8686
temporary_query_components(tmp_queries: Optional['BaseQueryComponents']) -> Generator[None, object, None]
@@ -95,7 +95,7 @@ be restored.
9595
- `tmp_queries`: Prefect REST API query components to inject.
9696

9797

98-
### `temporary_orm_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L403" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
98+
### `temporary_orm_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L388" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9999

100100
```python
101101
temporary_orm_config(tmp_orm_config: Optional['BaseORMConfiguration']) -> Generator[None, object, None]
@@ -110,7 +110,7 @@ be restored.
110110
- `tmp_orm_config`: Prefect REST API ORM configuration to inject.
111111

112112

113-
### `temporary_interface_class` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L424" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
113+
### `temporary_interface_class` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L409" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
114114

115115
```python
116116
temporary_interface_class(tmp_interface_class: Optional[type['PrefectDBInterface']]) -> Generator[None, object, None]
@@ -124,7 +124,7 @@ the existing interface will be restored.
124124
- `tmp_interface_class`: Prefect REST API interface class to inject.
125125

126126

127-
### `temporary_database_interface` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L444" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
127+
### `temporary_database_interface` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L429" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
128128

129129
```python
130130
temporary_database_interface(tmp_database_config: Optional[BaseDatabaseConfiguration] = None, tmp_queries: Optional['BaseQueryComponents'] = None, tmp_orm_config: Optional['BaseORMConfiguration'] = None, tmp_interface_class: Optional[type['PrefectDBInterface']] = None) -> Generator[None, object, None]
@@ -147,7 +147,7 @@ be restored.
147147
- `tmp_interface_class`: Optional database interface class to inject
148148

149149

150-
### `set_database_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L479" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
150+
### `set_database_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L464" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
151151

152152
```python
153153
set_database_config(database_config: Optional[BaseDatabaseConfiguration]) -> None
@@ -157,7 +157,7 @@ set_database_config(database_config: Optional[BaseDatabaseConfiguration]) -> Non
157157
Set Prefect REST API database configuration.
158158

159159

160-
### `set_query_components` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L484" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
160+
### `set_query_components` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L469" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
161161

162162
```python
163163
set_query_components(query_components: Optional['BaseQueryComponents']) -> None
@@ -167,7 +167,7 @@ set_query_components(query_components: Optional['BaseQueryComponents']) -> None
167167
Set Prefect REST API query components.
168168

169169

170-
### `set_orm_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L489" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
170+
### `set_orm_config` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L474" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
171171

172172
```python
173173
set_orm_config(orm_config: Optional['BaseORMConfiguration']) -> None
@@ -177,7 +177,7 @@ set_orm_config(orm_config: Optional['BaseORMConfiguration']) -> None
177177
Set Prefect REST API orm configuration.
178178

179179

180-
### `set_interface_class` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L494" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
180+
### `set_interface_class` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L479" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
181181

182182
```python
183183
set_interface_class(interface_class: Optional[type['PrefectDBInterface']]) -> None
@@ -189,4 +189,4 @@ Set Prefect REST API interface class.
189189

190190
## Classes
191191

192-
### `DBInjector` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L254" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
192+
### `DBInjector` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L239" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

docs/v3/api-ref/python/prefect-testing-utilities.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ will fail if the exception is serialized/deserialized so this utility does its
2424
best to assert equality using the type and args used to initialize the exception
2525

2626

27-
### `kubernetes_environments_equal` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L60" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
### `kubernetes_environments_equal` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L51" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2828

2929
```python
3030
kubernetes_environments_equal(actual: list[dict[str, str]], expected: list[dict[str, str]] | dict[str, str]) -> bool
3131
```
3232

33-
### `assert_does_not_warn` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L97" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
33+
### `assert_does_not_warn` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L88" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3434

3535
```python
3636
assert_does_not_warn(ignore_warnings: list[type[Warning]] | None = None) -> Generator[None, None, None]
@@ -44,7 +44,7 @@ Parameters:
4444
- ignore_warnings: List of warning types to ignore. Example: [DeprecationWarning, UserWarning]
4545

4646

47-
### `prefect_test_harness` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L120" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
47+
### `prefect_test_harness` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L111" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
4848

4949
```python
5050
prefect_test_harness(server_startup_timeout: int | None = 30)
@@ -74,37 +74,37 @@ with prefect_test_harness():
7474
```
7575

7676

77-
### `get_most_recent_flow_run` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L187" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
77+
### `get_most_recent_flow_run` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L178" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
7878

7979
```python
8080
get_most_recent_flow_run(client: 'PrefectClient | None' = None, flow_name: str | None = None) -> 'FlowRun'
8181
```
8282

83-
### `assert_blocks_equal` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L204" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
83+
### `assert_blocks_equal` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L195" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
8484

8585
```python
8686
assert_blocks_equal(found: Block, expected: Block, exclude_private: bool = True, **kwargs: Any) -> None
8787
```
8888

89-
### `assert_uses_result_serializer` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L221" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
89+
### `assert_uses_result_serializer` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L212" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9090

9191
```python
9292
assert_uses_result_serializer(state: State, serializer: str | Serializer, client: 'PrefectClient') -> None
9393
```
9494

95-
### `assert_uses_result_storage` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L257" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
95+
### `assert_uses_result_storage` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L248" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
9696

9797
```python
9898
assert_uses_result_storage(state: State, storage: 'str | ReadableFileSystem', client: 'PrefectClient') -> None
9999
```
100100

101-
### `a_test_step` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L285" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
101+
### `a_test_step` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L276" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
102102

103103
```python
104104
a_test_step(**kwargs: Any) -> dict[str, Any]
105105
```
106106

107-
### `b_test_step` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L296" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
107+
### `b_test_step` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/testing/utilities.py#L287" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
108108

109109
```python
110110
b_test_step(**kwargs: Any) -> dict[str, Any]

0 commit comments

Comments
 (0)