Module signals_notebook.entities.image

Expand source code 
import base64 as b64
import logging
from enum import Enum
from typing import ClassVar, Literal

from pydantic import Field

from signals_notebook.common_types import EntityType, File
from signals_notebook.entities import Entity
from signals_notebook.entities.container import Container
from signals_notebook.entities.contentful_entity import ContentfulEntity
from signals_notebook.jinja_env import env

log = logging.getLogger(__name__)


class Image(ContentfulEntity):
    class ContentType(str, Enum):
        TIFF = 'image/tiff'
        PNG = 'image/png'
        JPG = 'image/jpeg'
        GIF = 'image/gif'
        BMP = 'image/bmp'
        SVG = 'image/svg+xml'

    type: Literal[EntityType.IMAGE_RESOURCE] = Field(allow_mutation=False)
    _template_name: ClassVar = 'image.html'

    @classmethod
    def _get_entity_type(cls) -> EntityType:
        return EntityType.IMAGE_RESOURCE

    @classmethod
    def create(
        cls,
        *,
        container: Container,
        name: str,
        content: bytes = b'',
        content_type: str = ContentType.PNG,
        force: bool = True,
    ) -> Entity:
        """Create Image Entity

        Args:
            container: Container where create new Image
            name: file name
            content_type: content type of Image entity
            content: Image content
            force: Force to post attachment

        Returns:
            Image
        """
        cls.ContentType(content_type)
        log.debug('Create entity: %s with name: %s in Container: %s', cls.__name__, name, container.eid)
        return container.add_child(
            name=name,
            content=content,
            content_type=content_type,
            force=force,
        )

    def get_content(self, base64: bool = False) -> File:
        """Get Image content

        Args:
            base64: parameter that allows to encode binary data

        Returns:
            File
        """
        file = super()._get_content()
        if base64:
            file.content = b64.b64encode(file.content)

        return file

    def get_html(self) -> str:
        """Get in HTML format

        Returns:
            Rendered template as a string
        """
        data = {'name': self.name}
        file = self.get_content()
        data['image'] = 'data:{};base64,{}'.format(file.content_type, file.base64.decode('ascii'))

        template = env.get_template(self._template_name)
        log.info('Html template for %s:%s has been rendered.', self.__class__.__name__, self.eid)

        return template.render(data=data)

Classes

class Image (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code 
class Image(ContentfulEntity):
    class ContentType(str, Enum):
        TIFF = 'image/tiff'
        PNG = 'image/png'
        JPG = 'image/jpeg'
        GIF = 'image/gif'
        BMP = 'image/bmp'
        SVG = 'image/svg+xml'

    type: Literal[EntityType.IMAGE_RESOURCE] = Field(allow_mutation=False)
    _template_name: ClassVar = 'image.html'

    @classmethod
    def _get_entity_type(cls) -> EntityType:
        return EntityType.IMAGE_RESOURCE

    @classmethod
    def create(
        cls,
        *,
        container: Container,
        name: str,
        content: bytes = b'',
        content_type: str = ContentType.PNG,
        force: bool = True,
    ) -> Entity:
        """Create Image Entity

        Args:
            container: Container where create new Image
            name: file name
            content_type: content type of Image entity
            content: Image content
            force: Force to post attachment

        Returns:
            Image
        """
        cls.ContentType(content_type)
        log.debug('Create entity: %s with name: %s in Container: %s', cls.__name__, name, container.eid)
        return container.add_child(
            name=name,
            content=content,
            content_type=content_type,
            force=force,
        )

    def get_content(self, base64: bool = False) -> File:
        """Get Image content

        Args:
            base64: parameter that allows to encode binary data

        Returns:
            File
        """
        file = super()._get_content()
        if base64:
            file.content = b64.b64encode(file.content)

        return file

    def get_html(self) -> str:
        """Get in HTML format

        Returns:
            Rendered template as a string
        """
        data = {'name': self.name}
        file = self.get_content()
        data['image'] = 'data:{};base64,{}'.format(file.content_type, file.base64.decode('ascii'))

        template = env.get_template(self._template_name)
        log.info('Html template for %s:%s has been rendered.', self.__class__.__name__, self.eid)

        return template.render(data=data)

Ancestors

Class variables

var type : Literal[]

Static methods

def create(*, container: Container, name: str, content: bytes = b'', content_type: str = ContentType.PNG, force: bool = True) ‑> Entity

Create Image Entity

Args

container
Container where create new Image
name
file name
content_type
content type of Image entity
content
Image content
force
Force to post attachment

Returns

Image

Expand source code 
@classmethod
def create(
    cls,
    *,
    container: Container,
    name: str,
    content: bytes = b'',
    content_type: str = ContentType.PNG,
    force: bool = True,
) -> Entity:
    """Create Image Entity

    Args:
        container: Container where create new Image
        name: file name
        content_type: content type of Image entity
        content: Image content
        force: Force to post attachment

    Returns:
        Image
    """
    cls.ContentType(content_type)
    log.debug('Create entity: %s with name: %s in Container: %s', cls.__name__, name, container.eid)
    return container.add_child(
        name=name,
        content=content,
        content_type=content_type,
        force=force,
    )

Methods

def get_content(self, base64: bool = False) ‑> File

Get Image content

Args

base64
parameter that allows to encode binary data

Returns

File

Expand source code 
def get_content(self, base64: bool = False) -> File:
    """Get Image content

    Args:
        base64: parameter that allows to encode binary data

    Returns:
        File
    """
    file = super()._get_content()
    if base64:
        file.content = b64.b64encode(file.content)

    return file

Inherited members