Module signals_notebook.entities.samples.cell

Classes

class Content (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class Content(BaseModel):
    content: Optional[SampleCellContent]

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var content : Optional[SampleCellContent]

class SampleCell (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class SampleCell(BaseModel):
    id: Optional[str]
    name: Optional[str]
    content: SampleCellContent = Field(default=SampleCellContent())
    read_only: Optional[bool] = False

    def _is_cell_mutable(self):
        if self.name == 'Amount':
            raise TypeError('Property is immutable')
        if self.read_only:
            raise TypeError('Cell is read only')

    def set_content_value(self, new_value: CellValueType) -> None:
        """Set new content value

        Args:
            new_value: new value of SampleCellContent value field

        Returns:

        """
        self._is_cell_mutable()
        self.content._set_value(new_value)

    def set_content_values(self, new_values: List[CellValueType]) -> None:
        """Set new content values

        Args:
            new_values: new list of values of SampleCellContent values field

        Returns:

        """
        self._is_cell_mutable()
        self.content._set_values(new_values)

    def set_content_name(self, new_name: str) -> None:
        """Set new content name

        Args:
            new_name: new name of SampleCellContent name field

        Returns:

        """
        self._is_cell_mutable()
        self.content._set_name(new_name)

    @property
    def content_value(self) -> Optional[CellValueType]:
        """Get content value

        Returns:
            Optional[CellValueType]
        """
        return self.content.value

    @property
    def content_values(self) -> Optional[List[CellValueType]]:
        """Get content values

        Returns:
            Optional[List[CellValueType]]
        """
        return self.content.values

    @property
    def content_name(self) -> Optional[str]:
        """Get content name

        Returns:
            Optional[str]
        """
        return self.content.name

    @property
    def is_changed(self) -> bool:
        """Checking if SampleCell has been modified

        Returns:
            bool
        """
        return False if self.content is None else self.content.is_changed

    @property
    def representation_for_update(self) -> SampleCellBody:
        """Get representation of body for update

        Returns:
            SampleCellBody
        """
        return SampleCellBody(
            id=str(self.id), attributes=Content(content=self.content.dict(include={'value', 'values', 'name'}))
        )

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var content : SampleCellContent

var id : Optional[str]

var name : Optional[str]

var read_only : Optional[bool]

Instance variables

var content_name : Optional[str]

Get content name

Returns

Optional[str]

Expand source code

@property
def content_name(self) -> Optional[str]:
    """Get content name

    Returns:
        Optional[str]
    """
    return self.content.name

var content_value : Optional[~CellValueType]

Get content value

Returns

Optional[CellValueType]

Expand source code

@property
def content_value(self) -> Optional[CellValueType]:
    """Get content value

    Returns:
        Optional[CellValueType]
    """
    return self.content.value

var content_values : Optional[List[~CellValueType]]

Get content values

Returns

Optional[List[CellValueType]]

Expand source code

@property
def content_values(self) -> Optional[List[CellValueType]]:
    """Get content values

    Returns:
        Optional[List[CellValueType]]
    """
    return self.content.values

var is_changed : bool

Checking if SampleCell has been modified

Returns

bool

Expand source code

@property
def is_changed(self) -> bool:
    """Checking if SampleCell has been modified

    Returns:
        bool
    """
    return False if self.content is None else self.content.is_changed

var representation_for_update : SampleCellBody

Get representation of body for update

Returns

SampleCellBody

Expand source code

@property
def representation_for_update(self) -> SampleCellBody:
    """Get representation of body for update

    Returns:
        SampleCellBody
    """
    return SampleCellBody(
        id=str(self.id), attributes=Content(content=self.content.dict(include={'value', 'values', 'name'}))
    )

Methods

def set_content_name(self, new_name: str) ‑> None

Set new content name

Args

new_name

new name of SampleCellContent name field

Returns:

Expand source code

def set_content_name(self, new_name: str) -> None:
    """Set new content name

    Args:
        new_name: new name of SampleCellContent name field

    Returns:

    """
    self._is_cell_mutable()
    self.content._set_name(new_name)

def set_content_value(self, new_value: ~CellValueType) ‑> None

Set new content value

Args

new_value

new value of SampleCellContent value field

Returns:

Expand source code

def set_content_value(self, new_value: CellValueType) -> None:
    """Set new content value

    Args:
        new_value: new value of SampleCellContent value field

    Returns:

    """
    self._is_cell_mutable()
    self.content._set_value(new_value)

def set_content_values(self, new_values: List[~CellValueType]) ‑> None

Set new content values

Args

new_values

new list of values of SampleCellContent values field

Returns:

Expand source code

def set_content_values(self, new_values: List[CellValueType]) -> None:
    """Set new content values

    Args:
        new_values: new list of values of SampleCellContent values field

    Returns:

    """
    self._is_cell_mutable()
    self.content._set_values(new_values)

class SampleCellBody (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class SampleCellBody(BaseModel):
    id: Optional[Union[UUID, str]]
    type: str = ObjectType.PROPERTY
    attributes: Content

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var attributes : Content

var id : Union[uuid.UUID, str, ForwardRef(None)]

var type : str

class SampleCellContent (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class SampleCellContent(GenericModel, Generic[CellValueType]):
    value: Optional[CellValueType]
    name: Optional[str]
    eid: Optional[EID]
    values: Optional[List[CellValueType]]
    display: Optional[str]
    units: Optional[str]
    _changed: bool = PrivateAttr(default=False)

    def _set_value(self, new_value: CellValueType) -> None:
        """Set new value

        Args:
            new_value: new value for value field

        Returns:

        """
        self.value = new_value
        self._changed = True

    def _set_values(self, new_values: List[CellValueType]) -> None:
        """Set new values

        Args:
            new_values: new list of values for values field

        Returns:

        """
        self.values = new_values
        self._changed = True

    def _set_name(self, new_name: str) -> None:
        """Set new name

        Args:
            new_name: new name for name field

        Returns:

        """
        self.name = new_name
        self._changed = True

    @property
    def is_changed(self) -> bool:
        """Get is_changed value

        Returns:
            bool: True/False
        """
        return self._changed

Ancestors

• pydantic.generics.GenericModel
• pydantic.main.BaseModel
• pydantic.utils.Representation
• typing.Generic

Class variables

var display : Optional[str]

var eid : Optional[EID]

var name : Optional[str]

var units : Optional[str]

var value : Optional[~CellValueType]

var values : Optional[List[~CellValueType]]

Instance variables

var is_changed : bool

Get is_changed value

Returns

bool

True/False

Expand source code

@property
def is_changed(self) -> bool:
    """Get is_changed value

    Returns:
        bool: True/False
    """
    return self._changed