Contents

Bloks ¶

Blok attachment¶

class anyblok_attachment.bloks.attachment.AttachmentBlok(registry)

Bases: anyblok.blok.Blok

Add attachment in AnyBlok

author = 'Suzanne Jean-Sébastien'

conditional_by = []

conflicting_by = []

classmethod import_declaration_module(): Do the python import for the Declaration of the model or other

name = 'attachment'

optional_by = []

pre_migration(latest_version)

Called on update, before the auto migration

Warning

You can not use the ORM

Parameters:	latest_version – latest version installed, if the blok has never been installed, latest_version is None

classmethod reload_declaration_module(reload)

required = ['anyblok-core', 'anyblok-mixins']

required_by = ['attachment-postgres', 'report']

version = '2.0.0'

Memento ¶

This blok Store documents in a table. The documents are historized each modification are saved. It is easy to get the latest or un historized version of one Document.

All document:

registry.Attachment.Document.query().all()

Only the latest:

registry.Attachment.Document.Latest.query().all()

Only the historized:

registry.Attachment.Document.History.query().all()

Note

If one entry changed and a file is available then a historied version will be autmaticly created.

The historized version get the latest version of the document and a new version is added to the document

The document historize the version:

doc = registry.Attachment.Document.insert(...)
assert doc.type == 'latest'
assert doc.previous_version is None

doc.data = {'other': 'data'}
assert doc.previous_version is not None
assert doc.previous_version.type == 'historized'

API doc ¶

Attachment¶

class anyblok_attachment.bloks.attachment.attachment.Attachment

Bases: object

Name space for the attachment models

AnyBlok registration:

Type: Model
Registry name: Model.Attachment
Tablename: attachment

Documments¶

class anyblok_attachment.bloks.attachment.document.Document

Bases: object

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Document
Tablename: attachment_document

Fields
uuid	`Type` - `anyblok.column.UUID` `primary_key` - `True` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `binary` - `False` `native` - `None`
version_number	`Type` - `anyblok.column.Integer` `primary_key` - `True` `nullable` - `False` `autoincrement` - `True` `default` - `anyblok.column.NoDefaultValue`
version	`Type` - `anyblok.field.Function` `fget` - `'get_version'`
created_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `False` `default timezone` - `<UTC>`
historied_at	`Type` - `anyblok.column.DateTime` `is auto updated` - `False` `default timezone` - `<UTC>`
data	`Type` - `anyblok.column.Json` `default` - `builtins.dict`
file_added_at	`Type` - `anyblok.column.DateTime` `is auto updated` - `False` `default timezone` - `<UTC>`
filename	`Type` - `anyblok.column.String` `default` - `anyblok.column.NoDefaultValue` `size` - `256`
contenttype	`Type` - `anyblok.column.String` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
filesize	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
file	`Type` - `anyblok.column.LargeBinary` `default` - `anyblok.column.NoDefaultValue`
hash	`Type` - `anyblok.column.String` `default` - `anyblok.column.NoDefaultValue` `size` - `256`
type	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
previous_doc_uuid	`Type` - `anyblok.column.UUID` `default` - `anyblok.column.NoDefaultValue` `binary` - `None` `native` - `None`
previous_doc_version_number	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
previous_version	`Type` - `anyblok.field.Function` `fget` - `'get_previous_version'`
next_version	`Type` - `anyblok.field.Function` `fget` - `'get_next_version'`
previous_versions	`Type` - `anyblok.field.Function` `fget` - `'get_previous_versions'`

class anyblok_attachment.bloks.attachment.document.Latest

Bases: anyblok.model.Document, anyblok.mixin.ForbidDelete

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Document.Latest
Tablename: attachment_document
Inherited Models or Mixins:
- anyblok.model.Document
- anyblok.mixin.ForbidDelete

class anyblok_attachment.bloks.attachment.document.History

Bases: anyblok.model.Document, anyblok.mixin.ReadOnly

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Document.History
Tablename: attachment_document
Inherited Models or Mixins:
- anyblok.model.Document
- anyblok.mixin.ReadOnly

Mixins¶

class anyblok_attachment.bloks.attachment.mixin.LatestDocument

Bases: object

AnyBlok registration:

Type: Mixin
Registry name: Mixin.LatestDocument

Fields
latest_document_uuid	`Type` - `anyblok.column.UUID` `default` - `anyblok.column.NoDefaultValue` `binary` - `None` `native` - `None`
latest_document	`Type` - `anyblok.field.Function` `fget` - `'get_latest_document'` `fset` - `'set_latest_document'` `fdel` - `'del_latest_document'`

class anyblok_attachment.bloks.attachment.mixin.VersionedDocument

Bases: object

AnyBlok registration:

