Attachment

Bases: Attachment_

Source code in src/plankapy/interfaces.py

class Attachment(Attachment_):

    @property
    def creator(self) -> User:
        """User that created the attachment"""
        user_route = self.routes.get_user(id=self.creatorUserId)
        return User(**user_route()['item']).bind(self.routes)

    @property
    def card(self) -> Card:
        """Card the attachment belongs to"""
        card_route = self.routes.get_card(id=self.cardId)
        return Card(**card_route()['item']).bind(self.routes)

    def refresh(self):
        """Refreshes the attachment data"""
        for attachment in self.card.attachments:
            if attachment.id == self.id:
                self.__init__(**attachment)

    def data(self) -> bytes:
        """Attachment data as bytes

        Returns:
            Attachment data
        """
        return self.routes.handler._get_file(self.url)

    def download(self, path: Path) -> None:
        """Downloads the attachment to a file

        Args:
            path (Path): Path to the file to save the attachment to
        """
        with open(path, 'wb') as file:
            file.write(self.data())

    def update(self) -> Attachment:
        """Updates the attachment with new values"""
        route = self.routes.patch_attachment(id=self.id)
        self.__init__(**route(**self)['item'])
        return self

    def delete(self) -> Attachment:
        """Deletes the attachment

        Danger:
            This action is irreversible and cannot be undone

        Returns:
            Attachment: Deleted attachment instance
        """
        self.refresh()
        route = self.routes.delete_attachment(id=self.id)
        route()
        return self

card property

Card the attachment belongs to

creator property

User that created the attachment

data()

Attachment data as bytes

Returns:

Type	Description
bytes	Attachment data

Source code in src/plankapy/interfaces.py

def data(self) -> bytes:
    """Attachment data as bytes

    Returns:
        Attachment data
    """
    return self.routes.handler._get_file(self.url)

delete()

Deletes the attachment

Danger

This action is irreversible and cannot be undone

Returns:

Name	Type	Description
Attachment	Attachment	Deleted attachment instance

Source code in src/plankapy/interfaces.py

def delete(self) -> Attachment:
    """Deletes the attachment

    Danger:
        This action is irreversible and cannot be undone

    Returns:
        Attachment: Deleted attachment instance
    """
    self.refresh()
    route = self.routes.delete_attachment(id=self.id)
    route()
    return self

download(path)

Downloads the attachment to a file

Parameters:

Name	Type	Description	Default
path	Path	Path to the file to save the attachment to	required

Source code in src/plankapy/interfaces.py

def download(self, path: Path) -> None:
    """Downloads the attachment to a file

    Args:
        path (Path): Path to the file to save the attachment to
    """
    with open(path, 'wb') as file:
        file.write(self.data())

refresh()

Refreshes the attachment data

Source code in src/plankapy/interfaces.py

def refresh(self):
    """Refreshes the attachment data"""
    for attachment in self.card.attachments:
        if attachment.id == self.id:
            self.__init__(**attachment)

update()

Updates the attachment with new values

Source code in src/plankapy/interfaces.py

def update(self) -> Attachment:
    """Updates the attachment with new values"""
    route = self.routes.patch_attachment(id=self.id)
    self.__init__(**route(**self)['item'])
    return self