Source code for sdk.lusid.models.model_property

# coding: utf-8

"""
    LUSID API

    FINBOURNE Technology  # noqa: E501

    Contact: info@finbourne.com
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""


from __future__ import annotations
import pprint
import re  # noqa: F401
import json


from typing import List, Dict, Optional, Any, Union, TYPE_CHECKING
from typing_extensions import Annotated
from pydantic.v1 import BaseModel, StrictStr, StrictInt, StrictBool, StrictFloat, StrictBytes, Field, validator, ValidationError, conlist, constr
from datetime import datetime
from lusid.models.property_reference_data_value import PropertyReferenceDataValue
from lusid.models.property_value import PropertyValue

[docs] class ModelProperty(BaseModel): """ ModelProperty """ key: StrictStr = Field(...,alias="key", description="The key of the property. This takes the format {domain}/{scope}/{code} e.g. 'Instrument/system/Name' or 'Transaction/strategy/quantsignal'.") value: Optional[PropertyValue] = None effective_from: Optional[datetime] = Field(default=None, description="The effective datetime from which the property is valid.", alias="effectiveFrom") effective_until: Optional[datetime] = Field(default=None, description="The effective datetime until which the property is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveFrom' datetime of the property.", alias="effectiveUntil") reference_data: Optional[Dict[str, PropertyReferenceDataValue]] = Field(default=None, description="The ReferenceData linked to the value of the property. The ReferenceData is taken from the DataType on the PropertyDefinition that defines the property.", alias="referenceData") __properties = ["key", "value", "effectiveFrom", "effectiveUntil", "referenceData"]
[docs] class Config: """Pydantic configuration""" allow_population_by_field_name = True validate_assignment = True
def __str__(self): """For `print` and `pprint`""" return pprint.pformat(self.dict(by_alias=False)) def __repr__(self): """For `print` and `pprint`""" return self.to_str()
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.dict(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> ModelProperty: """Create an instance of ModelProperty from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] def to_dict(self): """Returns the dictionary representation of the model using alias""" _dict = self.dict(by_alias=True, exclude={ "reference_data", }, exclude_none=True) # override the default output from pydantic by calling `to_dict()` of value if self.value: _dict['value'] = self.value.to_dict() # override the default output from pydantic by calling `to_dict()` of each value in reference_data (dict) _field_dict = {} if self.reference_data: for _key in self.reference_data: if self.reference_data[_key]: _field_dict[_key] = self.reference_data[_key].to_dict() _dict['referenceData'] = _field_dict # set to None if effective_from (nullable) is None # and __fields_set__ contains the field if self.effective_from is None and "effective_from" in self.__fields_set__: _dict['effectiveFrom'] = None # set to None if effective_until (nullable) is None # and __fields_set__ contains the field if self.effective_until is None and "effective_until" in self.__fields_set__: _dict['effectiveUntil'] = None # set to None if reference_data (nullable) is None # and __fields_set__ contains the field if self.reference_data is None and "reference_data" in self.__fields_set__: _dict['referenceData'] = None return _dict
[docs] @classmethod def from_dict(cls, obj: dict) -> ModelProperty: """Create an instance of ModelProperty from a dict""" if obj is None: return None if not isinstance(obj, dict): return ModelProperty.parse_obj(obj) _obj = ModelProperty.parse_obj({ "key": obj.get("key"), "value": PropertyValue.from_dict(obj.get("value")) if obj.get("value") is not None else None, "effective_from": obj.get("effectiveFrom"), "effective_until": obj.get("effectiveUntil"), "reference_data": dict( (_k, PropertyReferenceDataValue.from_dict(_v)) for _k, _v in obj.get("referenceData").items() ) if obj.get("referenceData") is not None else None }) return _obj
ModelProperty.update_forward_refs()