Comment

CLASS	DESCRIPTION
Comment	Python interface for Planka Comments

Comment

Comment(schema: Schema, session: Planka)

Bases: PlankaModel[Comment]

Python interface for Planka Comments

Returned by:

• Plankapy v2 models
  • Card  Card
    •  comments
    •  comment
  • Notification  Notification  comment

METHOD	DESCRIPTION
copy	Create a deepcopy of the model and its associated schema.
delete	Delete the Comment
diff	Get a schema diff between two model schemas.
sync	Sync the Comment with the Planka server
update	Update the Comment (must be the comment Creator or an Admin)

ATTRIBUTE	DESCRIPTION
__formatter__	Formatter func that allows overriding str behavior for models TYPE: ModelFormatter[Self]
card	The Card the Comment belongs to TYPE: Card
created_at	When the comment was created TYPE: datetime
text	Content of the Comment TYPE: str
updated_at	When the comment was last updated TYPE: datetime
user	The User who created the Comment 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 Comment belongs to

created_at property

created_at: datetime

When the comment was created

text property

text: str

Content of the Comment

updated_at property

updated_at: datetime

When the comment was last updated

user property

user: User

The User who created the Comment

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 Comment

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

def delete(self):
    """Delete the Comment"""
    return self.endpoints.deleteComment(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 Comment with the Planka server

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

def sync(self):
    """Sync the Comment with the Planka server"""
    _cm = [cm for cm in self.card.comments if cm == self]
    if _cm:
        self.schema = _cm.pop().schema

update

update(**kwargs: Unpack[Request_updateComments])

Update the Comment (must be the comment Creator or an Admin)

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

def update(self, **kwargs: Unpack[paths.Request_updateComments]):
    """Update the Comment (must be the comment Creator or an Admin)"""
    self.endpoints.updateComments(self.id, **kwargs)