Source code for pykechain.models.property_selectlist

from abc import abstractmethod
from copy import deepcopy
from typing import Any, Iterable

from jsonschema import validate

from pykechain.enums import Category
from pykechain.exceptions import APIError, IllegalArgumentError
from pykechain.models.property import Property
from pykechain.models.validators.validator_schemas import options_json_schema


class _SelectListProperty(Property):
    """A select list property that needs to update its options."""

    def __init__(self, json, **kwargs):
        """Construct a Property from a json object."""
        super().__init__(json, **kwargs)

        self._value_choices = json.get("value_options").get("value_choices")

    @property
    def value(self):
        """Retrieve the data value of a property.

        Setting this value will immediately update the property in KE-chain.
        The value should be in the list of options.

        :raises APIError: when unable to set the value or the value is not in the list of options
        """
        return deepcopy(self._value)

    @value.setter
    def value(self, value: Any):
        if value is not None:
            self._check_new_value(value=value)

        if self.use_bulk_update:
            self._pend_update(dict(value=value))
            self._value = value
        else:
            self._put_value(value)

    @abstractmethod
    def _check_new_value(self, value: Any):
        """
        Abstract method to validate the new value.

        :param value: any new value
        :return: sanitized value
        :raises APIError: when unable to set the value or the value is not in the list of options
        """
        pass  # pragma: no cover

    @property
    def options(self):
        """
        Get or set the options of the select list property if the property is a property model.

        Will raise an exception if the property is not a model. Will also raise an exception if the list is of
        incorrect form and contains non string, floats or integers.

        :param options_list: list of options to set, using only strings, integers and floats in the list.
        :type options_list: list
        :raises APIError: When unable to set the list of options
        :raises IllegalArgumentError: When the options_list is not in the right form or type, or the property is not
                                      a property model (:class:`Property` with category MODEL)

        Example
        -------
        >>> a_model = project.model('Model')
        >>> select_list_property = a_model.property('a_select_list_property')

        Get the list of options on the property
        >>> select_list_property.options
        ['1', '2', '3', '4']

        Update the list of options
        >>> select_list_property.options = [1,3,5,"wow"]

        List of options of this property to select from.

        """
        return deepcopy(self._value_choices)

    @options.setter
    def options(self, options_list):
        if not isinstance(options_list, list):
            raise IllegalArgumentError("The list of options should be a list")
        if self._json_data.get("category") != Category.MODEL:
            raise IllegalArgumentError(
                "We can only update the options list of the model of this property. The "
                "model of this property has id '{}'".format(
                    self._json_data.get("model")
                )
            )

        # stringify the options list
        options_list = list(map(str, options_list))

        # check if the options are not already set and indeed different
        if not self._value_choices or set(options_list) != set(self._value_choices):
            self._put_value_options(options_list=options_list)
            self._value_choices = options_list

    def _put_value_options(self, options_list):
        new_options = (
            self._options.copy()
        )  # make a full copy of the dict not to only link it and update dict in place
        new_options.update({"value_choices": options_list})

        self._put_options(new_options)

    def _save_representations(self, representation_options):
        new_options = (
            self._options.copy()
        )  # make a full copy of the dict not to only link it and update dict in place
        new_options.update({"representations": representation_options})

        self._put_options(new_options)

    def _put_options(self, new_options):
        """Save the options to KE-chain.

        Makes a single API call.

        :param new_options: list of options to set.
        :raises APIError: when unable to update the options
        """
        validate(new_options, options_json_schema)

        url = self._client._build_url("property", property_id=self.id)
        response = self._client._request(
            "PUT", url, json={"value_options": new_options}
        )

        if response.status_code != 200:  # pragma: no cover
            raise APIError(
                f"Could not update options of Property {self}", response=response
            )
        else:
            self._options = new_options  # save the new options as the options


[docs] class SelectListProperty(_SelectListProperty): """A virtual object representing a KE-chain single-select list property.""" def _check_new_value(self, value: Any): if value not in self.options: raise IllegalArgumentError( 'The new value "{}" of the Property should be in the list of options:\n{}'.format( value, self.options ) )
class MultiSelectListProperty(_SelectListProperty): """A virtual object representing a KE-chain multi-select list property.""" def _check_new_value(self, value: Iterable[Any]): if not isinstance(value, (list, tuple)): raise IllegalArgumentError( f'The new values must be provided as a list or tuple, "{value}" is not.' ) if not all(v in self.options for v in value): raise IllegalArgumentError( 'The new values "{}" of the Property should be in the list of options:\n{}'.format( value, self.options ) )