Skip to content

feat(): Add prerelease warning helper warning box #1598

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
benflexcompute merged 3 commits into from
Nov 17, 2025
Merged

feat(): Add prerelease warning helper warning box #1598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30ebfc6
Add prerelease warning helper warning box
benflexcompute Nov 17, 2025
0648189
Add env var to suppress beta warning
benflexcompute Nov 17, 2025
4156491
Added suppression method
benflexcompute Nov 17, 2025
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
3 changes: 3 additions & 0 deletions flow360/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@
from flow360.component.volume_mesh import VolumeMeshV2 as VolumeMesh
from flow360.environment import Env
from flow360.plugins import report
from flow360.version_utils import warn_if_prerelease_version as _warn_prerelease

__all__ = [
"GeometryRefinement",
Expand Down Expand Up @@ -321,3 +322,5 @@
"ImportedSurface",
"RunControl",
]

_warn_prerelease()
80 changes: 80 additions & 0 deletions flow360/version_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
"""
Utilities for version handling.
"""

from __future__ import annotations

import os
from typing import Optional

from .log import log
from .version import __version__

_WARNED_PRERELEASE = False
_BOX_MAX_WIDTH = 110
_SUPPRESS_ENV_VAR = "FLOW360_SUPPRESS_BETA_WARNING"


def is_prerelease_version(version: Optional[str] = None) -> bool:
"""
Determine whether the provided version string belongs to a prerelease build.

Args:
version: Version string to check. Defaults to the client __version__.

Returns:
True if the version string represents a prerelease build (beta), False otherwise.
"""
version_to_check = version or __version__
return "b" in version_to_check


def _build_warning_box(version: str) -> str:
"""
Construct an ASCII warning box that scales with the message length.
"""
title = "Flow360 Beta Version Warning"
raw_lines = [
f"You are using an unstable *beta* build of the Flow360 Python client ({version}).",
"This build is not intended for public Flow360 releases or production workflows.",
"Interfaces may change between beta drops, which can render scripts unusable.",
"Backward compatibility for your data with upcoming releases is not guaranteed.",
"Use at your own risk.",
"Run `flow360 version` to find the latest stable release.",
]

content_width = max(len(title), *(len(line) for line in raw_lines))
border = "+" + "-" * (content_width + 2) + "+"

formatted_lines = [
border,
f"| {title.center(content_width)} |",
border,
]
for line in raw_lines:
formatted_lines.append(f"| {line.ljust(content_width)} |")
formatted_lines.append(border)

return "\n".join(formatted_lines)


def warn_if_prerelease_version() -> None:
"""
Emit a warning once per process if the client is a prerelease build.
"""
global _WARNED_PRERELEASE # pylint: disable=global-statement
if _WARNED_PRERELEASE:
return
if not is_prerelease_version():
return
if os.environ.get(_SUPPRESS_ENV_VAR, "").strip().lower() in {"1", "true", "yes", "on"}:
_WARNED_PRERELEASE = True
return

warning_box = _build_warning_box(__version__)
log.warning("\n%s", warning_box)
_WARNED_PRERELEASE = True


if is_prerelease_version():
warn_if_prerelease_version()
38 changes: 38 additions & 0 deletions tests/simulation/test_version_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
from unittest.mock import patch

import flow360.version_utils as vu


def reset_warning_flag():
vu._WARNED_PRERELEASE = False # pylint: disable=protected-access


def test_is_prerelease_version_detects_beta():
assert vu.is_prerelease_version("1.0.0b1")
assert not vu.is_prerelease_version("1.0.0")


def test_warn_if_prerelease_version_emits_once(monkeypatch):
reset_warning_flag()
monkeypatch.setattr(vu, "__version__", "2.0.0b2", raising=False)
with patch.object(vu.log, "warning") as mock_warning:
vu.warn_if_prerelease_version()
vu.warn_if_prerelease_version()
assert mock_warning.call_count == 1


def test_warn_if_prerelease_version_skips_release(monkeypatch):
reset_warning_flag()
monkeypatch.setattr(vu, "__version__", "2.0.0", raising=False)
with patch.object(vu.log, "warning") as mock_warning:
vu.warn_if_prerelease_version()
mock_warning.assert_not_called()


def test_warn_if_prerelease_version_respects_env(monkeypatch):
reset_warning_flag()
monkeypatch.setenv("FLOW360_SUPPRESS_BETA_WARNING", "1")
monkeypatch.setattr(vu, "__version__", "2.0.0b2", raising=False)
with patch.object(vu.log, "warning") as mock_warning:
vu.warn_if_prerelease_version()
mock_warning.assert_not_called()
Loading