Task

CLASS	DESCRIPTION
Task	Python interface for Planka Tasks

Task

Task(schema: Schema, session: Planka)

Bases: PlankaModel[Task]

Python interface for Planka Tasks

Returned by:

• Plankapy v2 models
  • Board  Board  tasks
  • Card  Card  tasks
  • List  List  tasks
  • Task List  TaskList
    •  tasks
    •  add_task

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

ATTRIBUTE	DESCRIPTION
__formatter__	Formatter func that allows overriding str behavior for models TYPE: ModelFormatter[Self]
assignee	The User assigned to the Task if there is one TYPE: User | None
card	The Card the Task is linked to TYPE: Card
created_at	When the Task was created TYPE: datetime
is_completed	Whether the Task is completed TYPE: bool
name	Name/title of the Task TYPE: str
position	Position of the Task within the TaskList TYPE: int
task_list	The TaskList the Task belongs to TYPE: TaskList
updated_at	When the Task was last updated TYPE: datetime

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

assignee property writable

assignee: User | None

The User assigned to the Task if there is one

card property

card: Card

The Card the Task is linked to

created_at property

created_at: datetime

When the Task was created

is_completed property writable

is_completed: bool

Whether the Task is completed

name property writable

name: str

Name/title of the Task

position property writable

position: int

Position of the Task within the TaskList

task_list property writable

task_list: TaskList

The TaskList the Task belongs to

updated_at property

updated_at: datetime

When the Task was last updated

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 Task

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

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

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

def sync(self):
    """Sync the Task with the Planka server"""
    _tsks = [tsk for tsk in self.task_list.tasks if tsk == self]
    if _tsks:
        self.schema = _tsks.pop().schema

update

update(**kwargs: Unpack[Request_updateTask])

Update the Task

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

def update(self, **kwargs: Unpack[paths.Request_updateTask]):
    """Update the Task"""
    self.schema = self.endpoints.updateTask(self.id, **kwargs)['item']