Card Membership

CLASS	DESCRIPTION
CardMembership	Python interface for Planka CardMemberships

CardMembership

CardMembership(schema: Schema, session: Planka)

Bases: PlankaModel[CardMembership]

Python interface for Planka CardMemberships

Returned by:

• Plankapy v2 models
  • Board  Board  card_memberships
  • Card  Card
    •  card_memberships
    •  add_member
    •  add_members
  • List  List  card_memberships

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

ATTRIBUTE	DESCRIPTION
__formatter__	Formatter func that allows overriding str behavior for models TYPE: ModelFormatter[Self]
card	The Card the User is a member of TYPE: Card
created_at	When the card membership was created TYPE: datetime
updated_at	When the card membership was last updated TYPE: datetime
user	The User who is a member of the Card (Raise LookupError if the User is no longer on the 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

card property

card: Card

The Card the User is a member of

created_at property

created_at: datetime

When the card membership was created

updated_at property

updated_at: datetime

When the card membership was last updated

user property

user: User

The User who is a member of the Card (Raise LookupError if the User is no longer on the 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)

delete

delete()

Delete the CardMembership

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

def delete(self):
    """Delete the CardMembership"""
    return self.endpoints.deleteCardMembership(userId=self.user.id, cardId=self.card.id)

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
    }