Module signals_notebook.entities.parallel_experiment.row

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):
    columns: Optional[dict]

Ancestors

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

Class variables

var columns : Optional[dict]

class Row (**data)

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 Row(BaseModel):
    id: Optional[Union[UUID, str]]
    cells: List[SubExperimentSummaryCell] = Field(alias='columns')
    _cells_dict: Dict[Union[UUID, str], SubExperimentSummaryCell] = PrivateAttr(default={})

    class Config:
        validate_assignment = True

    def __init__(self, **data):
        super().__init__(**data)

        for cell in self.cells:
            self._cells_dict[cell.key] = cell

    def get(self, value: str, default: Any = None) -> Union[SubExperimentSummaryCell, Any]:
        """Get one of the cells

        Args:
            value: key to get one of the cells
            default: default value if key doesn't exist

        Returns:
            Union[Cell, Any]
        """
        try:
            return self[value]
        except KeyError:
            log.debug('KeyError were caught. Default value returned')
            return default

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

        Returns:
            bool: True/False
        """
        return any([cell.is_changed for cell in self.cells])

    def __getitem__(self, index: str) -> SubExperimentSummaryCell:
        if isinstance(index, str):
            if index in self._cells_dict:
                return self._cells_dict[index]

        log.exception('IndexError were caught. Invalid index')
        raise IndexError('Invalid index')

    def __iter__(self):
        return self.cells.__iter__()

    @property
    def representation_for_update(self) -> List[Dict[str, str]]:
        """Present Row object as a request body to update values

        Returns:
            list of changed cells
        """
        changed_cells = []
        for cell in self.cells:
            if cell.is_changed:
                body = RowRequestBody(id=str(self.id), attributes=Content(columns=cell.representation_for_update))
                changed_cells.append(body.dict())

        return changed_cells

Ancestors

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

Class variables

var Config

var cells : List[SubExperimentSummaryCell]

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

Instance variables

var is_changed : bool

Get is_changed field

Returns

bool

True/False

Expand source code

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

    Returns:
        bool: True/False
    """
    return any([cell.is_changed for cell in self.cells])

var representation_for_update : List[Dict[str, str]]

Present Row object as a request body to update values

Returns

list of changed cells

Expand source code

@property
def representation_for_update(self) -> List[Dict[str, str]]:
    """Present Row object as a request body to update values

    Returns:
        list of changed cells
    """
    changed_cells = []
    for cell in self.cells:
        if cell.is_changed:
            body = RowRequestBody(id=str(self.id), attributes=Content(columns=cell.representation_for_update))
            changed_cells.append(body.dict())

    return changed_cells

Methods

def get(self, value: str, default: Any = None) ‑> Union[SubExperimentSummaryCell, Any]

Get one of the cells

Args

value

key to get one of the cells

default

default value if key doesn't exist

Returns

Union[Cell, Any]

Expand source code

def get(self, value: str, default: Any = None) -> Union[SubExperimentSummaryCell, Any]:
    """Get one of the cells

    Args:
        value: key to get one of the cells
        default: default value if key doesn't exist

    Returns:
        Union[Cell, Any]
    """
    try:
        return self[value]
    except KeyError:
        log.debug('KeyError were caught. Default value returned')
        return default

class RowRequestBody (**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 RowRequestBody(BaseModel):
    id: Optional[Union[UUID, str]]
    type: Literal[ObjectType.SUB_EXPERIMENT] = Field(allow_mutation=False, default=ObjectType.SUB_EXPERIMENT)
    attributes: Content

    class Config:
        validate_assignment = True

Ancestors

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

Class variables

var Config

var attributes : Content

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

var type : Literal[]