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)

Call at update, before the automigration

Warning

You can not use the ORM

Parameters:latest_version – latest version installed, if the blok have not been installing the latest_version will be None
classmethod reload_declaration_module(reload)
required = ['anyblok-core', 'anyblok-mixins']
required_by = ['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  
version_number
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.Integer
  • nullable - False
  • primary_key - True
  • autoincrement - True
file
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.LargeBinary
next_version
  • fget - 'get_next_version'
  • Type - anyblok.field.Function
data
  • default - builtins.dict
  • Type - anyblok.column.Json
created_at
  • Type - anyblok.column.DateTime
  • nullable - False
  • is auto updated - False
  • default timezone - <UTC>
contenttype
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • size - 64
file_added_at
  • default timezone - <UTC>
  • is auto updated - False
  • Type - anyblok.column.DateTime
previous_doc_uuid
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.UUID
  • binary - None
  • native - None
filesize
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.Integer
type
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.Selection
  • nullable - False
  • size - 64
previous_doc_version_number
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.Integer
version
  • fget - 'get_version'
  • Type - anyblok.field.Function
hash
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • size - 256
previous_versions
  • fget - 'get_previous_versions'
  • Type - anyblok.field.Function
previous_version
  • fget - 'get_previous_version'
  • Type - anyblok.field.Function
uuid
  • default - anyblok.column.NoDefaultValue
  • binary - False
  • primary_key - True
  • nullable - False
  • Type - anyblok.column.UUID
  • native - None
filename
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • size - 256
historied_at
  • default timezone - <UTC>
  • is auto updated - False
  • Type - anyblok.column.DateTime
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
  • Type - anyblok.field.Function
  • fget - 'get_latest_document'
  • fset - 'set_latest_document'
  • fdel - 'del_latest_document'
latest_document_uuid
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.UUID
  • binary - None
  • native - None
class anyblok_attachment.bloks.attachment.mixin.VersionedDocument

Bases: object

AnyBlok registration:

  • Type: Mixin
  • Registry name: Mixin.VersionedDocument
Fields  
versioned_document
  • Type - anyblok.field.Function
  • fget - 'get_versioned_document'
  • fset - 'set_versioned_document'
  • fdel - 'del_versioned_document'
versioned_document_version_number
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.Integer
versioned_document_uuid
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.UUID
  • binary - None
  • native - None

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

Mixins

class anyblok_attachment.bloks.wkhtml2pdf.mixin.WkHtml2Pdf

Bases: object

AnyBlok registration:

  • Type: Mixin
  • Registry name: Mixin.WkHtml2Pdf
Fields  
wkhtml2pdf_configuration
  • model - Model.Attachment.WkHtml2Pdf
  • Type - anyblok.relationship.Many2One
  • 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  
template_from
  • default - 'path'
  • selections - 'get_template_from'
  • Type - anyblok.column.Selection
  • nullable - False
  • size - 64
updated_at
  • Type - anyblok.column.DateTime
  • nullable - False
  • is auto updated - True
  • default timezone - <UTC>
type
  • default - anyblok.column.NoDefaultValue
  • selections - 'get_template_type'
  • Type - anyblok.column.Selection
  • nullable - False
  • size - 64
model
  • default - anyblok.column.NoDefaultValue
  • foreign_key - Model.System.Model => name
  • Type - anyblok.column.String
  • nullable - False
  • size - 64
template_path
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • size - 64
name
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • nullable - False
  • size - 64
uuid
  • default - <function uuid1 at 0x7fc1a7231400>
  • binary - False
  • primary_key - True
  • nullable - False
  • Type - anyblok.column.UUID
  • native - None
created_at
  • Type - anyblok.column.DateTime
  • nullable - False
  • is auto updated - False
  • default timezone - <UTC>
filename
  • default - '{doc.uuid}-{doc.version}-{date}'
  • Type - anyblok.column.String
  • nullable - False
  • size - 64
parser_model
  • default - 'Model.Attachment.Parser'
  • Type - anyblok.column.String
  • size - 64
parser_from
  • default - 'model'
  • selections - 'get_parser_from'
  • Type - anyblok.column.Selection
  • nullable - False
  • 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
  • model - Model.Attachment.Template
  • Type - anyblok.relationship.Many2One
  • 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
  • default - anyblok.column.NoDefaultValue
  • foreign_key - Model.Attachment.Template => uuid
  • binary - False
  • primary_key - True
  • nullable - False
  • Type - anyblok.column.UUID
  • native - None
contenttype
  • default - anyblok.column.NoDefaultValue
  • Type - anyblok.column.String
  • nullable - False
  • size - 64