Skip to content

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 src/prefect/artifacts.py 
 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
126
127
128
129
130
131
class Artifact(ArtifactRequest):
    """
    An artifact is a piece of data that is created by a flow or task run.
    https://docs.prefect.io/latest/concepts/artifacts/

    Arguments:
        type: A string identifying the type of artifact.
        key: A user-provided string identifier.
          The key must only contain lowercase letters, numbers, and dashes.
        description: A user-specified description of the artifact.
        data: A JSON payload that allows for a result to be retrieved.
    """

    @sync_compatible
    async def create(
        self: "Self",
        client: Optional["PrefectClient"] = None,
    ) -> "ArtifactResponse":
        """
        A method to create an artifact.

        Arguments:
            client: The PrefectClient

        Returns:
            - The created artifact.
        """
        client, _ = get_or_create_client(client)
        task_run_id, flow_run_id = get_task_and_flow_run_ids()
        return await client.create_artifact(
            artifact=ArtifactRequest(
                type=self.type,
                key=self.key,
                description=self.description,
                task_run_id=self.task_run_id or task_run_id,
                flow_run_id=self.flow_run_id or flow_run_id,
                data=await self.format(),
            )
        )

    @classmethod
    @sync_compatible
    async def get(
        cls, key: Optional[str] = None, client: Optional["PrefectClient"] = None
    ) -> Optional["ArtifactResponse"]:
        """
        A method to get an artifact.

        Arguments:
            key (str, optional): The key of the artifact to get.
            client (PrefectClient, optional): The PrefectClient

        Returns:
            (ArtifactResponse, optional): The artifact (if found).
        """
        client, _ = get_or_create_client(client)
        return next(
            iter(
                await client.read_artifacts(
                    limit=1,
                    sort=ArtifactSort.UPDATED_DESC,
                    artifact_filter=ArtifactFilter(key=ArtifactFilterKey(any_=[key])),
                )
            ),
            None,
        )

    @classmethod
    @sync_compatible
    async def get_or_create(
        cls,
        key: Optional[str] = None,
        description: Optional[str] = None,
        data: Optional[Union[Dict[str, Any], Any]] = None,
        client: Optional["PrefectClient"] = None,
        **kwargs: Any,
    ) -> Tuple["ArtifactResponse", bool]:
        """
        A method to get or create an artifact.

        Arguments:
            key (str, optional): The key of the artifact to get or create.
            description (str, optional): The description of the artifact to create.
            data (Union[Dict[str, Any], Any], optional): The data of the artifact to create.
            client (PrefectClient, optional): The PrefectClient

        Returns:
            (ArtifactResponse): The artifact, either retrieved or created.
        """
        artifact = await cls.get(key, client)
        if artifact:
            return artifact, False
        else:
            return (
                await cls(key=key, description=description, data=data, **kwargs).create(
                    client
                ),
                True,
            )

    async def format(self) -> Optional[Union[Dict[str, Any], Any]]:
        return json.dumps(self.data)

create(client=None) async

A method to create an artifact.

Parameters:

Name Type Description Default
client Optional['PrefectClient']

The PrefectClient

 None

Returns:

Type Description
'ArtifactResponse'
  • The created artifact.
Source code in src/prefect/artifacts.py 
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
@sync_compatible
async def create(
    self: "Self",
    client: Optional["PrefectClient"] = None,
) -> "ArtifactResponse":
    """
    A method to create an artifact.

    Arguments:
        client: The PrefectClient

    Returns:
        - The created artifact.
    """
    client, _ = get_or_create_client(client)
    task_run_id, flow_run_id = get_task_and_flow_run_ids()
    return await client.create_artifact(
        artifact=ArtifactRequest(
            type=self.type,
            key=self.key,
            description=self.description,
            task_run_id=self.task_run_id or task_run_id,
            flow_run_id=self.flow_run_id or flow_run_id,
            data=await self.format(),
        )
    )

