Project Manager

CLASS	DESCRIPTION
ProjectManager	Python interface for Planka ProjectManagers

ProjectManager

ProjectManager(schema: Schema, session: Planka)

Bases: PlankaModel[ProjectManager]

Python interface for Planka ProjectManagers

Returned by:

• Plankapy v2 models Project  Project
  •  project_managers
  •  add_project_manager

Used by:

• Plankapy v2 models Project  Project  remove_project_manager

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

ATTRIBUTE	DESCRIPTION
__formatter__	Formatter func that allows overriding str behavior for models TYPE: ModelFormatter[Self]
created_at	When the ProjectManager was created TYPE: datetime
project	The Project associated with the ProjectManager TYPE: Project
updated_at	When the ProjectManager was last updated TYPE: datetime
user	The User assigned as ProjectManager (Raises LookupError if the User cannot be found) 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

created_at property

created_at: datetime

When the ProjectManager was created

project property

project: Project

The Project associated with the ProjectManager

updated_at property

updated_at: datetime

When the ProjectManager was last updated

user property

user: User

The User assigned as ProjectManager (Raises LookupError if the User cannot be found)

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)

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 ProjectManager with the Planka server

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

def sync(self):
    """Sync the ProjectManager with the Planka server"""
    pms = self.project.project_managers
    for pm in pms:
        if pm.id == self.id:
            self.schema = pm.schema