Skip to content

Fix to requirements mapping for report #1452

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 2 commits into from
Sep 29, 2025
Merged

Fix to requirements mapping for report #1452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ede8ec8
fixes to requirements mapping for report
piotrkluba Sep 29, 2025
e5f5191
Merge branch 'main' into piotr/reqs_for_basic_params_attributes_report
benflexcompute Sep 29, 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
7 changes: 6 additions & 1 deletion flow360/plugins/report/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
# pylint: disable=import-error
from pylatex import NoEscape, Package, Tabular

from flow360.component.case import Case
from flow360.component.case import Case, CaseMetaV2
from flow360.component.results import base_results, case_results
from flow360.component.simulation.framework.base_model import (
Conflicts,
Expand All @@ -49,6 +49,8 @@ class RequirementItem(pd.BaseModel):

model_config = {"frozen": True}

_base_case_attributes: ClassVar[list] = CaseMetaV2.model_fields.keys()

# pylint: disable=protected-access
_requirements_mapping: ClassVar[dict] = {
"params": {"resource_type": "case", "filename": "simulation.json"},
Expand Down Expand Up @@ -136,6 +138,9 @@ def from_data_key(cls, data_key: str, results_name: Optional[str] = None):
>>> RequirementItem.from_data_key(data_key="surface_mesh")
>>> RequirementItem.from_data_key(data_key="monitors", results_name="massFluxExhaust")
"""
if data_key in cls._base_case_attributes:
return None

if data_key in cls._requirements_mapping:
return cls(
resource_type=cls._requirements_mapping.get(data_key).get("resource_type"),
Expand Down
10 changes: 8 additions & 2 deletions tests/report/test_report_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,23 @@ def test_get_root_path():
assert get_root_path(delta_di) == "total_forces/CL"


def test_reporttemplate_requirements():
def test_reporttemplate_requirements_basic():
template = ReportTemplate(
items=[
Summary(), # no requirements
Inputs(), # has params requirements
Table(data=["total_forces/CL", "volume_mesh/stats"], section_title="misc"),
Table(
data=["total_forces/CL", "volume_mesh/stats", "name", "id"], section_title="misc"
),
Chart2D(
x="params/version", y="y_slicing_force_distribution/Y"
), # y_slicing_force_distribution, total_forces
]
)
reqs = template.get_requirements()
expected_keys = [
"name",
"id",
"params",
"y_slicing_force_distribution",
"total_forces",
Expand All @@ -59,6 +63,8 @@ def test_reporttemplate_requirements():
expected_reqs = {RequirementItem.from_data_key(data_key=k) for k in expected_keys}
assert set(reqs) == expected_reqs


def test_reporttemplate_requirements_advanced():
template_advanced = ReportTemplate(
items=[
Inputs(), # has params requirements
Expand Down
Loading