Type: Mixin
Registry name: Mixin.VersionedDocument

Fields
versioned_document_uuid	`Type` - `anyblok.column.UUID` `default` - `anyblok.column.NoDefaultValue` `binary` - `None` `native` - `None`
versioned_document_version_number	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
versioned_document	`Type` - `anyblok.field.Function` `fget` - `'get_versioned_document'` `fset` - `'set_versioned_document'` `fdel` - `'del_versioned_document'`

Exceptions¶

exception anyblok_attachment.bloks.attachment.exceptions.NoFileException: Document has not got file entry

exception anyblok_attachment.bloks.attachment.exceptions.ProtectedFieldException: Try to update protected field

Blok wkhtml2pdf¶

class anyblok_attachment.bloks.wkhtml2pdf.WkHtml2PdfBlok(registry)

Bases: anyblok.blok.Blok

Add attachment in AnyBlok

author = 'Suzanne Jean-Sébastien'

conditional_by = []

conflicting_by = []

classmethod import_declaration_module(): Do the python import for the Declaration of the model or other

name = 'wkhtml2pdf'

optional_by = []

classmethod reload_declaration_module(reload)

required = ['anyblok-core']

required_by = []

version = '1.0.0'

Memento ¶

Define tools to convert HTML to PDF with wkhtmltopdf.

To use WkHtml2Pdf in your template is easy:

@register(Model.Attachment.Template)
class MyTemplate(Mixin.WkHtml2Pdf):
    ... # template configuration

    def render(self, data):
        html_content = ...
        return self.wkhtml2pdf(html_content)

You may define one or more configuration:

page_A4 = registry.Attachment.WkHtml2Pdf.Page.insert(
    label="A4", size="A4")
page_postal_label = registry.Attachment.WkHtml2Pdf.Page.insert(
    label="Postal carrier 1", height=80, width=120)
wkhtml2pdf = registry.Attachment.WkHtml2Pdf.insert(
    label="A4", page=page_A4, margin_top=20)
template = registry.Attachment.Template.insert(
    ...,
    wkhtml2pdf_configuration=wkhtml2pdf
)
doc = registry.Attachment.Document.insert(
    template=template, data=...)
doc.get_file()

API doc ¶

Models¶

class anyblok_attachment.bloks.wkhtml2pdf.model.WkHtml2Pdf

Bases: object

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.WkHtml2Pdf
Tablename: attachment_wkhtml2pdf

Fields
id	`Type` - `anyblok.column.Integer` `primary_key` - `True` `nullable` - `False` `autoincrement` - `True` `default` - `anyblok.column.NoDefaultValue`
label	`Type` - `anyblok.column.String` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
created_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `False` `default timezone` - `<UTC>`
updated_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `True` `default timezone` - `<UTC>`
copies	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `1`
grayscale	`Type` - `anyblok.column.Boolean` `default` - `False`
lowquality	`Type` - `anyblok.column.Boolean` `default` - `False`
dpi	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
page_offset	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `0`
minimum_font_size	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
margin_bottom	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `10`
margin_left	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `10`
margin_right	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `10`
margin_top	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `10`
orientation	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `'Portrait'` `size` - `64`
page	`Type` - `anyblok.relationship.Many2One` `model` - Model.Attachment.WkHtml2Pdf.Page `index` - `False`
background	`Type` - `anyblok.column.Boolean` `default` - `True`
collate	`Type` - `anyblok.column.Boolean` `default` - `True`
encoding	`Type` - `anyblok.column.String` `nullable` - `False` `default` - `'utf-8'` `size` - `64`
images	`Type` - `anyblok.column.Boolean` `default` - `True`
javascript	`Type` - `anyblok.column.Boolean` `default` - `True`
local_file_access	`Type` - `anyblok.column.Boolean` `default` - `True`
javascript_delay	`Type` - `anyblok.column.Integer` `nullable` - `False` `default` - `200`
load_error_handling	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `'abort'` `selections` - `'get_error_handling'` `size` - `64`
load_media_error_handling	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `'abort'` `selections` - `'get_error_handling'` `size` - `64`

cast_html2pdf(prefix, html_content)

Cast html document to a pdf document

Parameters:	prefix – prefix use for the tempory document html_content – html file (bytes)
Return type:	bytes
Exception:	WkHtml2PdfException

class anyblok_attachment.bloks.wkhtml2pdf.model.Page

Bases: object

Define the Page size

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.WkHtml2Pdf.Page
Tablename: attachment_wkhtml2pdf_page

