Module signals_notebook.entities.stoichiometry.cell

Expand source code
from enum import Enum
from typing import Optional

from pydantic import BaseModel, Field


class ColumnDataType(str, Enum):
    NUMBER = 'number'
    INTEGER = 'integer'
    TEXT = 'text'
    HTML = 'html'
    BOOLEAN = 'boolean'
    UNIT = 'unit'
    LINK = 'link'


class ColumnDefinition(BaseModel):
    key: str
    title: str
    type: ColumnDataType
    measure: Optional[str]
    read_only: Optional[bool] = Field(default=None, alias='readOnly')
    hidden: Optional[bool] = Field(default=None)
    hideable: Optional[bool] = Field(default=None)
    prevent_edit_identity: Optional[bool] = Field(default=None, alias='preventEditIdentity')
    prevent_toggle_read_only: Optional[bool] = Field(default=None, alias='preventToggleReadOnly')

    class Config:
        frozen = True


class ColumnDefinitions(BaseModel):
    reactants: Optional[list[ColumnDefinition]]
    products: Optional[list[ColumnDefinition]]
    solvents: Optional[list[ColumnDefinition]]
    conditions: Optional[list[ColumnDefinition]]

    class Config:
        frozen = True

Classes

class ColumnDataType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code
class ColumnDataType(str, Enum):
    NUMBER = 'number'
    INTEGER = 'integer'
    TEXT = 'text'
    HTML = 'html'
    BOOLEAN = 'boolean'
    UNIT = 'unit'
    LINK = 'link'

Ancestors

  • builtins.str
  • enum.Enum

Class variables

var BOOLEAN
var HTML
var INTEGER
var NUMBER
var TEXT
var UNIT
class ColumnDefinition (**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 ColumnDefinition(BaseModel):
    key: str
    title: str
    type: ColumnDataType
    measure: Optional[str]
    read_only: Optional[bool] = Field(default=None, alias='readOnly')
    hidden: Optional[bool] = Field(default=None)
    hideable: Optional[bool] = Field(default=None)
    prevent_edit_identity: Optional[bool] = Field(default=None, alias='preventEditIdentity')
    prevent_toggle_read_only: Optional[bool] = Field(default=None, alias='preventToggleReadOnly')

    class Config:
        frozen = True

Ancestors

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

Class variables

var Config
var hidden : Optional[bool]
var hideable : Optional[bool]
var key : str
var measure : Optional[str]
var prevent_edit_identity : Optional[bool]
var prevent_toggle_read_only : Optional[bool]
var read_only : Optional[bool]
var title : str
var typeColumnDataType
class ColumnDefinitions (**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 ColumnDefinitions(BaseModel):
    reactants: Optional[list[ColumnDefinition]]
    products: Optional[list[ColumnDefinition]]
    solvents: Optional[list[ColumnDefinition]]
    conditions: Optional[list[ColumnDefinition]]

    class Config:
        frozen = True

Ancestors

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

Class variables

var Config
var conditions : Optional[list]
var products : Optional[list]
var reactants : Optional[list]
var solvents : Optional[list]