get(key=None, client=None) 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 src/prefect/artifacts.py 
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
@classmethod
@sync_compatible
async def get(
    cls, key: Optional[str] = None, client: Optional["PrefectClient"] = None
) -> Optional["ArtifactResponse"]:
    """
    A method to get an artifact.

    Arguments:
        key (str, optional): The key of the artifact to get.
        client (PrefectClient, optional): The PrefectClient

    Returns:
        (ArtifactResponse, optional): The artifact (if found).
    """
    client, _ = get_or_create_client(client)
    return next(
        iter(
            await client.read_artifacts(
                limit=1,
                sort=ArtifactSort.UPDATED_DESC,
                artifact_filter=ArtifactFilter(key=ArtifactFilterKey(any_=[key])),
            )
        ),
        None,
    )

get_or_create(key=None, description=None, data=None, client=None, **kwargs) 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 src/prefect/artifacts.py 
 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
126
127
128
@classmethod
@sync_compatible
async def get_or_create(
    cls,
    key: Optional[str] = None,
    description: Optional[str] = None,
    data: Optional[Union[Dict[str, Any], Any]] = None,
    client: Optional["PrefectClient"] = None,
    **kwargs: Any,
) -> Tuple["ArtifactResponse", bool]:
    """
    A method to get or create an artifact.

    Arguments:
        key (str, optional): The key of the artifact to get or create.
        description (str, optional): The description of the artifact to create.
        data (Union[Dict[str, Any], Any], optional): The data of the artifact to create.
        client (PrefectClient, optional): The PrefectClient

    Returns:
        (ArtifactResponse): The artifact, either retrieved or created.
    """
    artifact = await cls.get(key, client)
    if artifact:
        return artifact, False
    else:
        return (
            await cls(key=key, description=description, data=data, **kwargs).create(
                client
            ),
            True,
        )

ImageArtifact

Bases: Artifact

An artifact that will display an image from a publicly accessible URL in the UI.

Parameters:

Name Type Description Default
image_url

The URL of the image to display.

 required
Source code in src/prefect/artifacts.py 
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
class ImageArtifact(Artifact):
    """
    An artifact that will display an image from a publicly accessible URL in the UI.

    Arguments:
        image_url: The URL of the image to display.
    """

    image_url: str
    type: Optional[str] = "image"

    async def format(self) -> str:
        """
        This method is used to format the artifact data so it can be properly sent
        to the API when the .create() method is called. It is async because the
        method is awaited in the parent class.

        Returns:
            str: The image URL.
        """
        return self.image_url

format() async

This method is used to format the artifact data so it can be properly sent to the API when the .create() method is called. It is async because the method is awaited in the parent class.

Returns:

Name Type Description
str str

The image URL.
Source code in src/prefect/artifacts.py 
209
210
211
212
213
214
215
216
217
218
async def format(self) -> str:
    """
    This method is used to format the artifact data so it can be properly sent
    to the API when the .create() method is called. It is async because the
    method is awaited in the parent class.

    Returns:
        str: The image URL.
    """
    return self.image_url

TableArtifact

Bases: Artifact

Source code in src/prefect/artifacts.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
class TableArtifact(Artifact):
    table: Union[Dict[str, List[Any]], List[Dict[str, Any]], List[List[Any]]]
    type: Optional[str] = "table"

    @classmethod
    def _sanitize(
        cls, item: Union[Dict[str, Any], List[Any], float]
    ) -> Union[Dict[str, Any], List[Any], int, float, None]:
        """
        Sanitize NaN values in a given item.
        The item can be a dict, list or float.
        """
        if isinstance(item, list):
            return [cls._sanitize(sub_item) for sub_item in item]
        elif isinstance(item, dict):
            return {k: cls._sanitize(v) for k, v in item.items()}
        elif isinstance(item, float) and math.isnan(item):
            return None
        else:
            return item

    async def format(self) -> str:
        return json.dumps(self._sanitize(self.table))

create_image_artifact(image_url, key=None, description=None) async

Create an image artifact.

Parameters:

Name Type Description Default
image_url str

The URL of the image to display.

 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 image artifact ID.
