Skip to content

fix: improve parameter definition validation and error reporting #184

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
epmog merged 1 commit into from
Aug 20, 2025
Merged

fix: improve parameter definition validation and error reporting #184

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
58 changes: 39 additions & 19 deletions src/openjd/model/v2023_09/_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@
TemplateVariableDef,
)

# Error message constants
_ALLOWED_VALUES_NONE_ERROR = "allowedValues cannot be None. The field must contain at least one value or be omitted entirely."
_VALUE_LESS_THAN_MIN_ERROR = "Value less than minValue."
_VALUE_LARGER_THAN_MAX_ERROR = "Value larger than maxValue."


class ModelParsingContext(ModelParsingContextInterface):
"""Context required while parsing an OpenJDModel. An instance of this class
Expand Down Expand Up @@ -1211,6 +1216,8 @@ def _validate_max_length(cls, value: Optional[int], info: ValidationInfo) -> Opt
def _validate_allowed_values_item(
cls, value: AllowedParameterStringValueList, info: ValidationInfo
) -> AllowedParameterStringValueList:
if value is None:
raise ValueError(_ALLOWED_VALUES_NONE_ERROR)
min_length = info.data.get("minLength")
max_length = info.data.get("maxLength")
errors = list[InitErrorDetails]()
Expand Down Expand Up @@ -1421,7 +1428,7 @@ class JobPathParameterDefinition(OpenJDModel_v2023_09, JobParameterInterface):
"default",
},
adds_fields=lambda this, symtab: {
"value": symtab[f"RawParam.{cast(JobStringParameterDefinition,this).name}"]
"value": symtab[f"RawParam.{cast(JobPathParameterDefinition,this).name}"]
},
)

Expand Down Expand Up @@ -1451,8 +1458,10 @@ def _validate_max_length(cls, value: Optional[int], info: ValidationInfo) -> Opt
@field_validator("allowedValues")
@classmethod
def _validate_allowed_values_item(
cls, value: ParameterStringValue, info: ValidationInfo
) -> ParameterStringValue:
cls, value: AllowedParameterStringValueList, info: ValidationInfo
) -> AllowedParameterStringValueList:
if value is None:
raise ValueError(_ALLOWED_VALUES_NONE_ERROR)
min_length = info.data.get("minLength")
max_length = info.data.get("maxLength")
errors = list[InitErrorDetails]()
Expand All @@ -1462,7 +1471,7 @@ def _validate_allowed_values_item(
errors.append(
InitErrorDetails(
type="value_error",
loc=("allowedValues", i),
loc=(i,),
ctx={"error": ValueError("Value is shorter than minLength.")},
input=item,
)
Expand All @@ -1472,7 +1481,7 @@ def _validate_allowed_values_item(
errors.append(
InitErrorDetails(
type="value_error",
loc=("allowedValues", i),
loc=(i,),
ctx={"error": ValueError("Value is longer than maxLength.")},
input=item,
)
Expand Down Expand Up @@ -1610,7 +1619,7 @@ class JobIntParameterDefinition(OpenJDModel_v2023_09):
allowedValues (Optional[AllowedIntParameterList]): Explicit list of values that the
parameter is allowed to take on.
minValue (Optional[int]): Minimum value that the parameter is allowed to be.
maxValue (Optional[int]): Minimum value that the parameter is allowed to be.
maxValue (Optional[int]): Maximum value that the parameter is allowed to be.
"""

name: Identifier
Expand Down Expand Up @@ -1671,7 +1680,12 @@ def _validate_max_value_type(cls, value: Optional[Any]) -> Optional[Any]:

@field_validator("allowedValues", mode="before")
@classmethod
def _validate_allowed_values_item_type(cls, value: Any) -> Any:
def _validate_allowed_values_item_type(
cls, value: AllowedIntParameterList
) -> AllowedIntParameterList:
if value is None:
raise ValueError(_ALLOWED_VALUES_NONE_ERROR)

errors = list[InitErrorDetails]()
for i, item in enumerate(value):
if isinstance(item, bool) or not isinstance(item, (int, str)):
Expand Down Expand Up @@ -1712,7 +1726,11 @@ def _validate_max_value(cls, value: Optional[int], info: ValidationInfo) -> Opti

