Příprava štítků s čárovými kódy (python-reportlab)

19.5.2014 22:27 | Přečteno: 1679× | poslední úprava: 19.5.2014 22:35

Po mém předchozím zápisku o webové aplikaci www.123stitky.cz pro tvorbu adresních štítků dnes rozeberu, jak jsou tyto štítky generovány v Pythonu s použitím knihovny Reportlab. Dostane se nejen na textové štítky, ale i na to, jak do nich vložit QR kód a EAN čárový kód.

Možností, jak programově generovat PDF je celá řada. Ale protože pro mě je Python jazyk, ve kterém píši již 13 let a o kterém jsem před těmi 13 roky psal, je volba jasná.

Reportlab

Reportlab je pythonovský balíček modulů pro programové generování PDF. Kromě odkazované open-source verze (dokumentace, jak jinak, než v PDF) je k dispozici i placená verze, kde se připlácí především za šablonovací systém a podporu. V dnešní ukázce žádné pokročilé vlastnosti nevyužijeme, proto na Debianu nainstalujeme balíček python-reportlab a kód můžeme rovnou otestovat.

V této jednoduché ukázce si řekneme, jak za použití vlastního TTF fontu vykreslit text odpovídající jednotlivým řádkům štítku, štítku nastavit vlastní velikost a pak do definovaných míst vykreslíme QR kód a EAN čárový kód. Protože vykreslení čárových kódů o přesně daném rozměru není z mého pohledu tak průhledné, jak by mohlo být, ukáži jednoduchou funkci, jak čárový kód ztransformovat tak, aby se vykreslil přesně tam, kam potřebujeme. V následující ukázce následují jednotlivé fragmenty kódu, přičemž odpovídající importy (z) modulů jsou vždy na začátku fragmentu. Při psaní produkčního kódu by bylo dobré dát je na začátek zdrojového souboru.

Začínáme

Nejprve si vytvoříme objekt out, instanci třídy Canvas, do kterého budeme kreslit obsah štítku. První parametr je jméno souboru, do kterého bude výstup uložen:

from reportlab.pdfgen import canvas
from reportlab.lib.units import mm, inch

PAGE_WIDTH = 100*mm
PAGE_HEIGHT = 50*mm

out = canvas.Canvas('out.pdf', pagesize=(PAGE_WIDTH, PAGE_HEIGHT))

Reportlab používá vtipný způsob pro práci s rozměry, z modulu units si můžete naimportovat milimetry (mm) nebo palce (inch) a rozměry zadávat jako jejich násobky (viz PAGE_WIDTH, PAGE_HEIGHT). Rozměry Canvasu jsou předány jako tuple o dvou hodnotách, pokud chcete použít standardní rozměr stránky, použijte:

from reportlab.lib.pagesizes import A4
out = canvas.Canvas('out.pdf', pagesize=A4)

Vlastní font

Chceme kreslit vlastním TTF fontem. Pro ukázku použijeme DejaVu font z Debianího balíku ttf-dejavu-core. Font vytvoříme a zaregistrujeme pod vlastním názvem pomocí kódu:

from reportlab.pdfbase import pdfmetrics 
from reportlab.pdfbase.ttfonts import TTFont 

FONT_NAME = 'DejaVuSans'
font = TTFont(FONT_NAME, '/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf')
pdfmetrics.registerFont(font)
FONT_SIZE = 10

Jdeme kreslit

Před kreslením nejprve nastavím náš načtený font a pak vykreslíme čtyři řádky. Reportlab měří vzdálenosti od levého dolního rohu, stejně tak text renderovaný pomocí drawString() má svůj levý dolní roh na pozici předané jako parametr:

out.setFont(FONT_NAME, FONT_SIZE)

out.drawString(10*mm, 10*mm, u"Řádek 4")
out.drawString(10*mm, 20*mm, u"Řádek 3")
out.drawString(10*mm, 30*mm, u"Řádek 2")
out.drawString(10*mm, 40*mm, u"Řádek 1")

Příprava na čárové kódy

Základní kostru kódu, jak v Reportlabu tisknout QR kódy a EAN čárové kódy jsem vzdal ze stackoverflow, kde ale parametr transform je určen jasně nejasně a spíše tak, aby to fungovalo. Tento parametr určuje transformační matici a nechá se získat pomocí funkcí translate a scale z modulu reportlab.graphics.shapes. Já jsem se však inspiroval pohledem na tento zdrojový kód, kde je vše nutné. Definujme tedy funkci, která dokáže vykreslit kód do Canvasu. Její parametry:

