Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions src/zenml/config/compiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,25 @@ def _filter_and_validate_settings(
f"The settings class {settings_instance.__class__} can not "
f"be specified on a {configuration_level.name} level."
)

if settings_instance.model_extra:
logger.warning(
"Ignoring invalid setting attributes `%s` defined for key `%s`.",
list(settings_instance.model_extra),
key,
)
settings_instance = settings_instance.model_validate(
settings_instance.model_dump(
exclude=set(settings_instance.model_extra),
exclude_unset=True,
)
)

if not settings_instance.model_fields_set:
# There are no values defined on the settings instance, don't
# include them in the deployment
continue

validated_settings[key] = settings_instance

return validated_settings
Expand Down
98 changes: 98 additions & 0 deletions tests/unit/config/test_compiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,104 @@ def test_stack_component_settings_for_missing_component_are_ignored(
)


def test_invalid_settings_keys_are_ignored(
mocker, one_step_pipeline, empty_step, local_stack
):
"""Tests that invalid settings keys that are not part of the settings class
are ignored."""

class StubSettings(BaseSettings):
valid_key: str = ""

orchestrator_class = type(local_stack.orchestrator)
mocker.patch.object(
orchestrator_class,
"settings_class",
new_callable=mocker.PropertyMock,
return_value=StubSettings,
)

settings = {"orchestrator": {"valid_key": "value", "invalid_key": "value"}}

step_instance = empty_step
pipeline_instance = one_step_pipeline(step_instance)

pipeline_instance.configure(settings=settings)
step_instance.configure(settings=settings)
run_config = PipelineRunConfiguration(
settings=settings,
steps={"_empty_step": StepConfigurationUpdate(settings=settings)},
)

with pipeline_instance:
pipeline_instance.entrypoint()
deployment = Compiler().compile(
pipeline=pipeline_instance,
stack=local_stack,
run_configuration=run_config,
)

compiled_pipeline_settings = deployment.pipeline_configuration.settings[
"orchestrator.default"
].model_dump()
assert "invalid_key" not in compiled_pipeline_settings
assert compiled_pipeline_settings["valid_key"] == "value"

compiled_step_settings = (
deployment.step_configurations["_empty_step"]
.config.settings["orchestrator.default"]
.model_dump()
)
assert "invalid_key" not in compiled_step_settings
assert compiled_step_settings["valid_key"] == "value"


def test_empty_settings_classes_are_ignored(
mocker, one_step_pipeline, empty_step, local_stack
):
"""Tests that empty settings classes are ignored."""

class StubSettings(BaseSettings):
valid_key: str = ""

orchestrator_class = type(local_stack.orchestrator)
mocker.patch.object(
orchestrator_class,
"settings_class",
new_callable=mocker.PropertyMock,
return_value=StubSettings,
)

step_instance = empty_step
pipeline_instance = one_step_pipeline(step_instance)

settings = {"orchestrator": {"invalid_key": "value"}}

pipeline_instance.configure(settings=settings)
step_instance.configure(settings=settings)
run_config = PipelineRunConfiguration(
settings=settings,
steps={"_empty_step": StepConfigurationUpdate(settings=settings)},
)

with pipeline_instance:
pipeline_instance.entrypoint()
deployment = Compiler().compile(
pipeline=pipeline_instance,
stack=local_stack,
run_configuration=run_config,
)

assert (
"orchestrator.default"
not in deployment.pipeline_configuration.settings
)
assert (
"orchestrator.default"
not in deployment.step_configurations["_empty_step"].config.settings
)


@step
def s1() -> int:
return 1
Expand Down
Loading