The document discusses ReportLab, an open source Python library for generating PDFs, and focuses on improvements made to the way paragraphs are handled. It introduces a new MinimalParagraph class that provides a simpler approach to formatting text blocks, making it easier to extend and add new functionality. Examples are provided of how attributes can be applied at both the global and local level to style paragraph text.
4. General Features
• Generating PDF with Python (+ some C)
• Content: fonts, graphics, images, tables
• PDF features: page transitions, hyperlinks,
outline, …
• Graphics import as bitmaps and SVG (ext.)
• Graphics export as bitmaps, PDF, EPS, SVG
6. Meta Info
• Developped since ca. 1996
• By Andy Robinson, Robin Becker, et al.
• Current: SVN (v. 2.1 + 12 months)
• Open Source
• Closed Source: RML, PDF encryption,
PDF import
7. 1st Layer: Canvas
• Corresponds to a single page with
• Text,
• Graphics,
• PDF features (hyperlinks, page transitions...)
• Can also be saved as a bitmap, EPS, SVG
8. Example 1
#!/usr/bin/env python
# _*_ coding: UTF-8 _*_
from reportlab.pdfgen.canvas import Canvas
from reportlab.lib.pagesizes import A4
canv = Canvas("helloworld.pdf", pagesize=A4)
### ...
canv.showPage()
canv.save()
…
9. ###
from reportlab.lib import colors
from reportlab.lib.units import cm
# circle
canv.setStrokeColor(colors.green)
canv.setFillColor(colors.red)
canv.setLineWidth(0.5*cm)
x, y = 10*cm, 10*cm
canv.circle(x, y, 5*cm,
stroke=True, fill=True)
Hello world!
# text
canv.setFillColor(colors.yellow)
canv.setFont("Helvetica", 36)
canv.drawCentredString(x, y,
u"Hello world!")
10. 2nd Layer: Platypus
• ”Page LAyout TYPography Using Scripts“
• Frames
• PageTemplate
• DocumentTemplate
• Content: Flowables & Styles (”Story“)
• Rendered as PDF document
13. Example 2
from reportlab.lib.units import cm
from reportlab.lib.pagesizes import A4
from reportlab.pdfgen.canvas import Canvas
from reportlab.platypus import
BaseDocTemplate, PageTemplate,
Frame, Paragraph
from reportlab.lib.styles import
getSampleStyleSheet
from django.contrib.webdesign import
lorem_ipsum as li
PAGESIZE = A4
…
15. explicabo distinctio animi ad ipsam veniam enim,
Maiores cupiditate placeat fugit quis recusandae amet eveniet praesentium
def generateTwoColDocument(outPath):
veniam obcaecati consectetur maxime delectus?
Dolorem perferendis accusantium Harum molestias iure at nemo labore quod repellat
veniam optio quas ducimus eum similique, incidunt facilis itaque
"Create a 2-col doc with rand. text."
obcaecati iusto fugiat, enim unde voluptas illo? Enim
Quidem explicabo officiis quasi soluta exercitationem eaque repudiandae cupiditate ad accusantium, alias
blanditiis ullam nobis suscipit praesentium? Nostrum error tempore ducimus a dicta aut voluptates vitae,
quaerat ullam recusandae esse nulla maiores eos error cupiditate assumenda quia culpa id illum rerum
eligendi adipisci consequatur dolores, sequi cum ipsam ipsum, quisquam blanditiis corporis fugiat
veniam dolor voluptates ipsa tempora, quibusdam excepturi facilis quaerat exercitationem cum tempore
nostrum quasi labore nobis perspiciatis illo eaque vero voluptas repudiandae? Eos hic reiciendis excepturi
pariatur quos? Ipsum odio ipsa quidem amet impedit recusandae ad esse.
stylesheet = getSampleStyleSheet()
recusandae quis, corporis cupiditate laboriosam alias
ratione tempore? Exercitationem voluptates alias
aspernatur odio laboriosam dolores unde vero.
Excepturi sed repellendus facere
Blanditiis quo at consectetur impedit, iure fugiat sed
ullam
h1 = stylesheet['Heading1'] voluptate nesciunt temporibus facilis, dignissimos
aspernatur maiores assumenda nostrum, error nisi
accusamus officiis quo deleniti facere recusandae
Ipsum omnis deleniti saepe sapiente, quibusdam
neque aspernatur delectus quasi iusto a facilis, tenetur
nostrum incidunt nesciunt veritatis, velit sunt nostrum
h2 = stylesheet['Heading2']
animi quidem ea excepturi, recusandae quasi dolor quo quae necessitatibus? Delectus suscipit soluta
nulla molestiae unde repellendus odit sint non officia veniam harum sunt, laudantium iusto voluptatibus,
omnis. fuga facere nihil sed aspernatur placeat, impedit libero
Cupiditate minima pariatur itaque alias suscipit, nulla repellendus laudantium nisi nihil eveniet reiciendis?
bt = stylesheet['BodyText'] culpa atque deleniti id et tenetur aliquid unde qui vel Exercitationem nemo possimus debitis? Aliquid
sint, cumque rerum maiores voluptate, quas et quia? nesciunt cum natus eveniet obcaecati fugiat
Quam debitis praesentium vitae, nesciunt quas repellendus, et numquam odit velit alias, dolor aut
distinctio quisquam, impedit tempora architecto aut? quasi ut tempora itaque nemo earum animi, ipsa
Perspiciatis et ullam sit commodi cumque optio similique natus inventore nobis sed quia eaque totam
pariatur, eum totam minus et quis, vero itaque tempore incidunt dolorum, molestias rem blanditiis ad
molestias eius sed eligendi veniam quae dolore autem.
doloribus, unde rem odit similique sapiente eveniet?
st = story = []
Tempora voluptatibus quo dicta expedita tempore
harum porro?
Cumque blanditiis ut facilis quasi Cupiditate possimus dignissimos laborum consectetur
laudantium, illum ipsa perferendis adipisci veritatis
p = li.words(3, common=False)
Aut omnis atque molestiae est inventore delectus
ipsam a commodi, tempora ratione unde quia non nemo voluptate, assumenda molestias unde aperiam
pariatur nobis dolores, quisquam corporis iste quaerat quisquam cumque debitis, ea incidunt odit expedita
illum atque ea sint doloribus iusto nemo, amet quidem facilis, molestiae quam sint doloremque officia nemo
explicabo qui. Libero maxime magnam, dolores
p = p.capitalize()
nesciunt dolor commodi accusantium cumque ipsum,
praesentium illum pariatur? Dicta nobis culpa placeat quaerat quos nisi dolorem libero eaque at, nobis eaque
tenetur repellat distinctio pariatur debitis praesentium, omnis labore libero magnam officia. Quis aperiam
exercitationem repudiandae dolore et fugiat neque? tempore perferendis asperiores pariatur cum,
st.append(Paragraph(p, style=h1))
Doloremque et non architecto quas, laudantium accusamus error ratione, consectetur minus saepe
repellat a deserunt minima explicabo beatae possimus, veritatis harum, similique aliquid exercitationem cum
facilis fugit similique ad porro sapiente suscipit odit assumenda, natus unde non veniam quas illum enim
alias quod qui excepturi, autem provident fugiat amet sequi quis molestias.
for i in range(10): pariatur ullam perferendis ipsa fugit. Minus fugiat sint
consequatur delectus necessitatibus eius eum.
Voluptate sit ratione nobis aperiam omnis fugit
Mollitia amet voluptatum facere
blanditiis
p = li.words(5, common=False)
accusantium totam sequi accusamus, nulla perspiciatis
ut corporis eos possimus, ducimus id veniam earum, Et ullam placeat ut accusamus recusandae quidem
molestias ipsa dolorum aut eligendi doloremque totam veritatis voluptatibus. Officia quae voluptates
laudantium atque aliquam voluptatibus hic esse, necessitatibus beatae atque laudantium voluptas
voluptate veritatis sequi vero, dolore asperiores at
p = p.capitalize()
explicabo amet assumenda eaque autem molestiae
exercitationem fugiat quasi sequi? Facilis tenetur qui molestias iusto eum ab necessitatibus, voluptatibus
eveniet obcaecati saepe porro repellat doloremque quis minus? Distinctio eos dolore corporis corrupti
magni, dolor assumenda error recusandae rem ducimus facilis iste doloribus nisi eligendi.
st.append(Paragraph(p, style=h2))
for j in range(3):
p = li.paragraph()
st.append(Paragraph(p, style=bt))
doc = TwoColumnDocTemplate(outPath, pagesize=PAGESIZE)
doc.build(story)
16. 3rd Layer: RML
• ”Report Markup Language“
• Platypus in XML + Black Box + ¥$€
• See also: z3c.rml (S. Richter et al. – free)
• PageCatcher (more ¥$€) for PDF import
• See also: one of my next announcements…
18. Features
• Subclass of the Flowable class
• Core class in Platypus (paragraph.py)
• No alternative (except para.py – R.I.P.)
• Central feature: linebreaks
• Knows style attributes
23. New Approach
• New Flowable!
• MinimalParagraph class
• Easily extensible (shown in subclasses)
• Linebreaks (and not much more)!
• Critical methods: wrap, split, draw
26. MinimalParagraph
• Global attributes: fontName, fontSize,
leading, firstLineIndent, leftIndent,
rightIndent, textColor, (spaceBefore,
spaceAfter)
• No alignment (left only), …
• Focus on linebreaks and RL compliance
27. Alice was beginning to get very tired of sitting well, and noticed that they were filled with
by her sister on the bank, and of having cupboards and book-shelves; here and there
nothing to do: once or twice she had peeped she saw maps and pictures hung upon pegs.
into the book her sister was reading, but it She took down a jar from one of the shelves
had no pictures or conversations in it, `and as she passed; it was labelled `ORANGE
what is the use of a book,' thought Alice MARMALADE', but to her great
`without pictures or conversation?' disappointment it was empty: she did not like
to drop the jar for fear of killing somebody, so
So she was considering in her own mind (as managed to put it into one of the cupboards
well as she could, for the hot day made her as she fell past it.
feel very sleepy and stupid), whether the
pleasure of making a daisy-chain would be `Well!' thought Alice to herself, `after such a
worth the trouble of getting up and picking fall as this, I shall think nothing of tumbling
the daisies, when suddenly a White Rabbit down stairs! How brave they'll all think me at
with pink eyes ran close by her. home! Why, I wouldn't say anything about it,
even if I fell off the top of the house!' (Which
There was nothing so VERY remarkable in was very likely true.)
that; nor did Alice think it so VERY much out
of the way to hear the Rabbit say to itself, Down, down, down. Would the fall NEVER
`Oh dear! Oh dear! I shall be late!' (when she come to an end! `I wonder how many miles
thought it over afterwards, it occurred to her I've fallen by this time?' she said aloud. `I
that she ought to have wondered at this, but must be getting somewhere near the centre
at the time it all seemed quite natural); but of the earth. Let me see: that would be four
when the Rabbit actually TOOK A WATCH thousand miles down, I think--' (for, you see,
OUT OF ITS WAISTCOAT- POCKET, and Alice had learnt several things of this sort in
MinimalParagraph
looked at it, and then hurried on, Alice her lessons in the schoolroom, and though
started to her feet, for it flashed across her this was not a VERY good opportunity for
mind that she had never before seen a rabbit showing off her knowledge, as there was no
with either a waistcoat-pocket, or a watch to one to listen to her, still it was good practice
take out of it, and burning with curiosity, she to say it over) `--yes, that's about the right
ran across the field after it, and fortunately distance--but then I wonder what Latitude or
was just in time to see it pop down a large Longitude I've got to?' (Alice had no idea
28. ColouredParagraph
#!/bin/env/python def draw(self):
# -*- coding: utf-8 -*- "Render words in paragraph on randomly
coloured background."
"An example for a coloured paragraph
subclass." if not self.words:
return
import random canvas = self.canv
style = self.style
from reportlab.lib import colors
canvas.saveState()
from minimalparagraph import
MinimalParagraph canvas.setFont(style.fontName, style.fontSize)
for word in self.words:
RL_COLORS = [v for (k, v) in if "meta" in word or not "pos" in word:
colors.__dict__.items() continue
if isinstance(v, colors.Color)] text, (x, y) = word["text"], word["pos"]
col = random.choice(RL_COLORS)
canvas.setStrokeColor(col)
class ColouredParagraph(MinimalParagraph): canvas.setFillColor(col)
"A colourful tiny subclass canvas.rect(x, y - self.dy,
of MinimalParagraph." word["width"], style.fontSize,
fill=True, stroke=True)
canvas.setFillColor(style.textColor)
canvas.drawString(x, y - self.dy, text)
canvas.restoreState()
35. CHAPTER II
The Pool of Tears
`Curiouser and curiouser!' cried Alice (she
was so much surprised, that for the moment she
quite forgot how to speak good English); `now
I'm opening out like the largest telescope that
ever was! Good-bye, feet!' (for when she looked
down at her feet, they seemed to be almost out of
sight, they were getting so far off). `Oh, my poor
GraphicsParagraph
little feet, I wonder who will put on your shoes
and stockings for you now, dears? I'm sure _I_
shan't be able! I shall be a great deal too far off to
36. ReportLab Paragraph CountingParagraph
If you need something that 0 If you need something that
isn't on the feature list, 1 isn't on the feature list,
please check the mailing-list 2 please check the mailing-list
archives. Lots of features 3 archives. Lots of features
are yet to be documented, 4 are yet to be documented,
but most of the functionality 5 but most of the functionality
has been commented in the 6 has been commented in the
mailing-list. If you have a 7 mailing-list. If you have a
problem that has not been 0 problem that has not been
CountingParagraph
dealt with yet... 1 dealt with yet...
40. Current State
• Family of paragraph classes
• Usually domain specific (e.g. kerning)
• Small code size
• Ca. 2–3 x slower than RL (pure text)
• Easier extensible than RL
41. Future
• Further Paragraph attributes
• KerningParagraph
• XMLParagraph (tags)
• General callback mechanism
• RTLParagraph? (Right to Left)
43. Questions?
” three questions, and that is enough,‘
’I have answered
Said his father; ’don't give yourself airs!
Do you think I can listen all day to such stuff?
Be off, or I'll kick you down stairs!‘
“
Alice‘s Adventures in Wonderland, Lewis Carroll