Skip to content

Commit ce58ce1

Browse files
kevingrismorekevingrismore
authored
Add --include-inheritance to SDK reference docs builds (PrefectHQ#18529)
1 parent ce87c39 commit ce58ce1

File tree

325 files changed

+26846
-6982
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

325 files changed

+26846
-6982
lines changed

‎docs/v3/api-ref/python/prefect-artifacts.mdx‎

Lines changed: 623 additions & 63 deletions
Large diffs are not rendered by default.

‎docs/v3/api-ref/python/prefect-assets-core.mdx‎

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,41 @@ sidebarTitle: core
77

88
## Functions
99

10-
### `add_asset_metadata` <sup><a href="https://github.com/prefecthq/prefect/blob/main/src/prefect/assets/core.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
10+
### `add_asset_metadata` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/assets/core.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
```python
1313
add_asset_metadata(asset: str | Asset, metadata: dict[str, Any]) -> None
1414
```
1515

1616
## Classes
1717

18-
### `AssetProperties` <sup><a href="https://github.com/prefecthq/prefect/blob/main/src/prefect/assets/core.py#L13" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
18+
### `AssetProperties` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/assets/core.py#L13" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1919

2020

2121
Metadata properties to configure on an Asset
2222

2323

24-
### `Asset` <sup><a href="https://github.com/prefecthq/prefect/blob/main/src/prefect/assets/core.py#L36" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
24+
**Methods:**
25+
26+
#### `model_validate_list` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
27+
28+
```python
29+
model_validate_list(cls, obj: Any) -> list[Self]
30+
```
31+
32+
#### `reset_fields` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
33+
34+
```python
35+
reset_fields(self: Self) -> Self
36+
```
37+
38+
Reset the fields of the model that are in the `_reset_fields` set.
39+
40+
**Returns:**
41+
- A new instance of the model with the reset fields.
42+
43+
44+
### `Asset` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/assets/core.py#L36" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
2545

2646

2747
Assets are objects that represent materialized data,
@@ -30,8 +50,26 @@ providing a way to track lineage and dependencies.
3050

3151
**Methods:**
3252

33-
#### `add_metadata` <sup><a href="https://github.com/prefecthq/prefect/blob/main/src/prefect/assets/core.py#L57" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
53+
#### `add_metadata` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/assets/core.py#L57" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
3454

3555
```python
3656
add_metadata(self, metadata: dict[str, Any]) -> None
3757
```
58+
59+
#### `model_validate_list` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
60+
61+
```python
62+
model_validate_list(cls, obj: Any) -> list[Self]
63+
```
64+
65+
#### `reset_fields` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
66+
67+
```python
68+
reset_fields(self: Self) -> Self
69+
```
70+
71+
Reset the fields of the model that are in the `_reset_fields` set.
72+
73+
**Returns:**
74+
- A new instance of the model with the reset fields.
75+

‎docs/v3/api-ref/python/prefect-assets-materialize.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebarTitle: materialize
77

88
## Functions
99

10-
### `materialize` <sup><a href="https://github.com/prefecthq/prefect/blob/main/src/prefect/assets/materialize.py#L17" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
10+
### `materialize` <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/assets/materialize.py#L17" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
1111

1212
```python
1313
materialize(*assets: Union[str, Asset], **task_kwargs: Unpack[TaskOptions]) -> Callable[[Callable[P, R]], MaterializingTask[P, R]]

0 commit comments

Comments
 (0)