PROJEKT doc_utils

Modul doc_utils.

Třídy

class DocumentCreator

Implementuje komponentu DocumentCreator v rámci aplikace.

Metody:

__init__()

Inicializuje instanci třídy.

Parametry:

• oznamovatel – Uživatel nebo osoba oznamovatel, v jejímž kontextu se operace provádí.

• projekt – Parametr projekt slouží jako vstup pro logiku funkce __init__.

• fedora_transaction – Parametr fedora_transaction slouží jako vstup pro logiku funkce __init__.

• additional – Kolekce nebo datová struktura additional zpracovávaná touto funkcí.

format_date()

Provádí operaci format date.

Parametry:

date_obj – Časový údaj date_obj použitý při filtrování nebo výpočtu.

Zpracovaná hodnota po validaci nebo transformaci.

Vrací:

Vrací hodnotu typu str; podle větve může jít o: str, výsledek volání strftime().

_create_style_dict()

Vytvoří style dict.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_header_oznamovatel()

Vytvoří header oznamovatel.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_header_oznamovatel_doc()

Vytvoří header oznamovatel doc.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_header_tab_dates()

Vytvoří header tab dates.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_header_tab_dates_doc()

Vytvoří header tab dates doc.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_data_document_part()

Vytvoří data document part.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_signature()

Vytvoří signature.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_create_signature_doc()

Vytvoří signature doc.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

_initiate_document()

Provádí operaci initiate document.

Vrací:

Výstup funkce odpovídající implementované logice.

_generate_repository_file()

Vygeneruje repository file.

Parametry:

• my_doc – Číselná hodnota my_doc použitá při výpočtu nebo transformaci.

• document_content – Textový nebo strukturální vstup document_content používaný při sestavení nebo zpracování obsahu.

• pdf_buffer – Číselná hodnota pdf_buffer použitá při výpočtu nebo transformaci.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

body_style()

Provádí operaci body style.

Vrací:

Vrací vybranou hodnotu z kolekce.

_generate_text()

Vygeneruje text.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

build_document()

Sestaví document. v aplikaci.

class OznameniPDFCreator

Implementuje komponentu OznameniPDFCreator v rámci aplikace.

Metody:

_generate_text()

Vygeneruje text.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

build_document()

Sestaví document. v aplikaci.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

class ZruseniPDFCreator

Implementuje komponentu ZruseniPDFCreator v rámci aplikace.

Metody:

_generate_text()

Vygeneruje text.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

build_document()

Sestaví document. v aplikaci.

Vrací:

Nově vytvořená hodnota připravená touto funkcí.

Funkce

draw_image(filename, canvas, counter)

Vykreslí obrázek na ReportLab canvas na pozici určenou pořadovým číslem (vlevo, uprostřed, vpravo).

Parametry:

• filename – Cesta k souboru obrázku, který se vykreslí do záhlaví.

• canvas – ReportLab canvas objekt, na který se obrázek nakreslí.

• counter – Pořadové číslo obrázku (0 = vlevo, 1 = uprostřed, 2 = vpravo).

add_page_number(canvas, doc)

Provádí operaci add page number.

Parametry:

• canvas – Parametr canvas pracuje se s atributy saveState, setFont.

• doc – Objekt dokumentu, který je funkcí upravován nebo čten.

draw_header(canvas, doc)

Provádí operaci draw header.

Parametry:

• canvas – Parametr canvas předává se do volání draw_image(), add_page_number().

• doc – Objekt dokumentu, který je funkcí upravován nebo čten.