BoardMembership

Bases: BoardMembership_

Interface for interacting with planka Board Memberships

Note

Only memberships that the current user has manager access to can be seen

METHOD	DESCRIPTION
__eq__	Check if two model instances are equal
__getitem__	Get the value of an attribute
__hash__	Generate a hash for the model instance so it can be used in mappings (dict, set)
__iter__	Iterate over public, assigned model attribute names
bind	Bind routes to the model
delete	Deletes the board membership relation
editor	Context manager for editing the model
json	Dump the model properties to a JSON string
pickle	Pickle the model, preserving as much of its state as possible
refresh	Refreshes the board membership data
update	Updates the board membership with new values

ATTRIBUTE	DESCRIPTION
board	Board that the membership is associated with TYPE: Board
created_at	Get the creation date of the model instance TYPE: datetime | None
deleted_at	Get the deletion date of the model instance TYPE: datetime | None
link	Get the link to the model instance TYPE: str | None
routes	Get the routes for the model instance TYPE: Routes
unique_name	Generate a unique name for the model instance using the last 5 characters of the id TYPE: str
updated_at	Get the last update date of the model instance TYPE: datetime | None
user	User that the membership is associated with TYPE: User

board property

board: Board

Board that the membership is associated with

RETURNS	DESCRIPTION
Board	Board instance TYPE: Board

created_at property

created_at: datetime | None

Get the creation date of the model instance

RETURNS	DESCRIPTION
datetime | None	Optional[datetime]: The creation date of the model instance

deleted_at property

deleted_at: datetime | None

Get the deletion date of the model instance

RETURNS	DESCRIPTION
datetime | None	Optional[datetime]: The deletion date of the model instance

link property

link: str | None

Get the link to the model instance

Note

Only Project, Board, and Card models have links.

All other models return None

RETURNS	DESCRIPTION
str	The link to the model instance TYPE: str | None

routes property writable

routes: Routes

Get the routes for the model instance

RETURNS	DESCRIPTION
Routes	The routes bound to the model instance TYPE: Routes

unique_name property

unique_name: str

Generate a unique name for the model instance using the last 5 characters of the id and the name attribute

RETURNS	DESCRIPTION
str	The unique name for the model instance in the format {name}_{id[:-5]} TYPE: str

updated_at property

updated_at: datetime | None

Get the last update date of the model instance

RETURNS	DESCRIPTION
datetime | None	Optional[datetime]: The last update date of the model instance

user property

user: User

User that the membership is associated with

RETURNS	DESCRIPTION
User	User instance TYPE: User

__eq__

__eq__(other: Model) -> bool

Check if two model instances are equal

Note

Compares the hash and class of the model instances

Warning

Does not compare the attributes of the model instances, out of sync models with different attributes can still be equal, it's best to refresh the models before comparing.

PARAMETER	DESCRIPTION
other	The other model instance to compare TYPE: Model

RETURNS	DESCRIPTION
bool	True if the model instances are equal, False otherwise TYPE: bool

Source code in src/plankapy/v1/models.py

def __eq__(self, other: Model) -> bool:
    """Check if two model instances are equal

    Note:
        Compares the hash and class of the model instances

    Warning:
        Does not compare the attributes of the model instances, out of sync models
        with different attributes can still be equal, it's best to refresh the models
        before comparing.

    Args:
        other (Model): The other model instance to compare

    Returns:
        bool: True if the model instances are equal, False otherwise
    """
    return isinstance(other, self.__class__) and hash(self) == hash(other)

__getitem__

__getitem__(key) -> Any

Get the value of an attribute

Warning

This is an implementation detail that allows for the unpacking operations in the rest of the codebase, all model attributes are still directly accessible through __getattribute___

Note

Returns None if the attribute is Unset or starts with an underscore

Example

print(model['name'])
>>> "Model Name"

model.name = Unset
print(model['name'])
>>> None

Source code in src/plankapy/v1/models.py

