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

fix: format commands output #3026

Merged
merged 1 commit into from
Jan 1, 2025
Merged

Conversation

vincent0426
Copy link
Contributor

@vincent0426 vincent0426 commented Dec 31, 2024

Tracking issue

Why are the changes needed?

better formatting

What changes were proposed in this pull request?

How was this patch tested?

Setup process

pyflyte run example.py --help

"""A basic Flyte project template that uses a Dockerfile"""

import typing
from flytekit import task, workflow


@task()
def say_hello(name: str) -> str:
    """A simple Flyte task to say "Hello".

    The @task decorator allows Flyte to use this function as a Flyte task,
    which is executed as an isolated, containerized unit of compute.
    """
    return f"Hello, {name}!"


@task()
def greeting_length(greeting: str) -> int:
    """A task the counts the length of a greeting."""
    return len(greeting)


@workflow
def wf(name: str = "world"):
    """Declare workflow called `wf`.

    The @workflow decorator defines an execution graph that is composed of
    tasks and potentially sub-workflows. In this simple example, the workflow
    is composed of just one task.

    There are a few important things to note about workflows:
    - Workflows are a domain-specific language (DSL) for creating execution
      graphs and therefore only support a subset of Python's behavior.
    - Tasks must be invoked with keyword arguments
    - The output variables of tasks are Promises, which are placeholders for
      values that are yet to be materialized, not the actual values.
    """
    greeting = say_hello(name=name)
    greeting_len = greeting_length(greeting=greeting)
    return greeting, greeting_len


if __name__ == "__main__":
    # Execute the workflow by invoking it like a function and passing in
    # the necessary parameters
    print(f"Running wf() {wf(name='passengers')}")

Screenshots

Before
Screenshot 2024-12-30 at 11 56 00 PM

After
Screenshot 2024-12-30 at 11 55 34 PM

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

Summary by Bito

Enhancement to Flyte CLI's visual presentation by implementing proper spacing in command documentation output. The update focuses on improving readability by adding appropriate spacing between command names and their descriptions, as evidenced through before/after screenshots.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

Copy link

welcome bot commented Dec 31, 2024

Thank you for opening this pull request! 🙌

These tips will help get your PR across the finish line:

  • Most of the repos have a PR template; if not, fill it out to the best of your knowledge.
  • Sign off your commits (Reference: DCO Guide).

@flyte-bot
Copy link
Contributor

flyte-bot commented Dec 31, 2024

Code Review Agent Run #628a27

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 6adac09..6adac09
    • flytekit/clis/sdk_in_container/run.py
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Contributor

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Feature Improvement - Command Output Formatting Enhancement

run.py - Added space before command documentation for better readability

@kumare3 kumare3 merged commit c95cc63 into flyteorg:master Jan 1, 2025
102 checks passed
Copy link

welcome bot commented Jan 1, 2025

Congrats on merging your first pull request! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants