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.

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

MAINT: Add warning if content_metadata is not required #1026

Merged
merged 1 commit into from
Feb 27, 2025
Merged

MAINT: Add warning if content_metadata is not required #1026

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
8 changes: 8 additions & 0 deletions src/fmu/dataio/providers/objectdata/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import warnings
from abc import abstractmethod
from dataclasses import dataclass, field
from datetime import datetime
Expand Down Expand Up @@ -182,6 +183,13 @@ def _get_validated_content_metadata(self) -> BaseModel | None:
f"{list(content_metadata_model.model_fields)}. "
)
return content_metadata_model.model_validate(content_metadata)

if content_metadata:
warnings.warn(
f"Content '{content.value}' does not require 'content_metadata', "
"ignoring input."
)

return None

@staticmethod
Expand Down
10 changes: 10 additions & 0 deletions tests/test_units/test_dataio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,16 @@ def test_content_deprecated_seismic_offset(regsurf, globalconfig2):
}


def test_content_metdata_ignored(globalconfig1, regsurf):
"""Test that warning is given when content does not require content_metadata"""
with pytest.warns(UserWarning, match="ignoring input"):
ExportData(
config=globalconfig1,
content="depth",
content_metadata={"extra": "invalid"},
).generate_metadata(regsurf)


@pytest.mark.filterwarnings("ignore: Number of maps nodes are 0")
def test_surfaces_with_non_finite_values(
globalconfig1, regsurf_masked_only, regsurf_nan_only, regsurf
Expand Down