def __getitem__(self, key) -> Any:
    """Get the value of an attribute

    Warning:
        This is an implementation detail that allows for the unpacking operations
        in the rest of the codebase, all model attributes are still directly accessible
        through `__getattribute___`

    Note:
        Returns None if the attribute is `Unset` or starts with an underscore

    Example:
        ```python
        print(model['name'])
        >>> "Model Name"

        model.name = Unset
        print(model['name'])
        >>> None
        ```
    """
    val = self.__dict__[key]
    return val if val is not Unset else None

__hash__

__hash__() -> int

Generate a hash for the model instance so it can be used in mappings (dict, set)

Note

All Models are still mutable, but their ID value is unique

RETURNS	DESCRIPTION
int	The hash value of the model instance TYPE: int

Example

board_map = {
    Board(name="Board 1"): board.,
    Board(name="Board 2"): "Board 2"
}
>>> 1

Source code in src/plankapy/v1/models.py

def __hash__(self) -> int:
    """Generate a hash for the model instance so it can be used in mappings (`dict`, `set`)

    Note:
        All Models are still mutable, but their ID value is unique

    Returns:
        int: The hash value of the model instance

    Example:
        ```python
        board_map = {
            Board(name="Board 1"): board.,
            Board(name="Board 2"): "Board 2"
        }
        >>> 1
        ```
    """
    if hasattr(self, 'id'):
        return int(self.id)

    # Default hash if no id (string of name and attributes)
    return hash(f"{self.__class__.__name__}{self.__dict__}")

__iter__

__iter__()

Iterate over public, assigned model attribute names

Warning

This is used in conjunction with __getitem__ to unpack assigned values. This allows model state to be passed as keyword arguments to functions

Example:

model = Model(name="Model Name", position=1, other=Unset)

def func(name=None, position=None):
    return {"name": name, "position": position}

print(func(**model))
>>> {'name': 'Model Name', 'position': 1}

Notice how only the assigned values are returned after unpacking and any Unset or private attributes are skipped, This allows None values to be assigned during a PATCH request to delete data

Note

Skips attributes that are Unset or start with an underscore

RETURNS	DESCRIPTION
Iterator	The iterator of the model attributes

Example

# Skip Private attributes
print(list(model.__dict__))
>>> ['_privateattribute', 'name', 'position', 'id']

print(list(model))
>>> ['name', 'position', 'id'] # Skips _privateattribute

# Skip Unset attributes
print(model.___dict___)
>>> {'_privateattribute': 'Private', 'name': 'Model Name', 'position': Unset, 'id': 1}

items = dict(model.items())
print(items)
>>> {'name': 'Model Name', 'id': 1} # Skips position because it's Unset

Source code in src/plankapy/v1/models.py

def __iter__(self):
    """Iterate over public, assigned model attribute names

    Warning:
        This is used in conjunction with `__getitem__` to unpack assigned values. 
        This allows model state to be passed as keyword arguments to functions

        Example:
            ```python
            model = Model(name="Model Name", position=1, other=Unset)

            def func(name=None, position=None):
                return {"name": name, "position": position}

            print(func(**model))
            >>> {'name': 'Model Name', 'position': 1}
            ```
        Notice how only the assigned values are returned after unpacking and any Unset or 
        private attributes are skipped, This allows `None` values to be assigned during
        a `PATCH` request to delete data 

    Note:
        Skips attributes that are `Unset` or start with an underscore

    Returns:
        Iterator: The iterator of the model attributes

    Example:
        ```python

        # Skip Private attributes
        print(list(model.__dict__))
        >>> ['_privateattribute', 'name', 'position', 'id']

        print(list(model))
        >>> ['name', 'position', 'id'] # Skips _privateattribute

        # Skip Unset attributes
        print(model.___dict___)
        >>> {'_privateattribute': 'Private', 'name': 'Model Name', 'position': Unset, 'id': 1}

        items = dict(model.items())
        print(items)
        >>> {'name': 'Model Name', 'id': 1} # Skips position because it's Unset
        ```
    """
    return iter(
        k for k, v in self.__dict__.items() 
        if v is not Unset 
        and not k.startswith("_")
    )

