Ir al contenido principal

Ralsina.Me — El sitio web de Roberto Alsina

Creating Reports from Python

I need so­me ad­vi­ce. I need to crea­te an appli­ca­tion for schools that takes stu­dent da­ta (per­so­nal in­for­ma­tio­n, sub­jec­ts, gra­des, etc) and pro­du­ces their gra­de re­por­t. I need to crea­te a printed co­p­y, and keep a his­to­ric re­cor­d.

As a first ste­p, I thou­ght on ge­ne­ra­ting them in PDF via re­por­tla­b, but I want opi­nion­s. For exam­ple, I can ge­ne­ra­te the PDF, print it and re­ge­ne­ra­te it if I need to re­print it. What other op­tins do you see? It's ba­si­ca­lly text wi­th ta­ble­s. Re­por­tla­b? La­TeX? So­me other tool?

To this I re­plied I su­gges­ted Res­truc­tu­red Text whi­ch if you fo­llow my blog should sur­pri­se noone at all ;-)

In this sto­ry I wi­ll try to bring to­ge­ther all the pie­ces to turn a chunk of py­thon da­ta in­to a ni­ce PDF re­por­t. Ho­pe it´s use­ful for so­meo­ne!

Why not use reportlab directly?

He­re´s an exam­ple I pos­ted in that th­rea­d: how to crea­te a PDF wi­th two pa­ra­gra­phs, using res­truc­tu­red tex­t:

This is a paragraph. It has several lines, but what it says does not matter.
I can press enter anywhere, because
it ends only on a blank
line. Like this.

This is another paragraph.

And he­re´s what you need to do in re­por­tla­b:

# -*- coding: utf-8 -*-
from reportlab.platypus import SimpleDocTemplate, Paragraph, Spacer
from reportlab.lib.styles import getSampleStyleSheet
from reportlab.lib.units import inch
styles = getSampleStyleSheet()
def go():
  doc = SimpleDocTemplate("phello.pdf")
  Story = [Spacer(1,2*inch)]
  style = styles["Normal"]
  p = Paragraph('''This is a paragraph. It has several lines, but what it says does not matter.
I can press enter anywhere, because
it ends when the string ends.''', style)
  p = Paragraph('''This is another paragraph.''', style)


Of cour­se, you could wri­te a pro­gram that takes text se­pa­ra­ted in pa­ra­gra­phs as its in­pu­t, and crea­tes the re­por­tlab Pa­ra­gra­ph ele­men­ts, pu­ts them in the Sto­ry and buil­ds the do­cu­men­t.... but then you are rein­ven­ting the res­truc­tu­red text par­se­r, on­ly wor­se!

Res­truc­tu­red text is da­ta. Re­por­tlab pro­gra­ms are co­de. Da­ta is ea­sier to ge­ne­ra­te than co­de.

So, how do you do a report?

You crea­te a fi­le wi­th the da­ta in it, pro­ce­ss it via one of the many rs­t->­pdf pa­ths (I su­ggest my rs­t2­pdf scrip­t, but feel free to use the other 9 al­ter­na­ti­ve­s).

Su­ppo­se you ha­ve the fo­llo­wing da­ta:

frobtimes = [[1,3],[3,5],[9,8]]

And you want to pro­du­ce this re­por­t:

Frobniz performance

* 1 frobniz: 3 seconds

* 3 frobniz: 5 seconds

* 9 frobniz: 8 seconds

You could do it this wa­y:

