Information about the AnyBlok / Attachment project.
AnyBlok is hosted on github - the main project page is at https://github.com/AnyBlok/anyblok_attachment. Source code is tracked here using GIT.
Releases and project status are available on Pypi at http://pypi.python.org/pypi/anyblok_attachment.
The most recent published version of this documentation should be at http://doc.anyblok-attachment.anyblok.org.
AnyBlok with attachment is currently in beta status and is expected to be fairly stable. Users should take care to report bugs and missing features on an as-needed basis. It should be expected that the development version may be required for proper implementation of recently repaired issues in between releases;
Install released versions of AnyBlok from the Python package index with pip or a similar tool:
pip install anyblok_attachment
Installation via source distribution is via the setup.py script:
python setup.py install
Installation will add the anyblok commands to the environment.
AnyBlok / Attachment works with Python 3.3 and later. The install process will ensure that AnyBlok is installed, in addition to other dependencies. The latest version of them is strongly recommended.
Jean-Sébastien Suzanne
Bugs and feature enhancements to AnyBlok should be reported on the Issue tracker.
anyblok_attachment.bloks.attachment.AttachmentBlok(registry)Bases: anyblok.blok.Blok
Add attachment in AnyBlok
author = 'Suzanne Jean-Sébastien'conditional_by = []conflicting_by = []import_declaration_module()Do the python import for the Declaration of the model or other
name = 'attachment'optional_by = []reload_declaration_module(reload)required = ['anyblok-core', 'anyblok-mixins']required_by = ['report']version = '1.0.0'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'
You can get:
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
anyblok_attachment.bloks.attachment.attachment.AttachmentBases: object
Name space for the attachment models
AnyBlok registration:
anyblok_attachment.bloks.attachment.document.DocumentBases: object
AnyBlok registration:
| Fields | |
|---|---|
| previous_version |
|
| uuid |
|
| filesize |
|
| created_at |
|
| filename |
|
| contenttype |
|
| type |
|
| data |
|
| file |
|
| historied_at |
|
| previous_versions |
|
| previous_doc_version |
|
| previous_doc_uuid |
|
| version |
|
| hash |
|
| file_added_at |
|
| next_version |
|
anyblok_attachment.bloks.attachment.document.LatestBases: anyblok.model.Document, anyblok.mixin.ForbidDelete
AnyBlok registration:
anyblok.model.Documentanyblok.mixin.ForbidDeleteanyblok_attachment.bloks.attachment.document.HistoryBases: anyblok.model.Document, anyblok.mixin.ReadOnly
AnyBlok registration:
anyblok.model.Documentanyblok.mixin.ReadOnlyanyblok_attachment.bloks.attachment.mixin.LatestDocumentBases: object
AnyBlok registration:
| Fields | |
|---|---|
| latest_document_uuid |
|
| latest_document |
|
anyblok_attachment.bloks.attachment.mixin.VersionedDocumentBases: object
AnyBlok registration:
| Fields | |
|---|---|
| versioned_document_uuid |
|
| versioned_document_version |
|
| versioned_document |
|
anyblok_attachment.bloks.attachment.exceptions.NoFileExceptionDocument has not got file entry
anyblok_attachment.bloks.attachment.exceptions.ProtectedFieldExceptionTry to update protected field
anyblok_attachment.bloks.wkhtml2pdf.WkHtml2PdfBlok(registry)Bases: anyblok.blok.Blok
Add attachment in AnyBlok
author = 'Suzanne Jean-Sébastien'conditional_by = []conflicting_by = []import_declaration_module()Do the python import for the Declaration of the model or other
name = 'wkhtml2pdf'optional_by = []reload_declaration_module(reload)required = ['anyblok-core']required_by = []version = '1.0.0'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()
anyblok_attachment.bloks.wkhtml2pdf.model.WkHtml2PdfBases: object
AnyBlok registration:
| Fields | |
|---|---|
| margin_top |
|
| updated_at |
|
| created_at |
|
| margin_right |
|
| lowquality |
|
| javascript |
|
| local_file_access |
|
| background |
|
| grayscale |
|
| load_media_error_handling |
|
| orientation |
|
| page_offset |
|
| collate |
|
| id |
|
| page |
|
| margin_bottom |
|
| minimu_font_size |
|
| copies |
|
| images |
|
| encoding |
|
| javascript_delay |
|
| load_error_handling |
|
| dpi |
|
| margin_left |
|
| label |
|
cast_html2pdf(prefix, html_content)Cast html document to a pdf document
| Parameters: |
|
|---|---|
| Return type: | bytes |
| Exception: | WkHtml2PdfException |
anyblok_attachment.bloks.wkhtml2pdf.model.PageBases: object
Define the Page size
AnyBlok registration:
| Fields | |
|---|---|
| created_at |
|
| size |
|
| width |
|
| updated_at |
|
| height |
|
| label |
|
anyblok_attachment.bloks.wkhtml2pdf.mixin.WkHtml2PdfBases: object
AnyBlok registration:
| Fields | |
|---|---|
| wkhtml2pdf_configuration |
|
check_if_file_must_be_generated(document)Overwrite to check also if the configuration have changed
anyblok_attachment.bloks.wkhtml2pdf.exceptions.WkHtml2PdfExceptionOnly id the page configuration is wrong
anyblok_attachment.bloks.wkhtml2pdf.exceptions.PageValidityExceptionOnly id the page configuration is wrong
anyblok_attachment.bloks.report.ReportBlok(registry)Bases: anyblok.blok.Blok
Add attachment in AnyBlok
author = 'Suzanne Jean-Sébastien'conditional_by = []conflicting_by = []import_declaration_module()Do the python import for the Declaration of the model or other
name = 'report'optional_by = []reload_declaration_module(reload)required = ['attachment']required_by = ['report-format']version = '1.0.0'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
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 |
anyblok_attachment.bloks.report.parser.Parser(model)Bases: object
Base parser to serialize the data for templating
AnyBlok registration:
check_if_file_must_be_generated(template, document)Return a boolean to know if the file must be generate or not
| Parameters: |
|
|---|---|
| Returns: | bool |
serialize(model, data)Serialize the data to be understanding by template
| Parameters: |
|
|---|---|
| Returns: | json dict |
anyblok_attachment.bloks.report.template.TemplateBases: object
Base Model template to define the main configuration between templating system
AnyBlok registration:
| Fields | |
|---|---|
| created_at |
|
| uuid |
|
| template_path |
|
| updated_at |
|
| parser_from |
|
| filename |
|
| parser_model |
|
| template_from |
|
| model |
|
| type |
|
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
get_parser_from()Give the location of the parser
get_template()return the template file to compute
get_template_from()Give the location of the template
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: |
|
|---|
anyblok_attachment.bloks.report.document.DocumentBases: object
AnyBlok registration:
| Fields | |
|---|---|
| template |
|
anyblok_attachment.bloks.report.document.LatestBases: object
AnyBlok registration:
anyblok_attachment.bloks.report.exceptions.TemplateExceptionSimple exception if miss Template data
anyblok_attachment.bloks.report.exceptions.PathExceptionSimple exception if it is not a valid path for Template
anyblok_attachment.bloks.report.exceptions.RenderExceptionSimple exception for all error in the render method
anyblok_attachment.bloks.format.ReportBlok(registry)Bases: anyblok.blok.Blok
Add attachment in AnyBlok
author = 'Suzanne Jean-Sébastien'conditional_by = []conflicting_by = []import_declaration_module()Do the python import for the Declaration of the model or other
name = 'report-format'optional_by = []reload_declaration_module(reload)required = ['report']required_by = []version = '1.0.0'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(
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'}
}
anyblok_attachment.bloks.format.template.TemplateBases: object
AnyBlok registration:
anyblok_attachment.bloks.format.template.FormatBases: anyblok.model.Template
Simple python format templating
AnyBlok registration:
anyblok.model.Template| Fields | |
|---|---|
| uuid |
|
| contenttype |
|
Contents
Mixin.LatestDocument and Mixin.VersionedDocument
to help the developer to get latest_document or versioned_documentMixin.WkHtml2Pdf check also if the configuration changed for
Template.check_if_file_must_be_generatedMeans each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
Means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor’s Contribution.
Means Covered Software of a particular Contributor.
Means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
Means:
Means any form of the work other than Source Code Form.
Means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
Means this document.
Means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
Means any of the following:
Means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
Means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
Means the form of the work preferred for making modifications.
Means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients’ rights in the Source Code Form.
If You distribute Covered Software in Executable Form then:
You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
Warning
Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.
Warning
Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such party’s negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party’s ability to bring cross-claims or counter-claims.
This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this file,
You can obtain one at http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
Note
You may add additional accurate notices of copyright ownership.
This Source Code Form is “Incompatible With Secondary Licenses”, as defined
by the Mozilla Public License, v. 2.0.