Module cloudofficeprint.config.output

Classes

class OutputConfig (filetype: str = None, encoding: str = 'raw', converter: str = 'libreoffice', cloud_access_token: CloudAccessToken = None, server_directory: str = None, pdf_options: PDFOptions = None)

Class to specify output configuration for a request.

This configuration is general and for the entire list of output files.

Args

filetype : str, optional

The file type (as extension) to use for the output. Defaults to None (set to template-type in printjob.py).

encoding : str, optional

Encoding of output file. Either "raw" or "base64". Defaults to "raw".

converter : str, optional

The pdf converter to use. Can be "libreoffice", "officetopdf" or any custom defined converter. Custom converters are configurated in the Cloud Office Print server's aop_config.json file. Defaults to "libreoffice".

cloud_access_token : CloudAccessToken, optional

Access token used to access various cloud services for output storage. Defaults to None.

server_directory : str, optional

Base directory to save output files into. Can only be used if the server allows to save on disk. The specific output path for each file is appended to the base path. Defaults to None.

pdf_options : PDFOptions, optional

Optional PDF options. Defaults to None.

Expand source code

class OutputConfig:
    """Class to specify output configuration for a request.

    This configuration is general and for the entire list of output files.
    """

    def __init__(self,
                 filetype: str = None,
                 encoding: str = "raw",
                 converter: str = "libreoffice",
                 cloud_access_token: CloudAccessToken = None,
                 server_directory: str = None,
                 pdf_options: PDFOptions = None):
        """
        Args:
            filetype (str, optional): The file type (as extension) to use for the output. Defaults to None (set to template-type in printjob.py).
            encoding (str, optional): Encoding of output file. Either "raw" or "base64". Defaults to "raw".
            converter (str, optional): The pdf converter to use. Can be "libreoffice", "officetopdf" or any custom defined converter. Custom converters are configurated in the Cloud Office Print server's `aop_config.json` file. Defaults to "libreoffice".
            cloud_access_token (CloudAccessToken, optional): Access token used to access various cloud services for output storage. Defaults to None.
            server_directory (str, optional): Base directory to save output files into. Can only be used if the server allows to save on disk. The specific output path for each file is appended to the base path. Defaults to None.
            pdf_options (PDFOptions, optional): Optional PDF options. Defaults to None.
        """
        self.filetype: str = filetype
        self.converter: str = converter
        self.cloud_access_token: CloudAccessToken = cloud_access_token
        self.server_directory: str = server_directory
        self.pdf_options: PDFOptions = pdf_options
        self.encoding = encoding

    @property
    def json(self) -> str:
        """The JSON representation of this output config.

        This is the JSON serialization of the dict representation.

        Returns:
            str: JSON representation of this output config
        """
        return json.dumps(self.as_dict)

    @property
    def as_dict(self) -> Dict:
        """The dict representation of this output config.

        Returns:
            Dict: the dict representation of this output config
        """
        result = {
            "output_encoding": self._encoding,
            "output_converter": self.converter,
        }

        if self.filetype is not None:
            result['output_type'] = self.filetype
        if self.cloud_access_token is not None:
            result.update(self.cloud_access_token.as_dict)
        if self.server_directory is not None:
            result["output_directory"] = self.server_directory
        if self.pdf_options is not None:
            result.update(self.pdf_options.as_dict)

        return result

    @property
    def encoding(self) -> str:
        """The encoding to use, either "raw" or "base64".

        Returns:
            str: the encoding to use, either "raw" or "base64"
        """
        return self._encoding

    @encoding.setter
    def encoding(self, value: str):
        """Setter for the encoding to use

        Args:
            value (str): encoding to use

        Raises:
            ValueError: raise an error when the given encoding is not supported
        """
        if not (value == "raw" or value == "base64"):
            raise ValueError(
                f'Encoding must be either "raw" or "base64", was "{value}".')
        self._encoding = value

Instance variables

var as_dict : Dict

The dict representation of this output config.

Returns

Dict

the dict representation of this output config

Expand source code

@property
def as_dict(self) -> Dict:
    """The dict representation of this output config.

    Returns:
        Dict: the dict representation of this output config
    """
    result = {
        "output_encoding": self._encoding,
        "output_converter": self.converter,
    }

    if self.filetype is not None:
        result['output_type'] = self.filetype
    if self.cloud_access_token is not None:
        result.update(self.cloud_access_token.as_dict)
    if self.server_directory is not None:
        result["output_directory"] = self.server_directory
    if self.pdf_options is not None:
        result.update(self.pdf_options.as_dict)

    return result

var encoding : str

The encoding to use, either "raw" or "base64".

Returns

str

the encoding to use, either "raw" or "base64"

Expand source code

@property
def encoding(self) -> str:
    """The encoding to use, either "raw" or "base64".

    Returns:
        str: the encoding to use, either "raw" or "base64"
    """
    return self._encoding

var json : str

The JSON representation of this output config.

This is the JSON serialization of the dict representation.

Returns

str

JSON representation of this output config

Expand source code

@property
def json(self) -> str:
    """The JSON representation of this output config.

    This is the JSON serialization of the dict representation.

    Returns:
        str: JSON representation of this output config
    """
    return json.dumps(self.as_dict)