Skip to content

feat: add pretty print for cron expressions #17

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.

Sign up for GitHub

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

Merged
Valentin-v-Todorov merged 1 commit into from
Sep 22, 2025
Merged

feat: add pretty print for cron expressions #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/cronpal/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from cronpal.field_parser import FieldParser
from cronpal.models import CronExpression, CronField, FieldType
from cronpal.parser import create_parser
from cronpal.pretty_printer import PrettyPrinter
from cronpal.scheduler import CronScheduler
from cronpal.special_parser import SpecialStringParser
from cronpal.validators import validate_expression
Expand All @@ -27,6 +28,7 @@
"FieldParser",
"SpecialStringParser",
"CronScheduler",
"PrettyPrinter",
"validate_expression",
"CronPalError",
"InvalidCronExpression",
Expand Down
57 changes: 44 additions & 13 deletions src/cronpal/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from cronpal.field_parser import FieldParser
from cronpal.models import CronExpression
from cronpal.parser import create_parser
from cronpal.pretty_printer import PrettyPrinter
from cronpal.scheduler import CronScheduler
from cronpal.special_parser import SpecialStringParser
from cronpal.timezone_utils import (
Expand Down Expand Up @@ -69,16 +70,33 @@ def main(args=None):
# Parse as special string
cron_expr = special_parser.parse(parsed_args.expression)

print(f"✔ Valid cron expression: {cron_expr}")
if parsed_args.pretty:
# Pretty print mode
if cron_expr.raw_expression.lower() == "@reboot":
print("\n✔ Valid cron expression: @reboot")
print("\nThis expression runs at system startup/reboot only.")
else:
printer = PrettyPrinter(cron_expr)
print()
print(printer.print_table())
print()
print(f"Summary: {printer.get_summary()}")

if parsed_args.verbose:
print()
print(printer.print_detailed())
else:
# Normal output
print(f"✔ Valid cron expression: {cron_expr}")

if parsed_args.verbose:
print(f" Special string: {cron_expr.raw_expression}")
description = special_parser.get_description(cron_expr.raw_expression)
print(f" Description: {description}")
if parsed_args.verbose:
print(f" Special string: {cron_expr.raw_expression}")
description = special_parser.get_description(cron_expr.raw_expression)
print(f" Description: {description}")

# For @reboot, we don't have fields to show
if cron_expr.raw_expression.lower() != "@reboot":
_print_verbose_fields(cron_expr)
# For @reboot, we don't have fields to show
if cron_expr.raw_expression.lower() != "@reboot":
_print_verbose_fields(cron_expr)
else:
# Parse the expression into fields
fields = validate_expression_format(parsed_args.expression)
Expand All @@ -94,12 +112,25 @@ def main(args=None):
cron_expr.month = field_parser.parse_month(fields[3])
cron_expr.day_of_week = field_parser.parse_day_of_week(fields[4])

print(f"✔ Valid cron expression: {cron_expr}")
if parsed_args.pretty:
# Pretty print mode
printer = PrettyPrinter(cron_expr)
print()
print(printer.print_table())
print()
print(f"Summary: {printer.get_summary()}")

if parsed_args.verbose:
print()
print(printer.print_detailed())
else:
# Normal output
print(f"✔ Valid cron expression: {cron_expr}")

if parsed_args.verbose:
print(f" Raw expression: {cron_expr.raw_expression}")
print(f" Validation: PASSED")
_print_verbose_fields(cron_expr)
if parsed_args.verbose:
print(f" Raw expression: {cron_expr.raw_expression}")
print(f" Validation: PASSED")
_print_verbose_fields(cron_expr)

# Show next run times if requested
if parsed_args.next is not None:
Expand Down
7 changes: 7 additions & 0 deletions src/cronpal/parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ def create_parser():
cronpal --version # Show version
cronpal --help # Show this help message
cronpal "0 0 * * *" --timezone "US/Eastern" # Use specific timezone
cronpal "0 0 * * *" --pretty # Pretty print the expression

Cron Expression Format:
┌───────────── minute (0-59)
Expand Down Expand Up @@ -77,4 +78,10 @@ def create_parser():
help="List all available timezone names"
)

parser.add_argument(
"--pretty",
action="store_true",
help="Pretty print the cron expression with formatted output"
)

return parser
Loading
Loading