add freeze annotation
#17374
add freeze annotation
#17374
Conversation
CodSpeed Performance ReportMerging #17374 will not alter performanceComparing Summary
|
| self.parameter_openapi_schema is not None | ||
| and key in self.parameter_openapi_schema.get("properties", {}) | ||
| ): | ||
| self.parameter_openapi_schema["properties"][key]["readOnly"] = True |
There was a problem hiding this comment.
does the UI do anything with this property?
There was a problem hiding this comment.
yes! you can't edit the value in the UI
| and key in self.parameter_openapi_schema.get("properties", {}) | ||
| ): | ||
| self.parameter_openapi_schema["properties"][key]["readOnly"] = True | ||
| self.parameter_openapi_schema["properties"][key]["enum"] = [ |
There was a problem hiding this comment.
does this require the raw value to be JSON serializable or otherwise impose any restrictions on the types you can freeze?
There was a problem hiding this comment.
hmm. yes I think values would need to be JSON serializable.. open to suggestions on how to handle that
There was a problem hiding this comment.
Yea that's probably fine for now (maybe we should add a ValueError validation to freeze(...)?) but I can see a world where more complex types are requested
| @classmethod | ||
| def __get_pydantic_core_schema__( | ||
| cls, source: type[Any], handler: GetCoreSchemaHandler | ||
| ) -> core_schema.CoreSchema: | ||
| return core_schema.no_info_after_validator_function( | ||
| cls, # Use the class itself as the validator | ||
| core_schema.any_schema(), | ||
| serialization=core_schema.plain_serializer_function_ser_schema( | ||
| lambda x: x.unfreeze() # Serialize by unwrapping the value | ||
| ), | ||
| ) |
There was a problem hiding this comment.
this shouldn't matter as far as its use in RunnerDeployment, but will make it behave more predictably in general
closes #11073
this PR adds a
freezeannotation type as described in the linked PR. adding a parameterized type (e.g.freeze[str]) is not necessarythe field's value becomes a read-only
Enumwith only this member value (which be refined to more specifically patch the parameter schema)