@field_validator("allowedValues")
@classmethod
def _validate_allowed_values_item(cls, value: list[int], info: ValidationInfo) -> list[int]:
def _validate_allowed_values_item(
cls, value: AllowedIntParameterList, info: ValidationInfo
) -> AllowedIntParameterList:
if value is None:
raise ValueError(_ALLOWED_VALUES_NONE_ERROR)
min_value = info.data.get("minValue")
max_value = info.data.get("maxValue")
errors = list[InitErrorDetails]()
Expand All @@ -1723,7 +1741,7 @@ def _validate_allowed_values_item(cls, value: list[int], info: ValidationInfo) -
InitErrorDetails(
type="value_error",
loc=(i,),
ctx={"error": ValueError("Value less than minValue.")},
ctx={"error": ValueError(_VALUE_LESS_THAN_MIN_ERROR)},
input=item,
)
)
Expand All @@ -1733,7 +1751,7 @@ def _validate_allowed_values_item(cls, value: list[int], info: ValidationInfo) -
InitErrorDetails(
type="value_error",
loc=(i,),
ctx={"error": ValueError("Value larger than minValue.")},
ctx={"error": ValueError(_VALUE_LARGER_THAN_MAX_ERROR)},
input=item,
)
)
Expand All @@ -1747,11 +1765,11 @@ def _validate_default(cls, value: int, info: ValidationInfo) -> int:
min_value = info.data.get("minValue")
if min_value is not None:
if value < min_value:
raise ValueError("Value less than minValue.")
raise ValueError(_VALUE_LESS_THAN_MIN_ERROR)
max_value = info.data.get("maxValue")
if max_value is not None:
if value > max_value:
raise ValueError("Value larger than maxValue.")
raise ValueError(_VALUE_LARGER_THAN_MAX_ERROR)

allowed_values = info.data.get("allowedValues")
if allowed_values is not None:
Expand Down Expand Up @@ -1856,7 +1874,7 @@ class JobFloatParameterDefinition(OpenJDModel_v2023_09):
allowedValues (Optional[AllowedFloatParameterList]): Explicit list of values that the
parameter is allowed to take on.
minValue (Optional[Decimal]): Minimum value that the parameter is allowed to be.
maxValue (Optional[Decimal]): Minimum value that the parameter is allowed to be.
maxValue (Optional[Decimal]): Maximum value that the parameter is allowed to be.
"""

name: Identifier
Expand Down Expand Up @@ -1909,8 +1927,10 @@ def _validate_max_value(
@field_validator("allowedValues")
@classmethod
def _validate_allowed_values_item(
cls, value: list[Decimal], info: ValidationInfo
) -> list[Decimal]:
cls, value: AllowedFloatParameterList, info: ValidationInfo
) -> AllowedFloatParameterList:
if value is None:
raise ValueError(_ALLOWED_VALUES_NONE_ERROR)
min_value = info.data.get("minValue")
max_value = info.data.get("maxValue")
errors = list[InitErrorDetails]()
Expand All @@ -1921,7 +1941,7 @@ def _validate_allowed_values_item(
InitErrorDetails(
type="value_error",
loc=(i,),
ctx={"error": ValueError("Value less than minValue.")},
ctx={"error": ValueError(_VALUE_LESS_THAN_MIN_ERROR)},
input=item,
)
)
Expand All @@ -1931,7 +1951,7 @@ def _validate_allowed_values_item(
InitErrorDetails(
type="value_error",
loc=(i,),
ctx={"error": ValueError("Value larger than maxValue.")},
ctx={"error": ValueError(_VALUE_LARGER_THAN_MAX_ERROR)},
input=item,
)
)
Expand All @@ -1945,11 +1965,11 @@ def _validate_default(cls, value: Decimal, info: ValidationInfo) -> Decimal:
min_value = info.data.get("minValue")
if min_value is not None:
if value < min_value:
raise ValueError("Value less than minValue.")
raise ValueError(_VALUE_LESS_THAN_MIN_ERROR)
max_value = info.data.get("maxValue")
if max_value is not None:
if value > max_value:
raise ValueError("Value larger than maxValue.")
raise ValueError(_VALUE_LARGER_THAN_MAX_ERROR)

allowed_values = info.data.get("allowedValues")
if allowed_values is not None:
Expand Down
Loading
Loading