chronulus_core.types.attribute

Image

Bases: BaseModel

Attribute to upload an image from base64 encoded string

The image should be provided as a base64 encoded string and the PIL image type specified

Parameters:

Name	Type	Description	Default
type	str	The PIL image type, e.g., PNG, JPEG, etc.	required
data	str	The base64 encoded image string	required

Attributes:

Name	Type	Description
type	str	The PIL image type, e.g., PNG, JPEG, etc.
data	str	The base64 encoded image string

Source code in src2/chronulus_core/types/attribute.py

class Image(BaseModel):
    """Attribute to upload an image from base64 encoded string

    The image should be provided as a base64 encoded string and the PIL image type specified

    Parameters
    ----------
    type : str
        The PIL image type, e.g., PNG, JPEG, etc.
    data : str
        The base64 encoded image string

    Attributes
    ----------
    type : str
        The PIL image type, e.g., PNG, JPEG, etc.
    data : str
        The base64 encoded image string
    """
    type: str = Field(description='PIL image type')
    data: str = Field(description='base64 encoded image string')

    @staticmethod
    def from_bytes(_bytes: bytes, _type: str):
        data = base64.b64encode(_bytes).decode('utf-8')
        return Image(type=_type, data=data)

    @staticmethod
    def from_file(file_path: str, _type: Union[str, None] = None):
        img = PILImage.open(file_path)

        # Convert to bytes using an in-memory bytes buffer
        buffer = io.BytesIO()
        img.save(buffer, format=img.format)
        image_bytes = buffer.getvalue()
        if _type is None or _type != img.format:
            _type = img.format
        data = base64.b64encode(image_bytes).decode('utf-8')
        return Image(type=_type, data=data)

ImageFromBytes

Bases: BaseModel

Attribute to upload an image from bytes

The image should be provided in raw bytes and the PIL image type specified

Parameters:

Name	Type	Description	Default
image_bytes	bytes	raw bytes of the image	required
type	str	The PIL image type, e.g., PNG, JPEG, etc.	required

Attributes:

Name	Type	Description
image_bytes	bytes	raw bytes of the image
type	str	The PIL image type, e.g., PNG, JPEG, etc.
data	Optional[str]	The base64 encoded image string

Source code in src2/chronulus_core/types/attribute.py

class ImageFromBytes(BaseModel):
    """Attribute to upload an image from bytes

    The image should be provided in raw bytes and the PIL image type specified

    Parameters
    ----------
    image_bytes : bytes
        raw bytes of the image
    type : str
        The PIL image type, e.g., PNG, JPEG, etc.

    Attributes
    ----------
    image_bytes : bytes
        raw bytes of the image
    type : str
        The PIL image type, e.g., PNG, JPEG, etc.
    data : Optional[str]
        The base64 encoded image string

    """
    image_bytes: bytes = Field(exclude=True, description='image bytes')
    type: str = Field(description='PIL image type')
    data: Union[str, None] = Field(default=None, description='base64 encoded image string')

    def model_post_init(self, __context: Any) -> None:
        if self.data is None:
            self.data = base64.b64encode(self.image_bytes).decode('utf-8')

ImageFromFile

Bases: BaseModel

Attribute to upload an image from a local file

The image should be accessible in your local file system by the client

Parameters:

Name	Type	Description	Default
file_path	str	Path to image file, e.g., '/path/to/image.jpg'	required
type	Optional[str]	The PIL image type, e.g., PNG, JPEG, etc.	required

Attributes:

Name	Type	Description
file_path	str	Path to image file, e.g., '/path/to/image.jpg'
type	Optional[str]	The PIL image type, e.g., PNG, JPEG, etc.
data	Optional[str]	The base64 encoded image string

Source code in src2/chronulus_core/types/attribute.py

class ImageFromFile(BaseModel):
    """Attribute to upload an image from a local file

    The image should be accessible in your local file system by the client

    Parameters
    ----------
    file_path : str
        Path to image file, e.g., '/path/to/image.jpg'
    type : Optional[str]
        The PIL image type, e.g., PNG, JPEG, etc.

    Attributes
    ----------
    file_path : str
        Path to image file, e.g., '/path/to/image.jpg'
    type : Optional[str]
        The PIL image type, e.g., PNG, JPEG, etc.
    data : Optional[str]
        The base64 encoded image string

    """
    file_path: str = Field(exclude=True, description='path to the image file')
    type: Union[str, None] = Field(default=None, description='PIL image type')
    data: Union[str, None] = Field(default=None, description='base64 encoded image string')

    def model_post_init(self, __context: Any) -> None:
        if self.data is None:
            # Open the image with PIL
            try:
                img = PILImage.open(self.file_path)

            except FileNotFoundError as e:
                # trying handling case there macOS gives us screenshots with abnormal spacing before AM/PM
                if self.file_path.endswith(" AM.png"):
                    new_file = self.file_path.replace(" AM.png", "\u202fAM.png")
                    img = PILImage.open(new_file)
                    self.file_path = new_file

                elif self.file_path.endswith(" PM.png"):
                    new_file = self.file_path.replace(" PM.png", "\u202fPM.png")
                    img = PILImage.open(new_file)
                    self.file_path = new_file

                else:
                    raise e

            # Convert to bytes using an in-memory bytes buffer
            buffer = io.BytesIO()
            img.save(buffer, format=img.format)
            image_bytes = buffer.getvalue()

            if self.type is None or self.type != img.format:
                self.type = img.format
            self.data = base64.b64encode(image_bytes).decode('utf-8')

        if self.type is None and self.data is not None:
            raise ValueError(f"""Image data was provided without a type""")

ImageFromUrl

Bases: BaseModel

Attribute to fetch an image from a specified remote URL

The remote URL should be publicly accessible otherwise our systems will fail to retrieve it.

Parameters:

Name	Type	Description	Default
url	str	URL of the remote image	required
type	Optional[str]	The PIL image type, e.g., PNG, JPEG, etc.	required

Attributes:

Name	Type	Description
url	str	URL of the remote image
type	Optional[str]	The PIL image type, e.g., PNG, JPEG, etc.

Source code in src2/chronulus_core/types/attribute.py

class ImageFromUrl(BaseModel):
    """Attribute to fetch an image from a specified remote URL

    The remote URL should be publicly accessible otherwise our systems will fail to retrieve it.

    Parameters
    ----------
    url : str
        URL of the remote image
    type : Optional[str]
        The PIL image type, e.g., PNG, JPEG, etc.

    Attributes
    ----------
    url : str
        URL of the remote image
    type : Optional[str]
        The PIL image type, e.g., PNG, JPEG, etc.

    """
    url: str
    type: Union[str, None] = Field(default=None, description='PIL image type')

    def model_post_init(self, __context: Any) -> None:

        if self.type is None:
            mime_type = get_mime_type_from_headers(self.url)
            if mime_type:
                image_type = mime_type.split('/')[-1]
                self.type = image_type
            else:
                raise ValueError(f'No image type could be detected for {self.url}. Please provide the correct type in the `type` argument')

        pillow_format = get_pillow_image_type(self.type)
        if pillow_format is None:
            raise ValueError(
                f"""Image type '{self.type}' was specified but this type is not supported.
                    If this is incorrect, please provide the correct type in the `type` argument.
                """)
        else:
            self.type = pillow_format