Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Store description when saving a RunInput schema #11776

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Conversation

bunchesofdonald
Copy link
Contributor

@bunchesofdonald bunchesofdonald commented Jan 30, 2024

This adds a private _description field to RunInput and stores a provided description when saving the schema so the UI can grab it and display it in the resume modal.

Related to #11735

Example

from prefect import flow, pause_flow_run
from prefect.input import RunInput


class TreeInput(RunInput):
    kind: str


@flow
async def tree_flow():
    await pause_flow_run(
        wait_for_input=TreeInput.with_initial_data(
            description="What kind of tree do you want to plant?"
        )
    )

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • This pull request includes tests or only affects documentation.
  • This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

  • This pull request includes redirect settings in netlify.toml for files that are removed or renamed.

For new functions or classes in the Python SDK:

  • This pull request includes helpful docstrings.
  • If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in mkdocs.yml navigation.

@bunchesofdonald bunchesofdonald added the enhancement An improvement of an existing feature label Jan 30, 2024
@bunchesofdonald bunchesofdonald requested a review from a team as a code owner January 30, 2024 19:50
Copy link

netlify bot commented Jan 30, 2024

Deploy Preview for prefect-docs-preview ready!

Name Link
🔨 Latest commit 82736d2
🔍 Latest deploy log https://app.netlify.com/sites/prefect-docs-preview/deploys/65b952f3aace0b0008c49186
😎 Deploy Preview https://deploy-preview-11776--prefect-docs-preview.netlify.app/api-ref/prefect/input/run_input
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@abrookins abrookins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, I'm into it. 👍

@bunchesofdonald bunchesofdonald merged commit 188214c into main Jan 31, 2024
62 checks passed
@bunchesofdonald bunchesofdonald deleted the issue-11735 branch January 31, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants