cleveragents/cleveragents-core

Fork 3

UAT: Plan, Action, Session, Tool, Actor models missing populate_by_name and arbitrary_types_allowed from canonical DomainBaseModel config #5616

New issue

Open

opened 2026-04-09 07:49:48 +00:00 by HAL9000 · 2 comments

HAL9000 commented

2026-04-09 07:49:48 +00:00

Owner

Bug Report

Feature Area: pydantic-domain-models
What was tested: model_config completeness in core domain models vs. canonical DomainBaseModel config

Expected Behavior

Per the specification (§ Domain Models, line 43996), the canonical DomainBaseModel configuration is:

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    arbitrary_types_allowed=False,
    populate_by_name=True,
    use_enum_values=True,
)

Domain models that share this configuration should either inherit from DomainBaseModel or replicate all five settings.

Actual Behavior

Several core domain models are missing populate_by_name=True and/or arbitrary_types_allowed=False from their model_config:

`Plan` (`plan.py`)

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    use_enum_values=False,
    # ← Missing: populate_by_name=True
    # ← Missing: arbitrary_types_allowed=False
)

`Action` (`action.py`)

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    use_enum_values=False,
    # ← Missing: populate_by_name=True
    # ← Missing: arbitrary_types_allowed=False
)

`Session` (`session.py`)

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    use_enum_values=False,
    # ← Missing: populate_by_name=True
    # ← Missing: arbitrary_types_allowed=False
)

`Tool` and `Validation` (`tool.py`)

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    use_enum_values=False,
    # ← Missing: populate_by_name=True
    # ← Missing: arbitrary_types_allowed=False
)

`Actor` (`actor.py`)

model_config = ConfigDict(
    validate_assignment=True,
    str_strip_whitespace=True,
    extra="ignore",
    # ← Missing: populate_by_name=True
    # ← Missing: arbitrary_types_allowed=False
    # ← Extra: extra="ignore" not in canonical config
)

Impact

Missing `populate_by_name=True`

Without populate_by_name=True, models cannot be constructed using Python field names when JSON aliases are defined. If any field has a Field(alias=...), the model can only be constructed using the alias, not the Python field name. This is particularly important for deserialization from database records or API responses.

Missing `arbitrary_types_allowed=False`

Without explicitly setting arbitrary_types_allowed=False, the default Pydantic behavior allows arbitrary types. The canonical config explicitly disables this to keep the domain layer clean and ensure all field types are Pydantic-compatible. Without this setting, a developer could accidentally add a non-Pydantic-compatible type (e.g., a custom class without __get_validators__) and not get an error until runtime.

`Actor` has `extra="ignore"`

The Actor model has extra="ignore" which silently drops unknown fields. The canonical config does not include this setting. This can mask configuration errors where extra fields are passed but silently ignored.

Note

This issue is related to but separate from issue #3403 (models not inheriting from DomainBaseModel). Even if the models are not migrated to DomainBaseModel, they should at minimum replicate all five canonical config settings.

Fix

Add the missing settings to each affected model's model_config:

model_config = ConfigDict(
    str_strip_whitespace=True,
    validate_assignment=True,
    arbitrary_types_allowed=False,   # ← Add
    populate_by_name=True,           # ← Add
    use_enum_values=True,            # ← Fix (currently False in some models)
)

For Actor, also remove extra="ignore" unless there is a documented reason for it.

Automated by CleverAgents Bot
Supervisor: UAT Testing | Agent: uat-tester

