Action

CLASS	DESCRIPTION
Action	Python interface for Planka Actions

Action

Action(schema: Schema, session: Planka)

Bases: PlankaModel[Action]

Python interface for Planka Actions

Returned by:

• Plankapy v2 models
  • Card  Card  actions
  • Notification  Notification  action

METHOD	DESCRIPTION
copy	Create a deepcopy of the model and its associated schema.
diff	Get a schema diff between two model schemas.

ATTRIBUTE	DESCRIPTION
__formatter__	Formatter func that allows overriding str behavior for models TYPE: ModelFormatter[Self]
board	The Board where the Action occurred TYPE: Board
card	The Card where the Action occurred TYPE: Card
created_at	When the Action was created TYPE: datetime
data	The specific data associated with the Action (type dependant) TYPE: dict[str, Any]
type	The type of the Action
updated_at	When the Action was last updated TYPE: datetime
user	The User who performed the Action (Raise LookupError if User is not found in Board) TYPE: User

Source code in src/plankapy/v2/models/_base.py

def __init__(self, schema: Schema, session: Planka) -> None:
    self._schema = schema
    self.session = session
    self.endpoints = session.endpoints
    self.client = session.client
    self.current_role = session.current_role
    self.current_id = session.current_id

__formatter__ class-attribute instance-attribute

__formatter__: ModelFormatter[Self] = DEFAULT_FORMATTER

Formatter func that allows overriding str behavior for models

board property

board: Board

The Board where the Action occurred

card property

card: Card

The Card where the Action occurred

created_at property

created_at: datetime

When the Action was created

data property

data: dict[str, Any]

The specific data associated with the Action (type dependant)

type property

type

The type of the Action

updated_at property

updated_at: datetime

When the Action was last updated

user property

user: User

The User who performed the Action (Raise LookupError if User is not found in Board)

copy

copy() -> Self

Create a deepcopy of the model and its associated schema.

Note

Since the endpoints for both instances of the Model are the same, any calls to update will restore the state and bring both copies into sync. copies like this are meant more for comparing changes when running a sync or update/assignemnt operation.

Example:

    >>> card_copy = card.copy()
    >>> card.name = 'Updated Name'
    >>> card_copy.name
    'Original Name'
    >>> card.name
    'Updated Name'
    >>> # This update may have had side effects
    >>> print(card_copy.diff(card))
    {'name': ('Original Name', 'Updated Name'), 'updatedAt': ('...2:00pm', '...2:45pm'), ...}

Source code in src/plankapy/v2/models/_base.py

def copy(self) -> Self:
    """Create a deepcopy of the model and its associated schema.

    Note:
        Since the endpoints for both instances of the Model are the same, any 
        calls to update will restore the state and bring both copies into sync. 
        copies like this are meant more for comparing changes when running a sync 
        or update/assignemnt operation.

    Example:
    ```python
        >>> card_copy = card.copy()
        >>> card.name = 'Updated Name'
        >>> card_copy.name
        'Original Name'
        >>> card.name
        'Updated Name'
        >>> # This update may have had side effects
        >>> print(card_copy.diff(card))
        {'name': ('Original Name', 'Updated Name'), 'updatedAt': ('...2:00pm', '...2:45pm'), ...}
    ```
    """
    return copy.deepcopy(self)

diff

diff(other: PlankaModel[Schema]) -> Diff

Get a schema diff between two model schemas.

Note

Only matching keys are diffed. Any schema keys that are not in the source schema will not be checked in the target schema

Source code in src/plankapy/v2/models/_base.py

def diff(self, other: PlankaModel[Schema]) -> Diff:
    """Get a schema diff between two model schemas.

    Note:
        Only matching keys are diffed. Any schema keys that are not in the source schema 
        will not be checked in the target schema
    """
    return {
        k: (source, delta) 
        for k, source in self.schema
        if k in other.schema
        and (delta := other.schema[k]) 
        and delta != source
    }