Skip to content

Refactor: Replace get_console().print() with console_print() helper #63561

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
potiuk merged 6 commits into from
Mar 14, 2026
+1,503 −1,648
Merged

Refactor: Replace get_console().print() with console_print() helper #63561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
564891f
Use console_print helper instead of get_console().print across breeze
claude Mar 13, 2026
47e6a18
Update tests to mock console_print instead of get_console().print
claude Mar 13, 2026
4f4ae9c
Fix ruff-format: collapse single-arg console_print calls to one line
claude Mar 14, 2026
db7afa1
Merge branch 'main' into claude/unify-console-printing-cm4jZ
ad-m Mar 14, 2026
f2d2084
Apply suggestions from code review
ad-m Mar 14, 2026
fd41c78
Remove unnecessary import for console_print
ad-m Mar 14, 2026
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
170 changes: 79 additions & 91 deletions dev/breeze/src/airflow_breeze/commands/ci_commands.py
View file
Open in desktop

Large diffs are not rendered by default.

100 changes: 49 additions & 51 deletions dev/breeze/src/airflow_breeze/commands/ci_image_commands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
from airflow_breeze.utils.ci_group import ci_group
from airflow_breeze.utils.click_utils import BreezeGroup
from airflow_breeze.utils.confirm import STANDARD_TIMEOUT, Answer, user_confirm
from airflow_breeze.utils.console import Output, get_console
from airflow_breeze.utils.console import Output, console_print, get_console
from airflow_breeze.utils.docker_command_utils import (
build_cache,
check_remote_ghcr_io_commands,
Expand Down Expand Up @@ -321,7 +321,7 @@ def run_build(ci_image_params: BuildCiParams) -> None:
output=None,
)
if return_code != 0:
get_console().print(f"[error]Error when building image! {info}")
console_print(f"[error]Error when building image! {info}")
sys.exit(return_code)

perform_environment_checks()
Expand Down Expand Up @@ -465,7 +465,7 @@ def pull(
wait_for_image=wait_for_image,
)
if return_code != 0:
get_console().print(f"[error]There was an error when pulling CI image: {info}[/]")
console_print(f"[error]There was an error when pulling CI image: {info}[/]")
sys.exit(return_code)