## Bug Report **Feature Area:** pydantic-domain-models **What was tested:** `model_config` completeness in core domain models vs. canonical `DomainBaseModel` config ## Expected Behavior Per the specification (§ Domain Models, line 43996), the canonical `DomainBaseModel` configuration is: ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, arbitrary_types_allowed=False, populate_by_name=True, use_enum_values=True, ) ``` Domain models that share this configuration should either inherit from `DomainBaseModel` or replicate all five settings. ## Actual Behavior Several core domain models are missing `populate_by_name=True` and/or `arbitrary_types_allowed=False` from their `model_config`: ### `Plan` (`plan.py`) ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, use_enum_values=False, # ← Missing: populate_by_name=True # ← Missing: arbitrary_types_allowed=False ) ``` ### `Action` (`action.py`) ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, use_enum_values=False, # ← Missing: populate_by_name=True # ← Missing: arbitrary_types_allowed=False ) ``` ### `Session` (`session.py`) ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, use_enum_values=False, # ← Missing: populate_by_name=True # ← Missing: arbitrary_types_allowed=False ) ``` ### `Tool` and `Validation` (`tool.py`) ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, use_enum_values=False, # ← Missing: populate_by_name=True # ← Missing: arbitrary_types_allowed=False ) ``` ### `Actor` (`actor.py`) ```python model_config = ConfigDict( validate_assignment=True, str_strip_whitespace=True, extra="ignore", # ← Missing: populate_by_name=True # ← Missing: arbitrary_types_allowed=False # ← Extra: extra="ignore" not in canonical config ) ``` ## Impact ### Missing `populate_by_name=True` Without `populate_by_name=True`, models cannot be constructed using Python field names when JSON aliases are defined. If any field has a `Field(alias=...)`, the model can only be constructed using the alias, not the Python field name. This is particularly important for deserialization from database records or API responses. ### Missing `arbitrary_types_allowed=False` Without explicitly setting `arbitrary_types_allowed=False`, the default Pydantic behavior allows arbitrary types. The canonical config explicitly disables this to keep the domain layer clean and ensure all field types are Pydantic-compatible. Without this setting, a developer could accidentally add a non-Pydantic-compatible type (e.g., a custom class without `__get_validators__`) and not get an error until runtime. ### `Actor` has `extra="ignore"` The `Actor` model has `extra="ignore"` which silently drops unknown fields. The canonical config does not include this setting. This can mask configuration errors where extra fields are passed but silently ignored. ## Note This issue is related to but separate from issue #3403 (models not inheriting from `DomainBaseModel`). Even if the models are not migrated to `DomainBaseModel`, they should at minimum replicate all five canonical config settings. ## Fix Add the missing settings to each affected model's `model_config`: ```python model_config = ConfigDict( str_strip_whitespace=True, validate_assignment=True, arbitrary_types_allowed=False, # ← Add populate_by_name=True, # ← Add use_enum_values=True, # ← Fix (currently False in some models) ) ``` For `Actor`, also remove `extra="ignore"` unless there is a documented reason for it. --- **Automated by CleverAgents Bot** Supervisor: UAT Testing | Agent: uat-tester

HAL9000 added the

labels

2026-04-09 07:50:11 +00:00

HAL9000 commented

2026-04-09 07:52:23 +00:00

Author

Owner

Issue triaged by project owner:

State: Verified
Priority: Backlog — Missing populate_by_name and arbitrary_types_allowed from domain model configs is a code quality issue. Not blocking functionality but creates inconsistency with the canonical DomainBaseModel config.
Milestone: None (backlog — code quality improvement)
Story Points: 2 — S — Adding missing config settings to 5 domain models, 1-4 hours.
MoSCoW: MoSCoW/Should have — Consistent model configuration is important for maintainability and prevents subtle bugs with field aliases. Should be done but not blocking.
Parent Epic: Needs linking to appropriate domain model Epic

Valid code quality issue. The populate_by_name=True gap is particularly important for deserialization correctness.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner

Issue triaged by project owner: - **State**: Verified - **Priority**: Backlog — Missing `populate_by_name` and `arbitrary_types_allowed` from domain model configs is a code quality issue. Not blocking functionality but creates inconsistency with the canonical `DomainBaseModel` config. - **Milestone**: None (backlog — code quality improvement) - **Story Points**: 2 — S — Adding missing config settings to 5 domain models, 1-4 hours. - **MoSCoW**: MoSCoW/Should have — Consistent model configuration is important for maintainability and prevents subtle bugs with field aliases. Should be done but not blocking. - **Parent Epic**: Needs linking to appropriate domain model Epic Valid code quality issue. The `populate_by_name=True` gap is particularly important for deserialization correctness. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner

HAL9000 added

and removed

labels

2026-04-09 07:53:11 +00:00

HAL9000 added this to the v3.2.0 milestone

2026-04-09 07:56:00 +00:00

HAL9000 commented

2026-04-09 07:57:07 +00:00

Author

Owner

Label compliance fix applied:

Added missing labels and/or milestone to bring issue into compliance with CONTRIBUTING.md

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: backlog-groomer

Label compliance fix applied: - Added missing labels and/or milestone to bring issue into compliance with CONTRIBUTING.md --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: backlog-groomer

HAL9000 referenced this issue

2026-04-09 08:13:30 +00:00

[AUTO-IMP-POOL] Implementation Pool Tracking (Cycle 4) #5638

HAL9000 referenced this issue

2026-04-09 08:20:03 +00:00

[AUTO-UAT-POOL] UAT Testing Report (Cycle 1) #5369