Fields
label	`Type` - `anyblok.column.String` `primary_key` - `True` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
created_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `False` `default timezone` - `<UTC>`
updated_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `True` `default timezone` - `<UTC>`
size	`Type` - `anyblok.column.String` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
height	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`
width	`Type` - `anyblok.column.Integer` `default` - `anyblok.column.NoDefaultValue`

Mixins¶

class anyblok_attachment.bloks.wkhtml2pdf.mixin.WkHtml2Pdf

Bases: object

AnyBlok registration:

Type: Mixin
Registry name: Mixin.WkHtml2Pdf

Fields
wkhtml2pdf_configuration	`Type` - `anyblok.relationship.Many2One` `model` - Model.Attachment.WkHtml2Pdf `index` - `False`

check_if_file_must_be_generated(document): Overwrite to check also if the configuration have changed

Exceptions¶

exception anyblok_attachment.bloks.wkhtml2pdf.exceptions.WkHtml2PdfException: Only id the page configuration is wrong

exception anyblok_attachment.bloks.wkhtml2pdf.exceptions.PageValidityException: Only id the page configuration is wrong

Blok report¶

class anyblok_attachment.bloks.report.ReportBlok(registry)

Bases: anyblok.blok.Blok

Add attachment in AnyBlok

author = 'Suzanne Jean-Sébastien'

conditional_by = []

conflicting_by = []

classmethod import_declaration_module(): Do the python import for the Declaration of the model or other

name = 'report'

optional_by = []

classmethod reload_declaration_module(reload)

required = ['attachment']

required_by = ['report-format']

version = '1.0.0'

Memento ¶

The main goal is to create document in function of template

Add a new template:

template = registry.Attachment.Template.insert(...)

Add a Document without file but with a Template:

document = registry.Attachment.Document.insert(template=template, ...)
document.generate_file()

Warning

the get_file method may re-create the document with historization if the data have been changed

`Model.Attachment.Parser`¶

It is an unSQL model, the goal is to transform the data from Model.Attachment.Document to Json format to create the file:

@register(Model.Attachment.Parser)
class MyParser(Model.Attachment.Parser):

    @classmethod
    def serialize(cls, data):
        # return serialize data

    @classmethod
    def check_if_file_must_be_generated(cls, template, document):
        # return a Boolean to know if the file must be regenerate

`Model.Attachment.Template`¶

The template describe how to generate the document file in function of of the data in the document.

The Model.Attachment.Template can be used directly an Template type class must be add with polymorphism:

@register(Model.Attachment)
class Template:

    def get_template_type(self):
        res = super(MyTemplateType, self).get_template_type()
        res.update({'MyTemplateType': 'My type label'})
        return res


@register(Model.Attachment.Template)
class MyTemplateType(Model.Attachment.Template):
    TYPE = 'MyTypeOfTemplate'

    uuid = UUID(primary_key=True, nullable=False, binary=False,
                foreign_key=Model.Attachment.Template.use('uuid').options(ondelete='cascade'))
    # other field need for the template

    def render(self):
        # generate a file
        return file

or on the same table:

@register(Model.Attachment)
class Template:

    def get_template_type(self):
        res = super(MyTemplateType, self).get_template_type()
        res.update({'MyTemplateType': 'My type label'})
        return res


@register(Model.Attachment.Template,
          tablename=Model.Attachment.Template)
class MyTemplateType(Model.Attachment.Template):
    TYPE = 'MyTypeOfTemplate'

    def render(self):
        # generate a file
        return file

API doc ¶

Common¶

anyblok_attachment.bloks.report.common.format_path(path)

Return the absolute path in function of the blok

Parameters:	path – the path to format
Returns:	the absolute path
Exception:	PathException

Parser¶

class anyblok_attachment.bloks.report.parser.Parser(model)

Bases: object

Base parser to serialize the data for templating

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Parser
Tablename: attachment_parser

classmethod check_if_file_must_be_generated(template, document)

Return a boolean to know if the file must be generate or not

Parameters:	template – template intance document – latest document instance
Returns:	bool

classmethod serialize(model, data)

Serialize the data to be understanding by template

Parameters:	model – an anyblok model need to serialize data – json dict
Returns:	json dict

Template¶

class anyblok_attachment.bloks.report.template.Template

Bases: object

Base Model template to define the main configuration between templating system

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Template
Tablename: attachment_template

Fields
uuid	`Type` - `anyblok.column.UUID` `primary_key` - `True` `nullable` - `False` `default` - `<function uuid1 at 0x7fb6a5b019e0>` `binary` - `False` `native` - `None`
name	`Type` - `anyblok.column.String` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
created_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `False` `default timezone` - `<UTC>`
updated_at	`Type` - `anyblok.column.DateTime` `nullable` - `False` `is auto updated` - `True` `default timezone` - `<UTC>`
model	`Type` - `anyblok.column.String` `nullable` - `False` `foreign_key` - `Model.System.Model => name` `default` - `anyblok.column.NoDefaultValue` `size` - `256`
filename	`Type` - `anyblok.column.String` `nullable` - `False` `default` - `'{doc.uuid}-{doc.version}-{date}'` `size` - `64`
type	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `selections` - `'get_template_type'` `size` - `64`
template_from	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `'path'` `selections` - `'get_template_from'` `size` - `64`
template_path	`Type` - `anyblok.column.String` `default` - `anyblok.column.NoDefaultValue` `size` - `64`
parser_from	`Type` - `anyblok.column.Selection` `nullable` - `False` `default` - `'model'` `selections` - `'get_parser_from'` `size` - `64`
parser_model	`Type` - `anyblok.column.String` `default` - `'Model.Attachment.Parser'` `size` - `64`

check_if_file_must_be_generated(document)

Return True if the file must generate

Parameters:	document – attachment document instance
Return type:	bool

create_file_for(document)

Create a file and add it in the attachment document

Parameters:	document – attachment document instance

get_parser(): return the template file to compute

classmethod get_parser_from(): Give the location of the parser

get_template(): return the template file to compute

classmethod get_template_from(): Give the location of the template

classmethod get_template_type(): Give the tempate type

render(data)

Return the file create by the templating engine

Parameters:	data – the serialized data

update_document(document, file_, data)

Update the document to fill file and content

Parameters:	document – attachment document instance file – bytes file data – serialized data

Document¶

class anyblok_attachment.bloks.report.document.Document

Bases: object

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Document
Tablename: attachment_document

Fields
template	`Type` - `anyblok.relationship.Many2One` `model` - Model.Attachment.Template `index` - `False`

class anyblok_attachment.bloks.report.document.Latest

Bases: object

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Document.Latest
Tablename: attachment_document

Exceptions¶

exception anyblok_attachment.bloks.report.exceptions.TemplateException: Simple exception if miss Template data

exception anyblok_attachment.bloks.report.exceptions.PathException: Simple exception if it is not a valid path for Template

exception anyblok_attachment.bloks.report.exceptions.RenderException: Simple exception for all error in the render method

Blok report-format¶

class anyblok_attachment.bloks.format.ReportBlok(registry)

Bases: anyblok.blok.Blok

Add attachment in AnyBlok

author = 'Suzanne Jean-Sébastien'

conditional_by = []

conflicting_by = []

classmethod import_declaration_module(): Do the python import for the Declaration of the model or other

name = 'report-format'

optional_by = []

classmethod reload_declaration_module(reload)

required = ['report']

required_by = []

version = '1.0.0'

Memento ¶

Simple python templating formatage

template file exemple:

<!doctype html>
<html>
    <head>
        <title>{title}</title>
    </head>
    <body>
        {description}
    </body>
</html>

add the documment and create file:

template = registry.Attachment.Template.Format.insert(
    name="template_name"
    template_path='path/of/the/python.template',
    contenttype='text/html',
    filename='mypage.html')
document = registry.Attachment.Document.insert(
    template=template,
    data={'title': 'My page', 'description': 'Hello world !!'}
)
document.get_file()

>>>:

{
    'contenttype': 'text/html',
    'file': b'<!doctype html>\n<html>\n    <head>\n        <title>My page</title>'
            b'\n    </head>\n    <body>\n        Hello world !!\n    </body>\n<'
            b'/html>\n',
    'file_added_at': datetime.datetime(2018, 1, 4, 9, 22, 56, 922346, tzinfo=<DstTzInfo 'CET' CET+1:00:00 STD>),
    'filename': 'mypage.html',
    'filesize': 131,
    'hash': b'\xf0\xe2?\xebk\xb4\x15\x0f\xb2\x9cT\x08\xee#\x02\xe2\xbe\xa16\x8d'
            b'\xc8\xcda\x91;\xba2\x9c\x9dUF\x10'}

}

API doc ¶

Template¶

class anyblok_attachment.bloks.format.template.Template

Bases: object

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Template
Tablename: attachment_template

Format¶

class anyblok_attachment.bloks.format.template.Format

Bases: anyblok.model.Template

Simple python format templating

AnyBlok registration:

Type: Model
Registry name: Model.Attachment.Template.Format
Tablename: attachment_template_format
Inherited Models or Mixins:
- anyblok.model.Template

Fields
uuid	`Type` - `anyblok.column.UUID` `primary_key` - `True` `nullable` - `False` `foreign_key` - `Model.Attachment.Template => uuid` `default` - `anyblok.column.NoDefaultValue` `binary` - `False` `native` - `None`
contenttype	`Type` - `anyblok.column.String` `nullable` - `False` `default` - `anyblok.column.NoDefaultValue` `size` - `64`