PyFoam.Basics.RestructuredTextHelper module

Helps formatting output for restructured text

class PyFoam.Basics.RestructuredTextHelper.LabledReSTTable

Bases: ReSTTable

A ReSTTable that has rownames in the first column and column-names in the first row

__init__()

__module__ = 'PyFoam.Basics.RestructuredTextHelper'

addItem(column, value, row=None)

addRow(rowName)

class PyFoam.Basics.RestructuredTextHelper.ReSTTable

Bases: object

Class that administrates a two-dimensional table and prints it as a restructured text-table when asked

__annotations__ = {}

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.RestructuredTextHelper', '__doc__': 'Class that administrates a two-dimensional table and prints it as\n    a restructured text-table when asked', '__init__': <function ReSTTable.__init__>, 'addLine': <function ReSTTable.addLine>, '__str__': <function ReSTTable.__str__>, '__setitem__': <function ReSTTable.__setitem__>, 'setElement': <function ReSTTable.setElement>, '__dict__': <attribute '__dict__' of 'ReSTTable' objects>, '__weakref__': <attribute '__weakref__' of 'ReSTTable' objects>, '__annotations__': {}})

__init__()

__module__ = 'PyFoam.Basics.RestructuredTextHelper'

__setitem__(index, value)

Sets an item of the table :param index: a tuple with a row and a column. If it is a single integer then the row is assumed :param value: the value to set. If only the row was specified it is a list with the column values

__str__()

Output the actual table

__weakref__

list of weak references to the object (if defined)

addLine(val=None, head=False)

Add a line after that row :param val: the row after which to add. If None a line will be added after the current last row

setElement(row, col, value)

Sets a specific element :param row: the row :param col: column :param value: the used value

class PyFoam.Basics.RestructuredTextHelper.RestructuredTextHelper(defaultHeading=2)

Bases: object

Helper class that formats stuff for restructured text

LevelChapter = 1

LevelParagraph = 5

LevelPart = 0

LevelSection = 2

LevelSubSection = 3

LevelSubSubSection = 4

__dict__ = mappingproxy({'__module__': 'PyFoam.Basics.RestructuredTextHelper', '__doc__': 'Helper class that formats stuff for restructured text', 'LevelPart': 0, 'LevelChapter': 1, 'LevelSection': 2, 'LevelSubSection': 3, 'LevelSubSubSection': 4, 'LevelParagraph': 5, '__init__': <function RestructuredTextHelper.__init__>, 'buildHeading': <function RestructuredTextHelper.buildHeading>, 'heading': <function RestructuredTextHelper.heading>, 'table': <function RestructuredTextHelper.table>, '_RestructuredTextHelper__markup': <function RestructuredTextHelper.__markup>, 'emphasis': <function RestructuredTextHelper.emphasis>, 'strong': <function RestructuredTextHelper.strong>, 'literal': <function RestructuredTextHelper.literal>, 'bulletList': <function RestructuredTextHelper.bulletList>, 'enumerateList': <function RestructuredTextHelper.enumerateList>, 'definitionList': <function RestructuredTextHelper.definitionList>, 'code': <function RestructuredTextHelper.code>, '__dict__': <attribute '__dict__' of 'RestructuredTextHelper' objects>, '__weakref__': <attribute '__weakref__' of 'RestructuredTextHelper' objects>, '__annotations__': {}})

__init__(defaultHeading=2)

__markup(limiter, *txt)

__module__ = 'PyFoam.Basics.RestructuredTextHelper'

__weakref__

list of weak references to the object (if defined)

buildHeading(*text, **keywords)

General method to build a heading :param text: list of items that build the heading text :param level: The level of the heading

bulletList(data, bullet='-')

Generate a bullet list from the data

code(code, language='python')

@param code: string to be typeset as a program code @param language: programming language to be used

definitionList(data)

Generate a definiton list from the data.

emphasis(*txt)

enumerateList(data, first=1)

Generate an enumerated list from the data. First number can be chosen and determines the format

heading(*text)

Build a heading on the default level

literal(*txt)

strong(*txt)

table(labeled=False)

Creates a new ReSTTable-object