Source code in src/prefect/artifacts.py 
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
@sync_compatible
async def create_image_artifact(
    image_url: str,
    key: Optional[str] = None,
    description: Optional[str] = None,
) -> UUID:
    """
    Create an image artifact.

    Arguments:
        image_url: The URL of the image to display.
        key: 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.
        description: A user-specified description of the artifact.

    Returns:
        The image artifact ID.
    """

    artifact = await ImageArtifact(
        key=key,
        description=description,
        image_url=image_url,
    ).create()

    return artifact.id

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 src/prefect/artifacts.py 
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
@sync_compatible
async def create_link_artifact(
    link: str,
    link_text: Optional[str] = None,
    key: Optional[str] = None,
    description: Optional[str] = None,
    client: Optional["PrefectClient"] = None,
) -> UUID:
    """
    Create a link artifact.

    Arguments:
        link: The link to create.
        link_text: The link text.
        key: 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.
        description: A user-specified description of the artifact.


    Returns:
        The table artifact ID.
    """
    artifact = await LinkArtifact(
        key=key,
        description=description,
        link=link,
        link_text=link_text,
    ).create(client)

    return artifact.id

create_markdown_artifact(markdown, key=None, description=None) 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 src/prefect/artifacts.py 
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
@sync_compatible
async def create_markdown_artifact(
    markdown: str,
    key: Optional[str] = None,
    description: Optional[str] = None,
) -> UUID:
    """
    Create a markdown artifact.

    Arguments:
        markdown: The markdown to create.
        key: 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.
        description: A user-specified description of the artifact.

    Returns:
        The table artifact ID.
    """
    artifact = await MarkdownArtifact(
        key=key,
        description=description,
        markdown=markdown,
    ).create()

    return artifact.id

create_progress_artifact(progress, key=None, description=None) async

Create a progress artifact.

Parameters:

Name Type Description Default
progress float

The percentage of progress represented by a float between 0 and 100.

 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 progress artifact ID.
Source code in src/prefect/artifacts.py 
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
@sync_compatible
async def create_progress_artifact(
    progress: float,
    key: Optional[str] = None,
    description: Optional[str] = None,
) -> UUID:
    """
    Create a progress artifact.

    Arguments:
        progress: The percentage of progress represented by a float between 0 and 100.
        key: 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.
        description: A user-specified description of the artifact.

    Returns:
        The progress artifact ID.
    """

    artifact = await ProgressArtifact(
        key=key,
        description=description,
        progress=progress,
    ).create()

    return artifact.id

create_table_artifact(table, key=None, description=None) 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 src/prefect/artifacts.py 
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
@sync_compatible
async def create_table_artifact(
    table: Union[Dict[str, List[Any]], List[Dict[str, Any]], List[List[Any]]],
    key: Optional[str] = None,
    description: Optional[str] = None,
) -> UUID:
    """
    Create a table artifact.

    Arguments:
        table: The table to create.
        key: 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.
        description: A user-specified description of the artifact.

    Returns:
        The table artifact ID.
    """

    artifact = await TableArtifact(
        key=key,
        description=description,
        table=table,
    ).create()

    return artifact.id

update_progress_artifact(artifact_id, progress, description=None, client=None) async

Update a progress artifact.

Parameters:

Name Type Description Default
artifact_id UUID

The ID of the artifact to update.

 required
progress float

The percentage of progress represented by a float between 0 and 100.

 required
description Optional[str]

A user-specified description of the artifact.

 None

Returns:

Type Description
UUID

The progress artifact ID.
Source code in src/prefect/artifacts.py 
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
@sync_compatible
async def update_progress_artifact(
    artifact_id: UUID,
    progress: float,
    description: Optional[str] = None,
    client: Optional[PrefectClient] = None,
) -> UUID:
    """
    Update a progress artifact.

    Arguments:
        artifact_id: The ID of the artifact to update.
        progress: The percentage of progress represented by a float between 0 and 100.
        description: A user-specified description of the artifact.

    Returns:
        The progress artifact ID.
    """

    client, _ = get_or_create_client(client)

    artifact = ProgressArtifact(
        description=description,
        progress=progress,
    )
    update = (
        ArtifactUpdate(
            description=artifact.description,
            data=await artifact.format(),
        )
        if description
        else ArtifactUpdate(data=await artifact.format())
    )

    await client.update_artifact(
        artifact_id=artifact_id,
        artifact=update,
    )

    return artifact_id