Customizing outputΒΆ

Pweave has several output formats and you can customize the output with chunk options. However you may want to customize the output for different purposes.

The simplest form of customization is to update the format dictionary of an existing format. It sets chunk delimiters, output extension and figure format and width.

You can do this easily with Pweb class. Below is a small demonstration using ReST Pweave document ma.mdw.

Let’s start by creating an instance of Pweb class with markdown document:

>>> from pweave import *
>>> from pprint import pprint
>>> doc = Pweb('ma.mdw', format = "pandoc")

Have a look at what the format dictionary contains:

>>> pprint(doc.getformat())
{'codeend': '~~~~~~~~~~~~~\n\n',
 'codestart': '~~~~{.%s}',
 'doctype': 'pandoc',
 'extension': 'md',
 'figfmt': '.png',
 'indent': '',
 'outputend': '~~~~~~~~~~~~~\n\n',
 'outputstart': '~~~~{.%s}',
 'savedformats': ['.png'],
 'termend': '~~~~~~~~~~~~~\n\n',
 'termindent': '',
 'termstart': '~~~~{.%s}',
 'width': None}

The names of the dictionary elements are hopefully self explanatory. You’ll notice that you can specify start and end tag for code, results and term as well as block indent.

You can change the formats using Pweb.updateformat() method. Let’s set the default figure width to 10cm and figure format to pdf. The savedformats key allows you to specify multiple formats to save and figfmt specifies what format is used in the output.

>>> doc.updateformat({'width' : '10cm', 'figfmt' : '.pdf',
'savedformats' : ['.pdf']})

And after setting options weave and tangle the document:

>>> doc.weave()
Processing chunk 1 named None from line 22
Processing chunk 2 named None from line 31
Processing chunk 3 named None from line 42
Pweaved ma.mdw to ma.md
>>> doc.tangle()
Tangled code from ma.mdw to ma.py

View this page as Pweave document .