• x, y jsou souřadnice, kam kód vykreslit (počátek vlevo dole)
• width, height je šířka, resp. výška kódu
• w_type je třída, která je použita pro vykreslení kódu (viz níže)
• text je řetězec, který je předán konstruktoru čárového kódu

Po vytvoření instance třídy Drawing do ní přidáme čárový kód a vykreslíme do PDF canvasu. Nakonec, spíše pro ilustraci nakreslíme rámeček okolo čárového kódu, abychom věděli odkud kam sahá.

from reportlab.graphics.shapes import Drawing
from reportlab.graphics import renderPDF


def draw_barcode(canvas, x, y, width, height, w_type, text):
    code = w_type(value=text)
    x1, y1, x2, y2 = code.getBounds()
    w = float(x2 - x1)
    h = float(y2 - y1)

    sx = width/w
    sy = height/h

    w *= sx
    h *= sy

    drawing = Drawing(width=w,height=h,transform=[sx,0,0,sy,-sx*x1,-sy*y1])
    drawing.add(code)
    renderPDF.draw(drawing, canvas, x, y)

    canvas.rect(x, y, width, height)

Čárové kódy

Nyní tuto funkci použijeme pro vykreslení QR kódu a EAN čárového kódu. Při tom použijeme třídy QrCodeWidget a Ean13BarcodeWidget, ale můžeme generovat celou řadu jiných kódů (viz dokumentace reportlab.graphics).

Nejprve tedy importy:

from reportlab.graphics.barcode.qr import QrCodeWidget 
from reportlab.graphics.barcode.eanbc import Ean13BarcodeWidget

Vykreslení QR kódu do pravého horního rohu štítku:

W = 24*mm
H = 24*mm
draw_barcode(out, PAGE_WIDTH-W, PAGE_HEIGHT-H, W, H,
    QrCodeWidget, 'https://www.123stitky.cz')

A čárového EAN13 kódu do pravého dolního rohu štítku. Pro informace o rozměrech EAN kódu jsem použil tuto stránku:

W = 37.29*mm
H = 25.93*mm
draw_barcode(out, PAGE_WIDTH-W, 0, W, H,
    Ean13BarcodeWidget, '79357367900')

Ukládáme

Nyní již štítek můžeme uložit do PDF jednoduchým voláním metody save(). Po tomto volání již Canvas nemůžeme používat, zato se může podívat do souboru out.pdf (viz volání konstruktoru Canvas):

out.save()

Poznámky

Pokud budete chtít v PDF více stránek, pak zavolejte out.showPage() pro založení nové stránky.

Prostřednictvím modulu reportlab.graphics lze renderovat nejen PDF (renderPDF), ale i bitmapové formáty (renderPM) nebo SVG (renderSVG).

Pro generování náhledu štítků na první stránce www.123stitky.cz používám PNG, které konvertuji z PDF pomocí balíčku wand což je ctypes binding nad ImageMagickem a jeho použití vypadá následovně (v preview je string obsahující BLOB s PNG):

from wand.image import Image

with Image(filename="out.pdf[0]", resolution=150) as img:
    preview = img.make_blob(format='png')

Závěr

Reportlab je velice silný nástroj a v tomto zápisku je popsána jen velice omezená podmnožina funkcí, kterou používám pro on-line generování dopisních a jiných štítků ve webové aplikaci www.123stitky.cz. Reportlab navíc umí sázet text do odstavců, měnit styl písma, zarovnávat text, kreslit tvary různými barvami, vytvářet tabulky a spoustu dalšího, přesto věřím, že některým z vás tento kód může pomoci a usnadnit tvorbu PDF dokumentů s QR, EAN nebo jinými čárovými či 2D kódy.        

Komentáře

[Jan Švec]

Příloha:

• reportlab_codes.ipynb (3269 bytů)

Přikládám IPython notebook (zdrojový kód) pro experimentování.

[Stevko]

V Brmlabe na čiarové kódy používame pythoní skript z https://github.com/brmlab/misc (barcodes.py), ktorý vyrobí pomocou zintu svg s kódmi a naskladá ich na vhodné miesta do väčšieho svg (tak, aby to sedelo na samolepky). Ale samozrejme, dá sa využiť gnu barcode (sh skriptík tiež tam).

[Marv-CZ]

Ony na to existují i aplikace, např. gLabels. Ale chápu, že používat GUI je trapné.

[Zbyšek]

Trapná reklama.

[smazáno]

Na open-source reportlab.

[Salamek]

https://www.123stitky.cz/jaknato Uplne dole se nenahravaji dva obrazky...