ploomber.products.Product

class ploomber.products.Product(identifier)

Abstract class for all Products

prepare_metadata

A hook to execute before saving metadata, should include a “metadata” parameter and might include “product”. “metadata” will be a dictionary with the metadata to save, it is not recommended to change any of the existing keys but additional key-value pairs might be included

Type

callable

Methods

delete([force])

Deletes the product

download()

exists()

This method returns True if the product exists, it is not part of the metadata, so there is no cached status

fetch_metadata()

render(params, **kwargs)

Render Product - this will render contents of Templates used as identifier for this Product, if a regular string was passed, this method has no effect

save_metadata(metadata)

to_json_serializable()

Returns a JSON serializable version of this product

upload()

abstract delete(force=False)

Deletes the product

download()
abstract exists()

This method returns True if the product exists, it is not part of the metadata, so there is no cached status

abstract fetch_metadata()
render(params, **kwargs)

Render Product - this will render contents of Templates used as identifier for this Product, if a regular string was passed, this method has no effect

abstract save_metadata(metadata)
to_json_serializable()

Returns a JSON serializable version of this product

upload()

Attributes

client

task