Skip to content

Custom Field

CLASS DESCRIPTION
CustomField

Python interface for Planka CustomFields

CustomField 

CustomField(schema: Schema, session: Planka)

Bases: PlankaModel[CustomField]

Python interface for Planka CustomFields

Returned by: Used by:
METHOD DESCRIPTION
copy

Create a deepcopy of the model and its associated schema.
delete

Delete the CustomField
diff

Get a schema diff between two model schemas.
sync

Sync the CustomField with the Planka server
update

Update the CustomField
ATTRIBUTE DESCRIPTION
__formatter__

Formatter func that allows overriding str behavior for models

TYPE: ModelFormatter[Self]

base_custom_field_group

The BaseCustomFieldGroup the custom field belongs to

TYPE: BaseCustomFieldGroup

created_at

When the custom field was created

TYPE: datetime

custom_field_group

The CustomFieldGroup the CustomField belongs to

TYPE: CustomFieldGroup

name

Name/title of the custom field

TYPE: str

position

Position of the CustomField within the CustomFieldGroup

TYPE: int

show_on_front_of_card

Whether to show the CustomField on the front of Cards

TYPE: bool

updated_at

When the custom field was last updated

TYPE: datetime

Source code in src/plankapy/v2/models/_base.py 
30
31
32
33
34
35
36
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

base_custom_field_group property 

base_custom_field_group: BaseCustomFieldGroup

The BaseCustomFieldGroup the custom field belongs to

created_at property 

created_at: datetime

When the custom field was created

custom_field_group property 

custom_field_group: CustomFieldGroup

The CustomFieldGroup the CustomField belongs to

name property writable 

name: str

Name/title of the custom field

position property writable 

position: int

Position of the CustomField within the CustomFieldGroup

show_on_front_of_card property writable 

show_on_front_of_card: bool

Whether to show the CustomField on the front of Cards

updated_at property 

updated_at: datetime

When the custom field 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 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
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 CustomField

Source code in src/plankapy/v2/models/custom_field.py 
79
80
81
def delete(self):
    """Delete the CustomField"""
    self.endpoints.deleteCustomField(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 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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 CustomField with the Planka server

Source code in src/plankapy/v2/models/custom_field.py 
72
73
def sync(self):
    """Sync the CustomField with the Planka server"""

update 

update(**kwargs: Unpack[Request_updateCustomField])

Update the CustomField

Source code in src/plankapy/v2/models/custom_field.py 
75
76
77
def update(self, **kwargs: Unpack[paths.Request_updateCustomField]):
    """Update the CustomField"""
    self.schema = self.endpoints.updateCustomField(self.id, **kwargs)['item']