prefect.artifacts
¶
Interface for creating and reading artifacts.
Artifact
¶
Bases: ArtifactCreate
An artifact is a piece of data that is created by a flow or task run. https://docs.prefect.io/latest/concepts/artifacts/
Parameters:
Name | Type | Description | Default |
---|---|---|---|
type |
A string identifying the type of artifact. |
required | |
key |
A user-provided string identifier. The key must only contain lowercase letters, numbers, and dashes. |
required | |
description |
A user-specified description of the artifact. |
required | |
data |
A JSON payload that allows for a result to be retrieved. |
required |
Source code in prefect/artifacts.py
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 |
|
create
async
¶
A method to create an artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client |
Optional[PrefectClient]
|
The PrefectClient |
None
|
Returns:
Type | Description |
---|---|
Artifact
|
|
Source code in prefect/artifacts.py
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 |
|
get
async
classmethod
¶
A method to get an artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key of the artifact to get. |
None
|
client |
PrefectClient
|
The PrefectClient |
None
|
Returns:
Type | Description |
---|---|
(Artifact, optional)
|
The artifact (if found). |
Source code in prefect/artifacts.py
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 |
|
get_or_create
async
classmethod
¶
A method to get or create an artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key of the artifact to get or create. |
None
|
description |
str
|
The description of the artifact to create. |
None
|
data |
Union[Dict[str, Any], Any]
|
The data of the artifact to create. |
None
|
client |
PrefectClient
|
The PrefectClient |
None
|
Returns:
Type | Description |
---|---|
Artifact
|
The artifact, either retrieved or created. |
Source code in prefect/artifacts.py
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 |
|
TableArtifact
¶
Bases: Artifact
Source code in prefect/artifacts.py
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
|
create_link_artifact
async
¶
Create a link artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
link |
str
|
The link to create. |
required |
link_text |
Optional[str]
|
The link text. |
None
|
key |
Optional[str]
|
A user-provided string identifier. Required for the artifact to show in the Artifacts page in the UI. The key must only contain lowercase letters, numbers, and dashes. |
None
|
description |
Optional[str]
|
A user-specified description of the artifact. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
The table artifact ID. |
Source code in prefect/artifacts.py
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 |
|
create_markdown_artifact
async
¶
Create a markdown artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
markdown |
str
|
The markdown to create. |
required |
key |
Optional[str]
|
A user-provided string identifier. Required for the artifact to show in the Artifacts page in the UI. The key must only contain lowercase letters, numbers, and dashes. |
None
|
description |
Optional[str]
|
A user-specified description of the artifact. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
The table artifact ID. |
Source code in prefect/artifacts.py
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 |
|
create_table_artifact
async
¶
Create a table artifact.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
table |
Union[Dict[str, List[Any]], List[Dict[str, Any]], List[List[Any]]]
|
The table to create. |
required |
key |
Optional[str]
|
A user-provided string identifier. Required for the artifact to show in the Artifacts page in the UI. The key must only contain lowercase letters, numbers, and dashes. |
None
|
description |
Optional[str]
|
A user-specified description of the artifact. |
None
|
Returns:
Type | Description |
---|---|
UUID
|
The table artifact ID. |
Source code in prefect/artifacts.py
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 |
|