Expand Down Expand Up @@ -538,12 +538,12 @@ def save(
image_file_to_store = image_file
else:
image_file_to_store = image_file_dir / image_file
get_console().print(f"[info]Saving Python CI image {image_name} to {image_file_to_store}[/]")
console_print(f"[info]Saving Python CI image {image_name} to {image_file_to_store}[/]")
result = run_command(
["docker", "image", "save", "-o", image_file_to_store.as_posix(), image_name], check=False
)
if result.returncode != 0:
get_console().print(f"[error]Error when saving image: {result.stdout}[/]")
console_print(f"[error]Error when saving image: {result.stdout}[/]")
sys.exit(result.returncode)


Expand Down Expand Up @@ -586,19 +586,19 @@ def load(
image_file_to_load = image_file_dir / image_file

if not image_file_to_load.name.endswith(f"-{python}.tar"):
get_console().print(
console_print(
f"[error]The image file {image_file_to_load} does not end with '-{python}.tar'. Exiting.[/]"
)
sys.exit(1)
if not image_file_to_load.name.startswith(f"ci-image-save-v3-{escaped_platform}"):
get_console().print(
console_print(
f"[error]The image file {image_file_to_load} does not start with "
f"'ci-image-save-v3-{escaped_platform}'. Exiting.[/]"
)
sys.exit(1)

if from_run or from_pr and not github_token:
get_console().print(
console_print(
"[error]The parameter `--github-token` must be provided if `--from-run` or `--from-pr` is "
"provided. Exiting.[/]"
)
Expand All @@ -610,16 +610,16 @@ def load(
download_artifact_from_pr(from_pr, image_file_to_load, github_repository, github_token)

if not image_file_to_load.exists():
get_console().print(f"[error]The image {image_file_to_load} does not exist.[/]")
console_print(f"[error]The image {image_file_to_load} does not exist.[/]")
sys.exit(1)

get_console().print(f"[info]Loading Python CI image from {image_file_to_load}[/]")
console_print(f"[info]Loading Python CI image from {image_file_to_load}[/]")
result = run_command(["docker", "image", "load", "-i", image_file_to_load.as_posix()], check=False)
if result.returncode != 0:
get_console().print(f"[error]Error when loading image: {result.stdout}[/]")
console_print(f"[error]Error when loading image: {result.stdout}[/]")
sys.exit(result.returncode)
if not skip_image_file_deletion:
get_console().print(f"[info]Deleting image file {image_file_to_load}[/]")
console_print(f"[info]Deleting image file {image_file_to_load}[/]")
image_file_to_load.unlink()
if get_verbose():
run_command(["docker", "images", "-a"])
Expand Down Expand Up @@ -665,7 +665,7 @@ def verify(
perform_environment_checks()
check_remote_ghcr_io_commands()
if (pull or image_name) and run_in_parallel:
get_console().print(
console_print(
"[error]You cannot use --pull,--image-name and --run-in-parallel at the same time. Exiting[/]"
)
sys.exit(1)
Expand Down Expand Up @@ -701,7 +701,7 @@ def verify(
check_remote_ghcr_io_commands()
command_to_run = ["docker", "pull", image_name]
run_command(command_to_run, check=True)
get_console().print(f"[info]Verifying CI image: {image_name}[/]")
console_print(f"[info]Verifying CI image: {image_name}[/]")
return_code, info = verify_an_image(
image_name=image_name,
output=None,
Expand Down Expand Up @@ -742,7 +742,7 @@ def should_we_run_the_build(build_ci_params: BuildCiParams) -> bool:
if answer == answer.YES:
if is_repo_rebased(build_ci_params.github_repository, build_ci_params.airflow_branch):
return True
get_console().print(
console_print(
"\n[warning]This might take a lot of time (more than 10 minutes) even if you have "
"a good network connection. We think you should attempt to rebase first.[/]\n"
)
Expand All @@ -753,25 +753,25 @@ def should_we_run_the_build(build_ci_params: BuildCiParams) -> bool:
)
if answer == Answer.YES:
return True
get_console().print(
console_print(
f"[info]Please rebase your code to latest {build_ci_params.airflow_branch} "
"before continuing.[/]\nCheck this link to find out how "
"https://github.com/apache/airflow/blob/main/contributing-docs/10_working_with_git.rst\n"
)
get_console().print("[error]Exiting the process[/]\n")
console_print("[error]Exiting the process[/]\n")
sys.exit(1)
elif answer == Answer.NO:
instruct_build_image(build_ci_params.python)
return False
else: # users_status == Answer.QUIT:
get_console().print("\n[warning]Quitting the process[/]\n")
console_print("\n[warning]Quitting the process[/]\n")
sys.exit()
except TimeoutOccurred:
get_console().print("\nTimeout. Considering your response as No\n")
console_print("\nTimeout. Considering your response as No\n")
instruct_build_image(build_ci_params.python)
return False
except Exception as e:
get_console().print(f"\nTerminating the process on {e}")
console_print(f"\nTerminating the process on {e}")
sys.exit(1)


Expand Down Expand Up @@ -841,9 +841,7 @@ def run_build_ci_image(
if build_command_result.returncode != 0 and not ci_image_params.upgrade_to_newer_dependencies:
if ci_image_params.upgrade_on_failure:
ci_image_params.upgrade_to_newer_dependencies = True
get_console().print(
"[warning]Attempting to build with --upgrade-to-newer-dependencies on failure"
)
console_print("[warning]Attempting to build with --upgrade-to-newer-dependencies on failure")
build_command_result = run_command(
prepare_docker_build_command(
image_params=ci_image_params,
Expand All @@ -855,10 +853,10 @@ def run_build_ci_image(
output=output,
)
else:
get_console().print(
console_print(
"[warning]Your image build failed. It could be caused by conflicting dependencies."
)
get_console().print(
console_print(
"[info]Run `breeze ci-image build --upgrade-to-newer-dependencies` to upgrade them.\n"
)
if build_command_result.returncode == 0:
Expand Down Expand Up @@ -892,9 +890,9 @@ def rebuild_or_pull_ci_image_if_needed(command_params: ShellParams | BuildCiPara
)
if build_ci_image_check_cache.exists():
if get_verbose():
get_console().print(f"[info]{command_params.image_type} image already built locally.[/]")
console_print(f"[info]{command_params.image_type} image already built locally.[/]")
else:
get_console().print(
console_print(
f"[warning]{command_params.image_type} image for Python {command_params.python} "
f"was never built locally or was deleted. Forcing build.[/]"
)
Expand All @@ -907,7 +905,7 @@ def rebuild_or_pull_ci_image_if_needed(command_params: ShellParams | BuildCiPara
ci_image_params=ci_image_params, param_description=ci_image_params.python, output=None
)
if return_code != 0:
get_console().print(f"[error]Error when building image! {info}")
console_print(f"[error]Error when building image! {info}")
sys.exit(return_code)


Expand Down Expand Up @@ -943,9 +941,9 @@ def export_mount_cache(

dockerfile_ci_content = (AIRFLOW_ROOT_PATH / "Dockerfile.ci").read_text()
dependency_cache_epoch = dockerfile_ci_content.split("DEPENDENCY_CACHE_EPOCH=")[1].split("\n")[0]
get_console().print(f"[info]Dependency cache epoch from Dockerfile.ci = {dependency_cache_epoch}[/]")
console_print(f"[info]Dependency cache epoch from Dockerfile.ci = {dependency_cache_epoch}[/]")
dockerfile = dockerfile.replace("<REPLACE_FROM_DOCKER_CI>", dependency_cache_epoch)
get_console().print("[info]Building temporary image including copying cache content to the image[/]")
console_print("[info]Building temporary image including copying cache content to the image[/]")
builder_opt: list[str] = []
if builder != "autodetect":
builder_opt = ["--builder", builder]
Expand All @@ -955,25 +953,25 @@ def export_mount_cache(
text=True,
check=True,
)
get_console().print("[info]Built temporary image[/]")
get_console().print("[info]Creating temporary container[/]")
console_print("[info]Built temporary image[/]")
console_print("[info]Creating temporary container[/]")
run_command(
["docker", "create", "--name", "airflow-export-cache-container", "airflow-export-cache"], check=True
)
get_console().print("[info]Created temporary container[/]")
get_console().print(f"[info]Copying exported cache from the container to {cache_file}[/]")
console_print("[info]Created temporary container[/]")
console_print(f"[info]Copying exported cache from the container to {cache_file}[/]")
run_command(
["docker", "cp", "airflow-export-cache-container:/root/.cache.tar.gz", cache_file.as_posix()],
check=True,
)
get_console().print("[info]Copied exported cache from the container[/]")
get_console().print("[info]Removing the temporary container[/]")
console_print("[info]Copied exported cache from the container[/]")
console_print("[info]Removing the temporary container[/]")
run_command(["docker", "rm", "airflow-export-cache-container"], check=True)
get_console().print("[info]Removed the temporary container[/]")
get_console().print("[info]Removing the temporary image[/]")
console_print("[info]Removed the temporary container[/]")
console_print("[info]Removing the temporary image[/]")
run_command(["docker", "rmi", "airflow-export-cache"], check=True)
get_console().print("[info]Removed the temporary image[/]")
get_console().print(f"[success]Exported mount cache to {cache_file}[/]")
console_print("[info]Removed the temporary image[/]")
console_print(f"[success]Exported mount cache to {cache_file}[/]")


@ci_image_group.command(name="import-mount-cache")
Expand Down Expand Up @@ -1007,16 +1005,16 @@ def import_mount_cache(
import tempfile

context = Path(tempfile.mkdtemp())
get_console().print(f"[info]Context: {context}[/]")
console_print(f"[info]Context: {context}[/]")
context_cache_file = context / "cache.tar.gz"
get_console().print(f"[info]Copying cache file to context: {context_cache_file}[/]")
console_print(f"[info]Copying cache file to context: {context_cache_file}[/]")
cache_file.rename(context_cache_file)
get_console().print(f"[info]Copied cache file to context: {context_cache_file}[/]")
console_print(f"[info]Copied cache file to context: {context_cache_file}[/]")
dockerfile_ci_content = (AIRFLOW_ROOT_PATH / "Dockerfile.ci").read_text()
dependency_cache_epoch = dockerfile_ci_content.split("DEPENDENCY_CACHE_EPOCH=")[1].split("\n")[0]
get_console().print(f"[info]Dependency cache epoch from Dockerfile.ci = {dependency_cache_epoch}[/]")
console_print(f"[info]Dependency cache epoch from Dockerfile.ci = {dependency_cache_epoch}[/]")
dockerfile = dockerfile.replace("<REPLACE_FROM_DOCKER_CI>", dependency_cache_epoch)
get_console().print("[info]Building temporary image and copying cache to mount cache[/]")
console_print("[info]Building temporary image and copying cache to mount cache[/]")
builder_opt: list[str] = []
if builder != "autodetect":
builder_opt = ["--builder", builder]
Expand All @@ -1037,13 +1035,13 @@ def import_mount_cache(
text=True,
check=True,
)
get_console().print("[info]Built temporary image and copied cache[/]")
get_console().print("[info]Removing temporary image[/]")
console_print("[info]Built temporary image and copied cache[/]")
console_print("[info]Removing temporary image[/]")
run_command(["docker", "rmi", "airflow-import-cache"], check=True)
run_command(["docker", "system", "prune", "-f"], check=True)
get_console().print("[info]Built temporary image and copying context[/]")
get_console().print(f"[info]Removing context: {context}[/]")
console_print("[info]Built temporary image and copying context[/]")
console_print(f"[info]Removing context: {context}[/]")
context_cache_file.unlink()
context.rmdir()
get_console().print(f"[info]Removed context: {context}[/]")
get_console().print(f"[success]Imported mount cache from {cache_file}[/]")
console_print(f"[info]Removed context: {context}[/]")
console_print(f"[success]Imported mount cache from {cache_file}[/]")
Loading
Loading