print '''Frobniz performance

for ft in frobtimes:
  print '* %d frobniz: %d seconds\n'%(ft[0],ft[1])

And it will work. However, this means you are writing code again! This time, you are reinventing templating

What you want is to use, sa­y, Mako (or whate­ve­r). It's going to be be­tter than your ho­me­brew so­lu­tion an­ywa­y. He­re's the tem­pla­te for the re­por­t:

${title('Frobniz Performance')}

% for ft in frobtimes:
* ${ft[0]} frobniz: $ft[1] seconds

% endfor

This uses a function title defined thus:

..­co­de-­blo­ck:: py­thon

ti­tle=­lamb­da(­tex­t): tex­t+'n'+'='*­len(­tex­t)+'n­n'

You could ge­ne­ra­li­ze it to su­pport mul­ti­ple hea­ding le­vel­s:

ti­tle=­lamb­da(­tex­t,­le­ve­l): tex­t+'n'+'=-~_#%^'[­le­ve­l]*­len(­tex­t)+'n­n'

Trickier: tables

One ve­ry co­m­mon fea­tu­re of re­por­ts is ta­ble­s. In fac­t, it would be mo­re na­tu­ral to pre­sent our fro­bniz re­port as a ta­ble. The bad news is how ta­bles look like in res­truc­tu­red tex­t:

| Frobniz | Time (seconds) |
|        1|              3 |
|        3|              5 |
|        9|              8 |

Whi­ch is ve­ry pre­tty, but not exac­tly tri­vial to ge­ne­ra­te. But do­n´t wo­rr­y, the­re is a sim­ple so­lu­tion for this, too: CSV ta­ble­s.

Frobniz time measurements









And of cour­se, the­re is py­tho­n´s csv mo­du­le if you want to be fan­cy and avoid trou­ble wi­th de­li­mi­ter­s, es­ca­ping and so on:

def table(title,header,data):
  csv_writer = csv.writer(head, dialect='excel')

  head=´:header: %s´head.getvalue()

  csv_writer = csv.writer(body, dialect='excel')
  for row in data:

  return ´´´.. csv-table:: %s
     :header: %s


wi­ll pro­du­ce nea­t, ready for use, csv ta­ble di­rec­ti­ves for res­truc­tu­red tex­t.

How would it work?

This py­thon pro­gram is rea­lly ge­ne­ri­c. All you need is for it to ma­tch a tem­pla­te (an ex­ter­nal text fi­le), wi­th da­ta in the form of a bun­ch of py­thon va­ria­ble­s.

But how do we get the da­ta? We­ll, from a da­ta­ba­se, usua­ll­y. But it can co­me from an­ywhe­re. You could be making a re­port about your de­l.i­cio­.us book­ma­rks, or about fi­les in a fol­de­r, this is rea­lly ge­ne­ric stu­ff.

What would I use to get the da­ta? I would use JSON in the mi­dd­le. I would make my re­port ge­ne­ra­tor take the fo­llo­wing ar­gu­men­ts:

  1. A mako te­m­­pla­­te na­­me.

  2. A JSON da­­ta fi­­le.

That wa­y, the pro­gram wi­ll be com­ple­te­ly ge­ne­ri­c.

So, put all this to­ge­the­r, and the­re's the su­per­du­per ma­gi­cal re­port ge­ne­ra­to­r.

On­ce you get rs­t, pa­ss it th­rou­gh so­me­thing to crea­te PDFs, but sto­re on­ly the rs­t, whi­ch is (al­mos­t) plain tex­t, sear­cha­ble, ea­sy to sto­re, and mu­ch sma­lle­r.

I do­n´t ex­pect su­ch a re­port ge­ne­ra­tor to be over 50 li­nes of co­de, in­clu­ding co­m­men­ts.

Missing pieces

  • Whi­­le res­­tru­c­­tu­­red text is al­­most plain tex­­t, the­­re are spe­­cial cha­­ra­c­­te­r­s, whi­­ch you should es­­ca­­pe. That is le­­ft as an exe­r­­ci­­se to the rea­­der ;-)

  • So­­­meo­­­ne should rea­­lly wri­­te this thing ;-)

kushaldas / 2012-11-23 20:30:

After 4 years asking if you know anyone actually wrote that ?

Roberto Alsina / 2017-11-29 12:37:

A 5-year late reply: nope.

Roberto Alsina / 2017-12-02 16:20:

Contents © 2000-2020 Roberto Alsina