bind

bind(routes: Routes) -> Self

Bind routes to the model Args: routes (Routes): The routes to bind to the model instance

RETURNS	DESCRIPTION
Self	Self for chain operations

Example

model = Model(**kwargs).bind(routes)

Source code in src/plankapy/v1/models.py

def bind(self, routes: Routes) -> Self:
    """Bind routes to the model
    Args:
        routes (Routes): The routes to bind to the model instance

    Returns:
        Self for chain operations

    Example:
        ```python
        model = Model(**kwargs).bind(routes)
        ```
    """
    self.routes = routes
    return self

delete

delete() -> tuple[User, Board]

Deletes the board membership relation

Danger

This action is irreversible and cannot be undone

RETURNS	DESCRIPTION
User	The user that was removed from the board TYPE: tuple[User, Board]

Source code in src/plankapy/v1/interfaces.py

def delete(self) -> tuple[User, Board]:
    """Deletes the board membership relation

    Danger:
        This action is irreversible and cannot be undone

    Returns:
        User: The user that was removed from the board
    """
    self.refresh()
    route = self.routes.delete_board_membership(id=self.id)
    route()
    return (self.user, self.board)

editor

editor() -> Generator[Self, None, None]

Context manager for editing the model

Example

print(model.name)
>>> "Old Name"
with model.editor() as m:
    m.name = "New Name"
    m.position = 1

print(model.name)
>>> "New Name"

Source code in src/plankapy/v1/models.py

@contextmanager
def editor(self) -> Generator[Self, None, None]:
    """Context manager for editing the model

    Example:
        ```python
        print(model.name)
        >>> "Old Name"
        with model.editor() as m:
            m.name = "New Name"
            m.position = 1

        print(model.name)
        >>> "New Name"
        ```

    """
    try:
        self.refresh()
        _self = self.__dict__.copy() # Backup the model state
        yield self
    except Exception as e:
        self.__dict__ = _self # Restore the model state
        raise e
    finally:
        self.update()

json

json() -> str

Dump the model properties to a JSON string

Note

Only properties defined in the {Model}_ dataclass are dumped. All relationships and included items (e.g. board.cards) are lost. If you wish to preserve these relationships, use the .pickle method

RETURNS	DESCRIPTION
str	(str) : A JSON string with the Model attributes

Source code in src/plankapy/v1/models.py

def json(self) -> str:
    """Dump the model properties to a JSON string

    Note:
        Only properties defined in the `{Model}_` dataclass are dumped. 
        All relationships and included items (e.g. `board.cards`) are lost.
        If you wish to preserve these relationships, use the `.pickle` method

    Returns:
        (str) : A JSON string with the Model attributes
    """
    return json.dumps({k: self[k] for k in self})

pickle

pickle() -> bytes

Pickle the model, preserving as much of its state as possible

Warning

This method currently works, and since the object data is updated by routes You can use this to store a reference to a specific object. The data will be maintained until operations that trigger a .refresh() call are made, e.g. using the .editor() context.

RETURNS	DESCRIPTION
bytes	(bytes) : Raw bytes generated by pickle.dump

Source code in src/plankapy/v1/models.py

def pickle(self) -> bytes:
    """Pickle the model, preserving as much of its state as possible

    Warning:
        This method currently works, and since the object data is updated by routes
        You can use this to store a reference to a specific object. The data will be
        maintained until operations that trigger a `.refresh()` call are made, e.g. 
        using the `.editor()` context.

    Returns:
        (bytes) : Raw bytes generated by `pickle.dump`
    """
    out = io.BufferedWriter(raw=io.BytesIO())
    pickle.dump(self, out)
    return out.raw.read()

