Board Membership¶

CLASS	DESCRIPTION
`BoardMembership`	Python interface for Planka BoardMemberships

BoardMembership ¶

BoardMembership(schema: Schema, session: Planka)

Bases: PlankaModel[BoardMembership]

Python interface for Planka BoardMemberships

Returned by:

Plankapy v2 models
- Board Board
- Project Project board_memberships

METHOD	DESCRIPTION
`copy`	Create a deepcopy of the model and its associated schema.
`delete`	Delete the BoardMebership
`diff`	Get a schema diff between two model schemas.
`sync`	Sync the BoardMembership with the Planka server
`update`	Update the BoardMembership

ATTRIBUTE	DESCRIPTION
`__formatter__`	Formatter func that allows overriding str behavior for models TYPE: `ModelFormatter[Self]`
`board`	The Board the BoardMembership is associated with TYPE: `Board`
`can_comment`	Whether the user can comment on cards TYPE: `bool`
`created_at`	When the board membership was created TYPE: `datetime`
`project`	The Project the BoardMembership belongs to TYPE: `Project`
`role`	Role of the user in the board TYPE: `BoardRole`
`updated_at`	When the board membership was last updated TYPE: `datetime`
`user`	The User the BoardMembership is associated with (Raises LookupError if User no longer in 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

board `property` ¶

board: Board

The Board the BoardMembership is associated with

can_comment `property` `writable` ¶

can_comment: bool

Whether the user can comment on cards

created_at `property` ¶

created_at: datetime

When the board membership was created

project `property` ¶

project: Project

The Project the BoardMembership belongs to

role `property` `writable` ¶

role: BoardRole

Role of the user in the board

updated_at `property` ¶

updated_at: datetime

When the board membership was last updated

user `property` ¶

user: User

The User the BoardMembership is associated with (Raises LookupError if User no longer in 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 BoardMebership

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

def delete(self):
    """Delete the BoardMebership"""
    return self.endpoints.deleteBoardMembership(self.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
    }

sync ¶

sync()

Sync the BoardMembership with the Planka server

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

def sync(self):
    """Sync the BoardMembership with the Planka server"""
    _bms = [bm for bm in self.board.board_memberships if bm == self]
    if _bms:
        self.schema = _bms.pop().schema

update ¶

update(**kwargs: Unpack[Request_updateBoardMembership]) -> None

Update the BoardMembership

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

def update(self, **kwargs: Unpack[paths.Request_updateBoardMembership]) -> None:
    """Update the BoardMembership"""
    self.schema = self.endpoints.updateBoardMembership(self.id, **kwargs)['item']

Board Membership¶