refresh

refresh() -> None

Refreshes the board membership data

Source code in src/plankapy/v1/interfaces.py

def refresh(self) -> None:
    """Refreshes the board membership data"""
    for membership in self.board.boardMemberships:
        if membership.id == self.id:
            self.__init__(**membership)

update

update()

update(boardMembership: BoardMembership)

update(role: BoardRole = None, canComment: bool = None)

update(*args, **kwargs) -> BoardMembership

Updates the board membership with new values

Tip

Use .editor() context manager to update the board membership with the user as an editor

Example:

>>> with boardMembership.editor():
...    boardMembership.role = 'editor'

>>> boardMembership
BoardMembership(userId='...', boardId='...', role='editor', canComment=True)

Warning

canComment will always be set to True if the role is 'editor', if a context is used as a user is switched to a viewer, they will maintain their ability to comment unless explicitly set to False

Example:

>>> boardMembership.role
'editor'

>>> with boardMembership.editor():
...    boardMembership.role = 'viewer'

>>> boardMembership.canComment
True

>>> # Using .update() will not automatically set canComment to False
>>> # on role change unless specified
>>> boardMembership.update(role='viewer')
>>> boardMembership.canComment
False

PARAMETER	DESCRIPTION
role	Role of the user in the board (default: None) TYPE: BoardRole
canComment	Whether the user can comment on the board (default: None) TYPE: bool

ALTERNATE	DESCRIPTION
boardMembership	Board membership instance to update with TYPE: BoardMembership

RETURNS	DESCRIPTION
BoardMembership	Updated board membership instance TYPE: BoardMembership

RAISES	DESCRIPTION
ValueError	If the role is invalid (must be 'viewer' or 'editor')

Note

If no arguments are provided, the board membership will update itself with the current values stored in its attributes

Source code in src/plankapy/v1/interfaces.py

def update(self, *args, **kwargs) -> BoardMembership:
    """Updates the board membership with new values

    Tip:
        Use `.editor()` context manager to update the board membership with the user as an editor

        Example:
        ```python
        >>> with boardMembership.editor():
        ...    boardMembership.role = 'editor'

        >>> boardMembership
        BoardMembership(userId='...', boardId='...', role='editor', canComment=True)
        ```

    Warning:
        canComment will always be set to True if the role is 'editor', if a context is used as a user is 
        switched to a viewer, they will maintain their ability to comment unless explicitly set to False

        Example:
        ```python
        >>> boardMembership.role
        'editor'

        >>> with boardMembership.editor():
        ...    boardMembership.role = 'viewer'

        >>> boardMembership.canComment
        True

        >>> # Using .update() will not automatically set canComment to False
        >>> # on role change unless specified
        >>> boardMembership.update(role='viewer')
        >>> boardMembership.canComment
        False
        ```

    Args:
        role (BoardRole): Role of the user in the board (default: None)
        canComment (bool): Whether the user can comment on the board (default: None)

    Args: Alternate
        boardMembership (BoardMembership): Board membership instance to update with

    Returns:
        BoardMembership: Updated board membership instance

    Raises:
        ValueError: If the role is invalid (must be 'viewer' or 'editor')

    Note:
        If no arguments are provided, the board membership will update itself with the current values stored in its attributes
    """
    overload = parse_overload(
        args, kwargs, 
        model='boardMembership', 
        options=('role', 'canComment'),
        noarg=self)

    if 'role' in overload:
        if overload['role'] not in self.roles:
            raise ValueError(
                f'Invalid role: {overload["role"]}'
                f'Available roles: {self.roles}')

        if overload['role'] == 'editor': # Editors can always comment
            overload['canComment'] = True

        if overload['role'] == 'viewer': # Viewers can only comment if explicitly set
            overload['canComment'] = overload.get('canComment', False)

    route = self.routes.patch_board_membership(id=self.id)
    self.__init__(**route(**overload)['item'])
    return self