| | |
- AbstractTag
-
- Address
- Big
- Blockquote
- Caption
- Center
- Cite
- Code
- Define
- Div
- Emphasis
- Font
- Frame
- Frameset
- Heading
- KBD
- NoFrames
- Nobr
- Paragraph
- Pre
- Sample
- Small
- Span
- Strike
- Strong
- Sub
- Sup
- TD
- TH
- TR
- TT
- TableLite
- U
- Var
- AbstractTagSingle
-
- Area
- BR
- Base
- BaseFont
- Embed
- HR
- Image
- BasicDocument
-
- FramesetDocument
- SimpleDocument
-
- SeriesDocument
- Comment
- Container
- Form
- Href
-
- Name
- InitialCaps
- Input
- MailTo
- Map
- Meta
- P
- RawText
- Script
- StringTemplate
-
- AutoStringTemplate
-
- AutoTemplateDocument
- TemplateDocument
- Table
- Text
- Textarea
- URL
- UserList.UserList(_abcoll.MutableSequence)
-
- List
-
- DefinitionList
- ImageBulletList
- NonBulletList
- OrderedList
- Select
A = class Href |
| |
Generate a hyperlink.
Argument 1 is the URL and argument 2 is the hyperlink text.
Keyword arguments
target -- is an optional target symbol
onClick -- is the script-code which is executed when link is clicked.
onMouseOver -- the script-code which is executed when the mouse
moves over the link.
onMouseOut -- the script-code which is executed when the mouse
moves off the link.
|
| |
Methods defined here:
- __init__(self, url='', text='', **kw)
- __str__(self)
- append(self, content)
|
class AbstractTag |
| |
Abstract base class for all tag markup classes requiring a closure tag.
|
| |
Methods defined here:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes defined here:
- attr_dict = {}
- attr_template = ''
- attrs = ()
- html_escape = 'ON'
- tagname = ''
- trailer = '\n'
|
class AbstractTagSingle |
| |
Abstract base class for all tag markup classes not requiring a closure tag.
|
| |
Methods defined here:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
Data and other attributes defined here:
- attr_dict = {}
- attr_template = ''
- attrs = ()
- tagname = ''
|
class Address(AbstractTag) |
| |
A mailing address. Not a URL.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'ADDRESS'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Area(AbstractTagSingle) |
| |
Specify a click-sensitive area of an image.
The area is linked to a HREF specified by the href attribute.
The coords attribute is required and describes the position of
an area (in pixels) of the image in comma-separated x,y
coordinates where the upper-left corner is "0,0". For shape='rect'
(the default), it is "left,top,right,bottom". For shape='circle',
it is "center_x,center_y,radius". For shape='polygon', it is
successive x,y vertices of the polygon. If the first and last
coordinates are not the same, then a segment is inferred to close
the polygon. If no href* keyword is given a *NOHREF will be
generated indicating that this region should generate no links.
Keyword Arguments
href -- Typically a reference to an image
coords -- string holding a list of coordinates defining
shape -- 'rect'|'circle'|'polygon'
|
| |
Data and other attributes defined here:
- attr_dict = {'alt': '', 'class': '', 'coords': '', 'href': ' nohref', 'id': '', 'name': '', 'onmouseout': '', 'onmouseover': '', 'shape': '', 'target': ''}
- attr_template = '%(alt)s%(class)s%(coords)s%(href)s%(id)s%(name)s%(onmouseout)s%(onmouseover)s%(shape)s%(target)s'
- attrs = ('alt', 'class', 'coords', 'href', 'id', 'name', 'onmouseout', 'onmouseover', 'shape', 'target')
- tagname = 'AREA'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
|
class AutoStringTemplate(StringTemplate) |
| | |
Methods defined here:
- extract_template(self, source=None)
- Convert comment-marked regions to a regular {tokens}.
Updates the substitution dictionary with the text from the region.
- set_template(self, template)
- Set template string and normalize by extracting comment tokens.
Data and other attributes defined here:
- R = <_sre.SRE_Pattern object>
- marker_begin = '<!--{%s}Begin-->'
- marker_end = '<!--{%s}End-->'
Methods inherited from StringTemplate:
- __getitem__(self, name)
- __init__(self, template, substitutions=None, **kw)
- __setitem__(self, name, value)
- __str__(self)
- keys(self)
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
Will not overwrite file is it exists and is textually the same.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument given.
|
class AutoTemplateDocument(AutoStringTemplate) |
| |
Generate documents based on a template and a substitution mapping.
The primary difference between AutoTemplateDocument and TemplateDocument
is that the Auto version can read through an HTML file previously
generated with this class and identify the regions of text that were
substituted. It then extracts that text into the substitution dictionary
and can then be updated. The intent is to eliminate the need to
maintain separate content files for insertion into templates. The HTML
output file can double as a template for future use.
Output from this class have their filled regions marked by comments:
...gets <!--{wz}Begin-->glued,<!--{wz}End--> in place...
Which came from ...gets {wz} in place... in old style template syntax.
AutoTemplateDocument is a functional superset of TemplateDocument and should
be compatible.
Usage:
T = AutoTemplateDocument('Maine.html')
T.substitutions = {'month': ObjectY, 'town': 'Scarborough'}
or
T['month'] = ObjectY ; T['town'] = 'Scarborough'
T.write('Maine.html')
A dictionary, or object that behaves like a dictionary, is assigned to the
substitutions attribute which has symbols as keys to objects. Upon every
occurance of these symbols surrounded by braces {} in the source template,
the corresponding value is converted to a string and substituted in the output.
For example, source text which looks like:
I lost my heart at {town} Fair.
becomes:
I lost my heart at Scarborough Fair.
Symbols in braces which do not correspond to a key in the dictionary remain
unchanged.
An optional third argument to the class is a list or two strings to be
used as the delimiters instead of { } braces. They must be of the same
length; for example ['##+', '##'] is invalid.
|
| |
- Method resolution order:
- AutoTemplateDocument
- AutoStringTemplate
- StringTemplate
Methods defined here:
- set_template(self, template)
Methods inherited from AutoStringTemplate:
- extract_template(self, source=None)
- Convert comment-marked regions to a regular {tokens}.
Updates the substitution dictionary with the text from the region.
Data and other attributes inherited from AutoStringTemplate:
- R = <_sre.SRE_Pattern object>
- marker_begin = '<!--{%s}Begin-->'
- marker_end = '<!--{%s}End-->'
Methods inherited from StringTemplate:
- __getitem__(self, name)
- __init__(self, template, substitutions=None, **kw)
- __setitem__(self, name, value)
- __str__(self)
- keys(self)
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
Will not overwrite file is it exists and is textually the same.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument given.
|
class BR(AbstractTagSingle) |
| |
Break tag. Argument is an integer integer multiplier. BR(2)=='<BR><BR>'
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- attr_dict = {'clear': ''}
- attr_template = '%(clear)s'
- attrs = ('clear',)
- tagname = 'BR'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
|
class Base(AbstractTagSingle) |
| |
Specify the base URL for all relative URLs in this document.
One string argument required. It must be a complete file name, and
is usually the original URL of this document. If this file is
moved, having the BASE set to the original URL eliminates the need
to also move all the documents which are identified by relative
URL links in this document.
|
| |
Data and other attributes defined here:
- attr_dict = {'href': '', 'target': ''}
- attr_template = '%(href)s%(target)s'
- attrs = ('href', 'target')
- tagname = 'BASE'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
|
class BaseFont(AbstractTagSingle) |
| |
Specify the font size for subsequent text.
|
| |
Data and other attributes defined here:
- attr_dict = {'color': '', 'name': '', 'size': ''}
- attr_template = '%(color)s%(name)s%(size)s'
- attrs = ('color', 'name', 'size')
- tagname = 'BASEFONT'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
|
class BasicDocument |
| |
Base class to define an HTML document.
Non-keyword arguments are taken as the initial contents for this object.
Keyword arguments:
title -- HTML TITLE attribute for document
bgcolor -- background color expressed in hex-triplet or names from HTMLcolors.
background -- background image filename
cgi -- flag to indicate if this is used in CGI context (1 if it is)
textcolor -- color to use for normal text
linkcolor -- color to use for hyperlinks
vlinkcolor -- color to use for visited hyperlinks
alinkcolor -- color to use when hyperlink is active
|
| |
Methods defined here:
- __init__(self, args, *kw)
- __str__(self)
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD, TITLE and BODY tags.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes defined here:
- alinkcolor = None
- background = None
- bgcolor = None
- cgi = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
class Big(AbstractTag) |
| |
Format text in a bigger font.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'BIG'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Blockquote(AbstractTag) |
| |
Indent text as a block quotation.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'BLOCKQUOTE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
Bold = class Strong(AbstractTag) |
| |
Strongly emphasize the text.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'STRONG'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
BulletList = class List(UserList.UserList) |
| |
Will generate a bulleted list given a list argument.
Now supports rendering a list into multiple columns by setting the
columns attribute to a number greater than one. This is
implemented using tables and you can also set a background color
for the list itself by using the bgcolor attribute.
Supports nested lists, i.e. lists of lists. Each time a list is
encountered in a list it will indent those contents w.r.t. the
prior list entry. This can continue indefinitely through nested
lists although there are only three different bullets provided by
the browser (typically).
Optional keyword indent can be used to indicate whether you want
the list to start left justified or indented. indent=0 will make
it left justified. The default is to indent.
Optional keyword type can be set to either disk, circle, or
square to specify what kind of symbol is used for each list item's
bullet. (Netscape extension)
Since we inherit from the UserList class any normal list
operations work on instances of this class. Any list contents
will do. Each of the items will be emitted in html if they are
themselves objects from this module.
Aliases: UL, BulletList
|
| |
- Method resolution order:
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes defined here:
- I_am_a_list = 1
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'align', 'class', 'id', 'style')
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
- tagname = 'UL'
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class Caption(AbstractTag) |
| |
Define a caption for a table.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': '', 'valign': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s%(valign)s'
- attrs = ('class', 'id', 'style', 'align', 'valign')
- tagname = 'CAPTION'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Center(AbstractTag) |
| |
Center the text.
|
| |
Data and other attributes defined here:
- attr_dict = {}
- attr_template = ''
- attrs = ()
- tagname = 'center'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Cite(AbstractTag) |
| |
A citation.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'CITE'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Code(AbstractTag) |
| |
Code sample. Escaping of special characters is not performed.
To enable escaping set html_escape='ON'.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- html_escape = 'OFF'
- tagname = 'CODE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- trailer = '\n'
|
class Container |
| |
A holder for a list of HTMLgen objects.
|
| |
Methods defined here:
- __add__(self, other)
- __init__(self, args, *kw)
- __str__(self)
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Container object.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
|
DL = class DefinitionList(List) |
| |
Show a series of items and item definitions.
Arg is a list of tuple pairs:
[(string/object,string/object),(,)...] 1st item in each pair is
the word to be defined. It will be rendered in bold. 2nd is the
string which will be indented to it's next-line-right. If the
compact flag is set to non-empty, the definition side will be
placed on the same line. Example
DefinitionList([( 4 , 'Number after 3') , ( 1 , 'Unity')] ) will emit:
4
Number after 3
1
Unity
|
| |
- Method resolution order:
- DefinitionList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- render_list_item(self, item)
- Overload method to perform DT/DD markup.
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ('class', 'id', 'style')
- flags = ('compact',)
- tagname = 'DL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class Define(AbstractTag) |
| |
Format as definition text.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'DFN'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class DefinitionList(List) |
| |
Show a series of items and item definitions.
Arg is a list of tuple pairs:
[(string/object,string/object),(,)...] 1st item in each pair is
the word to be defined. It will be rendered in bold. 2nd is the
string which will be indented to it's next-line-right. If the
compact flag is set to non-empty, the definition side will be
placed on the same line. Example
DefinitionList([( 4 , 'Number after 3') , ( 1 , 'Unity')] ) will emit:
4
Number after 3
1
Unity
|
| |
- Method resolution order:
- DefinitionList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- render_list_item(self, item)
- Overload method to perform DT/DD markup.
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ('class', 'id', 'style')
- flags = ('compact',)
- tagname = 'DL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class Div(AbstractTag) |
| |
Specify a division within a document.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'lang': '', 'nowrap': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s%(lang)s%(nowrap)s'
- attrs = ('class', 'id', 'style', 'align', 'lang', 'nowrap')
- tagname = 'DIV'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
Document = class SeriesDocument(SimpleDocument) |
| |
Primary container class for an HTML document as part of a series.
Formerly known as Document().
Navigation mechanisms are provided.
Single optional string argument for the path to a resource file
used to specify document parameters. This helps minimize the need
for subclassing from this class. Keyword parameters may be used
for any of the following class attributes. See HTMLtest.py for
example usage.
Class instance attributes and keyword arguments
base -- object of the Base class
meta -- object of the Meta class
cgi -- if non zero will issue a mime type of text/html
logo -- ('filename', width, height) All images are specified
with a tuple of string, int, int. If the size of the
graphic is unknown, use 0, 0. This one is the little
graphic on the footer of each page.
banner -- ('filename', width, height) Banner graphic at
the top of page. Can also be set to a string filename
or an Image object. Can be autosized if it's a GIF.
title -- string to be used as the document title.
subtitle -- string to be used as the document subtitle.
If non-nil, this string will be used for the doc title
instead of title.
author -- String used in the copyright notice
email -- Email address for feedback mailto: tag
zone -- string used to label the time zone if datetime
is used. By default not used.
bgcolor -- Color string (can use variables from
HTMLcolors.py)
background -- string filename of a graphic used as the
doc background.
textcolor -- Color string used for text. (can use
variables from HTMLcolors.py)
linkcolor -- Color string used for hyperlinked text.
vlinkcolor -- Color string used for visited hypertext.
alinkcolor -- Color string used for active hypertext.
place_nav_buttons -- Flag to enable/disable the use of
navigation buttons.
Default is on. Set to 0 to disable.
blank -- Image tuple for the transparent spacer gif
prev -- Image tuple for the Previous Page button
next -- Image tuple for the Next Page button
top -- Image tuple for the Top of Manual button
home -- Image tuple for the site Home Page button
goprev -- URL string for the prev button
gonext -- URL string for the next button
gotop -- URL string for the top button
gohome -- URL string for the home button
script -- a single or list of Script objects to be included in the <HEAD>
onLoad -- Script, which is executed when the document is loaded
onUnload -- Script, which is executed when the document is unloaded
|
| |
- Method resolution order:
- SeriesDocument
- SimpleDocument
- BasicDocument
Methods defined here:
- __str__(self)
- footer(self)
- Generate the standard footer markups.
- header(self)
- Generate the standard header markups.
- nav_buttons(self)
- Generate hyperlinked navigation buttons.
If a self.go* attribute is null that corresponding button is
replaced with a transparent gif to properly space the remaining
buttons.
Data and other attributes defined here:
- author = 'Micky Mouse'
- banner = ('/image/banner.gif', 472, 30)
- blank = ('../image/blank.gif', 71, 19)
- email = 'micky@disney.com'
- gohome = None
- gonext = None
- goprev = None
- gotop = None
- home = ('../image/BTN_HomePage.gif', 74, 19)
- logo = ('/image/logo.gif', 36, 35)
- next = ('../image/BTN_NextPage.gif', 71, 19)
- place_nav_buttons = 'yes'
- prev = ('../image/BTN_PrevPage.gif', 71, 19)
- subtitle = None
- top = ('../image/BTN_ManualTop.gif', 74, 19)
- zone = ' Central US'
Methods inherited from SimpleDocument:
- __init__(self, resource=None, **kw)
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD TITLE and BODY tags.
Data and other attributes inherited from SimpleDocument:
- base = None
- meta = None
- onLoad = None
- onUnload = None
- script = None
- style = None
- stylesheet = None
Methods inherited from BasicDocument:
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes inherited from BasicDocument:
- alinkcolor = None
- background = None
- bgcolor = None
- cgi = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
EM = class Emphasis(AbstractTag) |
| |
Format with additional emphasis. (usually italics)
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'EM'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Embed(AbstractTagSingle) |
| |
Embed an application in this document.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'border': '', 'height': '', 'hidden': '', 'hspace': '', 'name': '', 'palette': '', 'pluginspage': '', 'src': '', 'type': '', ...}
- attr_template = '%(align)s%(border)s%(height)s%(hidden)s%(hspace)...page)s%(src)s%(type)s%(units)s%(vspace)s%(width)s'
- attrs = ('align', 'border', 'height', 'hidden', 'hspace', 'name', 'palette', 'pluginspage', 'src', 'type', 'units', 'vspace', 'width')
- tagname = 'EMBED'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
|
class Emphasis(AbstractTag) |
| |
Format with additional emphasis. (usually italics)
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'EM'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Font(AbstractTag) |
| |
Set the size or color of the text.
|
| |
Data and other attributes defined here:
- attr_dict = {'color': '', 'face': '', 'size': ''}
- attr_template = '%(color)s%(face)s%(size)s'
- attrs = ('color', 'face', 'size')
- tagname = 'FONT'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Form |
| |
Define a user filled form. Uses POST method.
cgi is the URL to the CGI processing program. Input objects
(any others as well) are appended to this container widget.
Keywords
name -- name of the form
submit -- The Input object to be used as the submit button.
If none specified a Submit button will automatically
be appended to the form. Do not manually append your
submit button. HTMLgen will append it for you.
reset -- Input object to be used as a reset button.
target -- set a TARGET attribute
enctype -- specify an Encoding type.
onSubmit -- script, which is executed, when the form is submitted
|
| |
Methods defined here:
- __init__(self, cgi=None, **kw)
- __str__(self)
- append(self, *items)
- Append any number of items to the form container.
|
class Frame(AbstractTag) |
| |
Define the characteristics of an individual frame.
Keywords Arguments
src -- is a HREF which points to the initial contents of the frame.
name -- is the window name used by others to direct content into this frame.
marginwidth -- is the number of pixels used to pad the left and right
sides of the frame.
marginheight -- is the number of pixels used to pad the top and bottom
sides of the frame.
scrolling -- is used to indicate scrolling policy set to 'yes'|'no'|'auto'
noresize -- is a flag which instructs the browser to disallow frame resizing.
set to non zero lock size ( noresize=1 ).
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'bordercolor': '', 'frameborder': '', 'marginheight': '', 'marginwidth': '', 'name': '', 'noresize': '', 'scrolling': '', 'src': ''}
- attr_template = '%(align)s%(bordercolor)s%(frameborder)s%(marginh...inwidth)s%(name)s%(noresize)s%(scrolling)s%(src)s'
- attrs = ('align', 'bordercolor', 'frameborder', 'marginheight', 'marginwidth', 'name', 'noresize', 'scrolling', 'src')
- tagname = 'FRAME'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Frameset(AbstractTag) |
| |
Define a Frameset to contain Frames or more Framesets
|
| |
Data and other attributes defined here:
- attr_dict = {'border': '', 'bordercolor': '', 'cols': '', 'frameborder': '', 'framespacing': '', 'onblur': '', 'onfocus': '', 'onload': '', 'onunload': '', 'rows': ''}
- attr_template = '%(border)s%(bordercolor)s%(cols)s%(frameborder)s...onblur)s%(onfocus)s%(onload)s%(onunload)s%(rows)s'
- attrs = ('border', 'bordercolor', 'cols', 'frameborder', 'framespacing', 'onblur', 'onfocus', 'onload', 'onunload', 'rows')
- tagname = 'FRAMESET'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class FramesetDocument(BasicDocument) |
| |
A minimal document suitable for entering Framesets.
Arguments are for contents NOT a document resource file.
Keyword Parameters
title -- string to be used as the document title.
base -- object of the Base class
meta -- object of the Meta class
cgi -- if non zero will issue a mime type of text/html
script -- a single or list of Script objects to be included in the <HEAD>
No <body> markup. Instead add Frameset(s) with the constructor or
append method.
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- base = None
- cgi = None
- meta = None
- script = None
Methods inherited from BasicDocument:
- __init__(self, args, *kw)
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD, TITLE and BODY tags.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes inherited from BasicDocument:
- alinkcolor = None
- background = None
- bgcolor = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
H = class Heading(AbstractTag) |
| |
Heading markups for H1 - H6
Heading(level, text, **kw)
The level arg is an integer for the level of the heading.
Valid levels are 1-6.
The text arg is a string (or any object) for the text of the heading.
Keyword arguments are align, Class, and style.
For example:
h = Heading(2, 'Chapter 3', align='center')
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class HR(AbstractTagSingle) |
| |
Break the current text flow and insert a horizontal rule.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'color': '', 'id': '', 'noshade': '', 'size': '', 'style': '', 'width': ''}
- attr_template = '%(align)s%(class)s%(id)s%(color)s%(noshade)s%(size)s%(style)s%(width)s'
- attrs = ('align', 'class', 'id', 'color', 'noshade', 'size', 'style', 'width')
- tagname = 'HR'
Methods inherited from AbstractTagSingle:
- __init__(self, args, *kw)
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
|
HREF = class Href |
| |
Generate a hyperlink.
Argument 1 is the URL and argument 2 is the hyperlink text.
Keyword arguments
target -- is an optional target symbol
onClick -- is the script-code which is executed when link is clicked.
onMouseOver -- the script-code which is executed when the mouse
moves over the link.
onMouseOut -- the script-code which is executed when the mouse
moves off the link.
|
| |
Methods defined here:
- __init__(self, url='', text='', **kw)
- __str__(self)
- append(self, content)
|
Head = class Heading(AbstractTag) |
| |
Heading markups for H1 - H6
Heading(level, text, **kw)
The level arg is an integer for the level of the heading.
Valid levels are 1-6.
The text arg is a string (or any object) for the text of the heading.
Keyword arguments are align, Class, and style.
For example:
h = Heading(2, 'Chapter 3', align='center')
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
Header = class Heading(AbstractTag) |
| |
Heading markups for H1 - H6
Heading(level, text, **kw)
The level arg is an integer for the level of the heading.
Valid levels are 1-6.
The text arg is a string (or any object) for the text of the heading.
Keyword arguments are align, Class, and style.
For example:
h = Heading(2, 'Chapter 3', align='center')
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Heading(AbstractTag) |
| |
Heading markups for H1 - H6
Heading(level, text, **kw)
The level arg is an integer for the level of the heading.
Valid levels are 1-6.
The text arg is a string (or any object) for the text of the heading.
Keyword arguments are align, Class, and style.
For example:
h = Heading(2, 'Chapter 3', align='center')
|
| |
Methods defined here:
- __str__(self)
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Href |
| |
Generate a hyperlink.
Argument 1 is the URL and argument 2 is the hyperlink text.
Keyword arguments
target -- is an optional target symbol
onClick -- is the script-code which is executed when link is clicked.
onMouseOver -- the script-code which is executed when the mouse
moves over the link.
onMouseOut -- the script-code which is executed when the mouse
moves off the link.
|
| |
Methods defined here:
- __init__(self, url='', text='', **kw)
- __str__(self)
- append(self, content)
|
IMG = class Image(AbstractTagSingle) |
| |
Inlined Image
The filename argument is a filename, or URL of a graphic image,
or a triple of ( filename, width, height ) where dimensions are in
pixels. Where the filename is found to be a valid pathname to an
existing graphic file that file will be read to determine its width and
height properties. GIF, JPEG, and PNG files are understood.
Keyword Arguments
width -- (int) Width in pixels
height -- (int) Height in pixels
border -- (int) Border width in pixels
align -- (string) 'top'|'middle'|'bottom'|'right'|'left'
alt -- (string) Text to substitute for the image in nonGUI browsers
usemap -- Imagemap name or Map object
ismap -- Flag (1|0) indicating if a server side imagemap is available.
absolute -- Absolute path to the directory containing the image
prefix -- Relative path or URL to directory containing the image
hspace -- Number of pixels to be added to the left and right of the image.
vspace -- Number of pixels to be added to the top and bottom of the image.
name -- A name for this image to be used by JavaScript
Class -- A CSS class this tag belongs to.
style -- A CSS inline style specification.
|
| |
Methods defined here:
- __init__(self, args, *kw)
- __str__(self)
- calc_rel_path(self, from_dir=None)
- Calculate the relative path from 'from_dir' to the
absolute location of the image file.
Sets self.prefix.
- process_arg(self, arg)
Data and other attributes defined here:
- attr_dict = {'align': '', 'alt': '', 'border': '', 'class': '', 'height': '', 'hspace': '', 'id': '', 'ismap': '', 'lowsrc': '', 'name': '', ...}
- attr_template = '%(src)s%(height)s%(width)s%(alt)s%(border)s%(ali...e)s%(lowsrc)s%(name)s%(style)s%(usemap)s%(ismap)s'
- attrs = ('src', 'height', 'width', 'alt', 'border', 'align', 'class', 'id', 'hspace', 'vspace', 'lowsrc', 'name', 'style', 'usemap', 'ismap')
- tagname = 'IMG'
Methods inherited from AbstractTagSingle:
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
|
class Image(AbstractTagSingle) |
| |
Inlined Image
The filename argument is a filename, or URL of a graphic image,
or a triple of ( filename, width, height ) where dimensions are in
pixels. Where the filename is found to be a valid pathname to an
existing graphic file that file will be read to determine its width and
height properties. GIF, JPEG, and PNG files are understood.
Keyword Arguments
width -- (int) Width in pixels
height -- (int) Height in pixels
border -- (int) Border width in pixels
align -- (string) 'top'|'middle'|'bottom'|'right'|'left'
alt -- (string) Text to substitute for the image in nonGUI browsers
usemap -- Imagemap name or Map object
ismap -- Flag (1|0) indicating if a server side imagemap is available.
absolute -- Absolute path to the directory containing the image
prefix -- Relative path or URL to directory containing the image
hspace -- Number of pixels to be added to the left and right of the image.
vspace -- Number of pixels to be added to the top and bottom of the image.
name -- A name for this image to be used by JavaScript
Class -- A CSS class this tag belongs to.
style -- A CSS inline style specification.
|
| |
Methods defined here:
- __init__(self, args, *kw)
- __str__(self)
- calc_rel_path(self, from_dir=None)
- Calculate the relative path from 'from_dir' to the
absolute location of the image file.
Sets self.prefix.
- process_arg(self, arg)
Data and other attributes defined here:
- attr_dict = {'align': '', 'alt': '', 'border': '', 'class': '', 'height': '', 'hspace': '', 'id': '', 'ismap': '', 'lowsrc': '', 'name': '', ...}
- attr_template = '%(src)s%(height)s%(width)s%(alt)s%(border)s%(ali...e)s%(lowsrc)s%(name)s%(style)s%(usemap)s%(ismap)s'
- attrs = ('src', 'height', 'width', 'alt', 'border', 'align', 'class', 'id', 'hspace', 'vspace', 'lowsrc', 'name', 'style', 'usemap', 'ismap')
- tagname = 'IMG'
Methods inherited from AbstractTagSingle:
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
|
class ImageBulletList(List) |
| |
Show a list of images with adjoining text(or object).
Arg is a list of tuple pairs: [(Image_obj, string/object),(,)...]
Generates an inlined image then the text followed by a <BR>
for each element.
|
| |
- Method resolution order:
- ImageBulletList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- render_list_item(self, item)
- Overload method to take first item from an item tuple and
setting it next to the second item, using BR to separate list items.
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ()
- flags = ()
- tagname = 'UL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
Indent = class Blockquote(AbstractTag) |
| |
Indent text as a block quotation.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'BLOCKQUOTE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class InitialCaps |
| |
Utility class to process text into Initial Upper Case style
using Font specifications. All text is converted to upper case
and the initial characters are altered by the size given by
the optional second argument. The rest of the characters are
altered by the size given in the optional third argument.
For example:
InitialCaps('We the people', '+3', '+1')
|
| |
Methods defined here:
- __call__(self, text)
- __init__(self, text='', upsize='+2', downsize='+1')
- __str__(self)
|
class Input |
| |
General Form Input tags.
Keyword Arguments
type -- 'TEXT' (default) Supported types include password, checkbox,
radio, file, submit, reset, hidden.
name -- provides the datum name
value -- the initial value of the input item
checked -- flag indicating if the item is checked initially
size -- size of the widget (e.g. size=10 for a text widget is it's width)
maxlength -- maximum number of characters accepted by the textfield.
border -- border width in pixels for an image type.
align -- top|middle|bottom align w.r.t. adjoining text for image types.
llabel -- an optional string set to the left of the widget
rlabel -- an optional string set to the right of the widget
onBlur -- script, which is executed, when the field loses focus,
useful for the text-type
onChange -- script, which is executed, when the field value changed,
useful for the text-type
onClick -- script, which is executed, when the field in clicked,
useful for the button, checkbox, radio, submit, reset type
onFocus -- script, which is executed, when the field receives focus,
useful for the text-type
onSelect -- script, which is executed, when part of the field
is selected, useful for the text-type
|
| |
Methods defined here:
- __init__(self, **kw)
- __str__(self)
Data and other attributes defined here:
- re_type = <_sre.SRE_Pattern object at 0xc32b8>
|
Italic = class Emphasis(AbstractTag) |
| |
Format with additional emphasis. (usually italics)
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'EM'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class KBD(AbstractTag) |
| |
Keyboard-like input.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- html_escape = 'OFF'
- tagname = 'KBD'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- trailer = '\n'
|
class List(UserList.UserList) |
| |
Will generate a bulleted list given a list argument.
Now supports rendering a list into multiple columns by setting the
columns attribute to a number greater than one. This is
implemented using tables and you can also set a background color
for the list itself by using the bgcolor attribute.
Supports nested lists, i.e. lists of lists. Each time a list is
encountered in a list it will indent those contents w.r.t. the
prior list entry. This can continue indefinitely through nested
lists although there are only three different bullets provided by
the browser (typically).
Optional keyword indent can be used to indicate whether you want
the list to start left justified or indented. indent=0 will make
it left justified. The default is to indent.
Optional keyword type can be set to either disk, circle, or
square to specify what kind of symbol is used for each list item's
bullet. (Netscape extension)
Since we inherit from the UserList class any normal list
operations work on instances of this class. Any list contents
will do. Each of the items will be emitted in html if they are
themselves objects from this module.
Aliases: UL, BulletList
|
| |
- Method resolution order:
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes defined here:
- I_am_a_list = 1
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'align', 'class', 'id', 'style')
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
- tagname = 'UL'
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
MAILTO = class MailTo |
| |
A Mailto href
First argument is an email address, optional second argument is
the text shown as the underlined hyperlink. Default is the email
address. Optional third argument is a Subject: for the email.
|
| |
Methods defined here:
- __init__(self, address='', text=None, subject=None)
- __str__(self)
- antispam(self, address)
- Process a string with HTML encodings to defeat address spiders.
|
class MailTo |
| |
A Mailto href
First argument is an email address, optional second argument is
the text shown as the underlined hyperlink. Default is the email
address. Optional third argument is a Subject: for the email.
|
| |
Methods defined here:
- __init__(self, address='', text=None, subject=None)
- __str__(self)
- antispam(self, address)
- Process a string with HTML encodings to defeat address spiders.
|
Mailto = class MailTo |
| |
A Mailto href
First argument is an email address, optional second argument is
the text shown as the underlined hyperlink. Default is the email
address. Optional third argument is a Subject: for the email.
|
| |
Methods defined here:
- __init__(self, address='', text=None, subject=None)
- __str__(self)
- antispam(self, address)
- Process a string with HTML encodings to defeat address spiders.
|
class Map |
| |
Used to name and describe a client-side image map.
The areas argument is a list of Area objects.
Keyword arg is supported for name, which defines the map name
to be used with the usemap attribute of an Image class instance.
|
| |
Methods defined here:
- __init__(self, areas=None, **kw)
- __str__(self)
|
class Meta |
| |
Set document Meta-information.
The META element is used within the HEAD element to embed
document meta-information not defined by other HTML elements.
Keywords supported
name -- NAME element attribute (default: 'keywords')
equiv -- will map to the HTTP-EQUIV attribute
content -- mandatory attribute (default: 'python,HTMLgen')
url -- URL naturally
Example:
Meta( name='keywords', content='eggs,spam,beans' )
|
| |
Methods defined here:
- __init__(self, **kw)
- __str__(self)
|
MinimalDocument = class SimpleDocument(BasicDocument) |
| |
Supports all features of a self contained document.
This includes support for CSS1, meta and base tags, and embedded
scripts.
First constructor argument is resource file containing document
attribute settings.
|
| |
Methods defined here:
- __init__(self, resource=None, **kw)
- __str__(self)
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD TITLE and BODY tags.
Data and other attributes defined here:
- base = None
- meta = None
- onLoad = None
- onUnload = None
- script = None
- style = None
- stylesheet = None
Methods inherited from BasicDocument:
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes inherited from BasicDocument:
- alinkcolor = None
- background = None
- bgcolor = None
- cgi = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
NAME = class Name(Href) |
| |
Generate a named anchor.
Arg url is a string or URL object,
Arg text is optional string or object to be highlighted as the anchor.
|
| |
Methods defined here:
- __str__(self)
Methods inherited from Href:
- __init__(self, url='', text='', **kw)
- append(self, content)
|
class Name(Href) |
| |
Generate a named anchor.
Arg url is a string or URL object,
Arg text is optional string or object to be highlighted as the anchor.
|
| |
Methods defined here:
- __str__(self)
Methods inherited from Href:
- __init__(self, url='', text='', **kw)
- append(self, content)
|
class NoFrames(AbstractTag) |
| |
Issue a message on browsers that don't support frames
|
| |
Methods defined here:
- __init__(self, contents, *kw)
Data and other attributes defined here:
- attr_dict = {}
- attr_template = ''
- attrs = ()
- tagname = 'NOFRAMES'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Nobr(AbstractTag) |
| |
Specify non-breaking text.
|
| |
Data and other attributes defined here:
- attr_dict = {}
- attr_template = ''
- attrs = ()
- tagname = 'NOBR'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class NonBulletList(List) |
| |
Generate a raw indented list without bullet symbols.
Arg is a list of python objects:
|
| |
- Method resolution order:
- NonBulletList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- render_list_item(self, item)
- Overload method to take first item from an item tuple and
setting it next to the second item, using BR to separate list items.
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ()
- flags = ()
- tagname = 'UL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
NumberedList = class OrderedList(List) |
| |
Will generate a numbered list given a list arg.
Optional keyword type can be used to specify whether you want
the list items marked with: capital letters (type='A'), small
letters (type='a'), large Roman numerals (type='I'), small Roman
numerals (type='i'). The default is arabic numbers. The other
types are HTML3.2 only and may not be supported by browsers yet.
Any list contents will do. Each of the items will be emitted
in HTML if they are themselves objects.
|
| |
- Method resolution order:
- OrderedList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'class', 'id', 'style')
- tagname = 'OL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
OL = class OrderedList(List) |
| |
Will generate a numbered list given a list arg.
Optional keyword type can be used to specify whether you want
the list items marked with: capital letters (type='A'), small
letters (type='a'), large Roman numerals (type='I'), small Roman
numerals (type='i'). The default is arabic numbers. The other
types are HTML3.2 only and may not be supported by browsers yet.
Any list contents will do. Each of the items will be emitted
in HTML if they are themselves objects.
|
| |
- Method resolution order:
- OrderedList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'class', 'id', 'style')
- tagname = 'OL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class OrderedList(List) |
| |
Will generate a numbered list given a list arg.
Optional keyword type can be used to specify whether you want
the list items marked with: capital letters (type='A'), small
letters (type='a'), large Roman numerals (type='I'), small Roman
numerals (type='i'). The default is arabic numbers. The other
types are HTML3.2 only and may not be supported by browsers yet.
Any list contents will do. Each of the items will be emitted
in HTML if they are themselves objects.
|
| |
- Method resolution order:
- OrderedList
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'class', 'id', 'style')
- tagname = 'OL'
Methods inherited from List:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes inherited from List:
- I_am_a_list = 1
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
PRE = class Pre(AbstractTag) |
| |
Render the text verbatim honoring line breaks and spacing.
Does not escape special characters. To override this set html_escape
to 'ON'.
|
| |
Data and other attributes defined here:
- attr_dict = {'width': ''}
- attr_template = '%(width)s'
- attrs = ('width',)
- html_escape = 'OFF'
- tagname = 'PRE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- trailer = '\n'
|
Para = class Paragraph(AbstractTag) |
| |
Define a Paragraph.
Takes a single string/object argument and the optional
keyword argument 'align' which may be one of (left, right,
center). As always, Class and style keywords are supported.
Not to be confused with class P. That is
just for inserting a para break.
Example:
Paragraph('Some text to center', align='center')
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = 'P'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Paragraph(AbstractTag) |
| |
Define a Paragraph.
Takes a single string/object argument and the optional
keyword argument 'align' which may be one of (left, right,
center). As always, Class and style keywords are supported.
Not to be confused with class P. That is
just for inserting a para break.
Example:
Paragraph('Some text to center', align='center')
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s'
- attrs = ('class', 'id', 'style', 'align')
- tagname = 'P'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Pre(AbstractTag) |
| |
Render the text verbatim honoring line breaks and spacing.
Does not escape special characters. To override this set html_escape
to 'ON'.
|
| |
Data and other attributes defined here:
- attr_dict = {'width': ''}
- attr_template = '%(width)s'
- attrs = ('width',)
- html_escape = 'OFF'
- tagname = 'PRE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- trailer = '\n'
|
STRONG = class Strong(AbstractTag) |
| |
Strongly emphasize the text.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'STRONG'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Sample(AbstractTag) |
| |
Sample text. Escaping of special characters is not performed.
To enable escaping set html_escape='ON'.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- html_escape = 'OFF'
- tagname = 'SAMP'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- trailer = '\n'
|
class Script |
| |
Construct a Script
Keyword Arguments
Defaults in (parenthesis). Keyword parameters may be set as attributes of
the instantiated script object as well.
language -- specifies the language ('JavaScript')
src -- specifies the location
code -- script code, which is printed in comments, to hide it from non
java-script browsers
|
| |
Methods defined here:
- __init__(self, **kw)
- __str__(self)
- append(self, s)
|
class Select(UserList.UserList) |
| |
Used to define a list widget or option widget.
Pass a list of strings to show a list with those values. Alternatively
can pass a list of tuple pairs. Each pair contains the displayed string
and it's associatated value mapping. If no value mapping is needed just
use something that evaluates to None.
Keyword Arguments:
name -- provides the datum name
size -- the visual size. 1 means use an option popup widget.
>=2 means use a list widget with that many lines.
multiple -- flag to indicate whether multiple selections are supported.
selected -- list of values to be shown as pre-selected.
onBlur -- script, which is executed, when the field loses focus
onChange -- script, which is executed, when the field value changed
onFocus -- script, which is executed, when the field receives focus
|
| |
- Method resolution order:
- Select
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- __init__(self, data=None, **kw)
- __str__(self)
Data and other attributes defined here:
- __abstractmethods__ = frozenset([])
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __getslice__(self, i, j)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- append(self, item)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class SeriesDocument(SimpleDocument) |
| |
Primary container class for an HTML document as part of a series.
Formerly known as Document().
Navigation mechanisms are provided.
Single optional string argument for the path to a resource file
used to specify document parameters. This helps minimize the need
for subclassing from this class. Keyword parameters may be used
for any of the following class attributes. See HTMLtest.py for
example usage.
Class instance attributes and keyword arguments
base -- object of the Base class
meta -- object of the Meta class
cgi -- if non zero will issue a mime type of text/html
logo -- ('filename', width, height) All images are specified
with a tuple of string, int, int. If the size of the
graphic is unknown, use 0, 0. This one is the little
graphic on the footer of each page.
banner -- ('filename', width, height) Banner graphic at
the top of page. Can also be set to a string filename
or an Image object. Can be autosized if it's a GIF.
title -- string to be used as the document title.
subtitle -- string to be used as the document subtitle.
If non-nil, this string will be used for the doc title
instead of title.
author -- String used in the copyright notice
email -- Email address for feedback mailto: tag
zone -- string used to label the time zone if datetime
is used. By default not used.
bgcolor -- Color string (can use variables from
HTMLcolors.py)
background -- string filename of a graphic used as the
doc background.
textcolor -- Color string used for text. (can use
variables from HTMLcolors.py)
linkcolor -- Color string used for hyperlinked text.
vlinkcolor -- Color string used for visited hypertext.
alinkcolor -- Color string used for active hypertext.
place_nav_buttons -- Flag to enable/disable the use of
navigation buttons.
Default is on. Set to 0 to disable.
blank -- Image tuple for the transparent spacer gif
prev -- Image tuple for the Previous Page button
next -- Image tuple for the Next Page button
top -- Image tuple for the Top of Manual button
home -- Image tuple for the site Home Page button
goprev -- URL string for the prev button
gonext -- URL string for the next button
gotop -- URL string for the top button
gohome -- URL string for the home button
script -- a single or list of Script objects to be included in the <HEAD>
onLoad -- Script, which is executed when the document is loaded
onUnload -- Script, which is executed when the document is unloaded
|
| |
- Method resolution order:
- SeriesDocument
- SimpleDocument
- BasicDocument
Methods defined here:
- __str__(self)
- footer(self)
- Generate the standard footer markups.
- header(self)
- Generate the standard header markups.
- nav_buttons(self)
- Generate hyperlinked navigation buttons.
If a self.go* attribute is null that corresponding button is
replaced with a transparent gif to properly space the remaining
buttons.
Data and other attributes defined here:
- author = 'Micky Mouse'
- banner = ('/image/banner.gif', 472, 30)
- blank = ('../image/blank.gif', 71, 19)
- email = 'micky@disney.com'
- gohome = None
- gonext = None
- goprev = None
- gotop = None
- home = ('../image/BTN_HomePage.gif', 74, 19)
- logo = ('/image/logo.gif', 36, 35)
- next = ('../image/BTN_NextPage.gif', 71, 19)
- place_nav_buttons = 'yes'
- prev = ('../image/BTN_PrevPage.gif', 71, 19)
- subtitle = None
- top = ('../image/BTN_ManualTop.gif', 74, 19)
- zone = ' Central US'
Methods inherited from SimpleDocument:
- __init__(self, resource=None, **kw)
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD TITLE and BODY tags.
Data and other attributes inherited from SimpleDocument:
- base = None
- meta = None
- onLoad = None
- onUnload = None
- script = None
- style = None
- stylesheet = None
Methods inherited from BasicDocument:
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes inherited from BasicDocument:
- alinkcolor = None
- background = None
- bgcolor = None
- cgi = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
class SimpleDocument(BasicDocument) |
| |
Supports all features of a self contained document.
This includes support for CSS1, meta and base tags, and embedded
scripts.
First constructor argument is resource file containing document
attribute settings.
|
| |
Methods defined here:
- __init__(self, resource=None, **kw)
- __str__(self)
- html_body_tag(self)
- Return BODY tag with attributes.
- html_head(self)
- Generate the HEAD TITLE and BODY tags.
Data and other attributes defined here:
- base = None
- meta = None
- onLoad = None
- onUnload = None
- script = None
- style = None
- stylesheet = None
Methods inherited from BasicDocument:
- append(self, *items)
- Add content to the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- append_file(self, filename, marker_function=None)
- Add the contents of a file to the document.
filename -- the filename of the file to be read [string]
marker_function -- a callable object which the text read from
the file will be passed through before being added to the
document.
- copy(self)
- Return a complete copy of the current Document object.
- prepend(self, *items)
- Add content to the beginning of the Document object.
Arg items can be plain text or objects; multiple arguments supported.
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument.
Data and other attributes inherited from BasicDocument:
- alinkcolor = None
- background = None
- bgcolor = None
- cgi = None
- linkcolor = None
- textcolor = None
- title = ''
- vlinkcolor = None
|
class Small(AbstractTag) |
| |
Render in a smaller font.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'SMALL'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Span(AbstractTag) |
| |
Generic tag to mark text for a style application.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'SPAN'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class Strike(AbstractTag) |
| |
The text is struck trough with a horizontal line.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'STRIKE'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class StringTemplate |
| |
Generate documents based on a template and a substitution mapping.
Must use Python 1.5 or newer. Uses re and the get method on dictionaries.
Usage:
T = TemplateDocument('Xfile')
T.substitutions = {'month': ObjectY, 'town': 'Scarborough'}
T.write('Maine.html')
A dictionary, or object that behaves like a dictionary, is assigned to the
substitutions attribute which has symbols as keys to objects. Upon every
occurance of these symbols surrounded by braces {} in the source template,
the corresponding value is converted to a string and substituted in the output.
For example, source text which looks like:
I lost my heart at {town} Fair.
becomes:
I lost my heart at Scarborough Fair.
Symbols in braces which do not correspond to a key in the dictionary remain
unchanged.
An optional third argument to the class is a list or two strings to be
used as the delimiters instead of { } braces. They must be of the same
length; for example ['##+', '##'] is invalid.
|
| |
Methods defined here:
- __getitem__(self, name)
- __init__(self, template, substitutions=None, **kw)
- __setitem__(self, name, value)
- __str__(self)
- keys(self)
- set_template(self, template)
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
Will not overwrite file is it exists and is textually the same.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument given.
|
class Strong(AbstractTag) |
| |
Strongly emphasize the text.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'STRONG'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Sub(AbstractTag) |
| |
Render as subscript.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'SUB'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Sup(AbstractTag) |
| |
Render as subscript.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'SUP'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class TD(AbstractTag) |
| |
Define a table data cell.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'background': '', 'bgcolor': '', 'bordercolor': '', 'bordercolordark': '', 'bordercolorlight': '', 'class': '', 'colspan': '', 'height': '', 'id': '', ...}
- attr_template = '%(class)s%(id)s%(style)s%(nowrap)s%(align)s%(val...owspan)s%(colspan)s%(height)s%(width)s%(bgcolor)s'
- attrs = ('class', 'id', 'style', 'nowrap', 'align', 'valign', 'background', 'bordercolor', 'bordercolordark', 'bordercolorlight', 'rowspan', 'colspan', 'height', 'width', 'bgcolor')
- tagname = 'TD'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class TH(AbstractTag) |
| |
Define a table header cell.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'background': '', 'bgcolor': '', 'bordercolor': '', 'bordercolordark': '', 'bordercolorlight': '', 'class': '', 'colspan': '', 'height': '', 'id': '', ...}
- attr_template = '%(class)s%(id)s%(style)s%(nowrap)s%(align)s%(val...dercolor)s%(bordercolordark)s%(bordercolorlight)s'
- attrs = ('class', 'id', 'style', 'nowrap', 'align', 'valign', 'rowspan', 'colspan', 'height', 'width', 'bgcolor', 'background', 'bordercolor', 'bordercolordark', 'bordercolorlight')
- tagname = 'TH'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class TR(AbstractTag) |
| |
Define a row of cells within a table.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'bgcolor': '', 'bordercolor': '', 'bordercolordark': '', 'bordercolorlight': '', 'class': '', 'id': '', 'nowrap': '', 'style': '', 'valign': ''}
- attr_template = '%(class)s%(id)s%(style)s%(align)s%(bgcolor)s%(bo...lordark)s%(bordercolorlight)s%(nowrap)s%(valign)s'
- attrs = ('class', 'id', 'style', 'align', 'bgcolor', 'bordercolor', 'bordercolordark', 'bordercolorlight', 'nowrap', 'valign')
- tagname = 'TR'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class TT(AbstractTag) |
| |
Format teletype style.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'TT'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class Table |
| |
Construct a Table with Python lists.
Instantiate with a string argument for the table's name (caption).
Set object.heading to a list of strings representing the column headings.
Set object.body to a list of lists representing rows. WARNING: the body
attribute will be edited to conform to html. If you don't want your
data changed make a copy of this list and use that with the table object.
Keyword Parameters
Defaults in (parenthesis). Keyword parameters may be set as attributes of the
instantiated table object as well.
caption_align -- 'top'|'bottom' specifies the location of the table title ('top')
border -- the width in pixels of the bevel effect around the table (2)
cell_padding -- the distance between cell text and the cell boundary (4)
cell_spacing -- the width of the cell borders themselves (1)
width -- the width of the entire table wrt the current window width ('100%')
colspan -- a list specifying the number of columns spanned by that heading
index. e.g. t.colspan = [2,2] will place 2 headings spanning
2 columns each (assuming the body has 4 columns).
heading -- list of strings, the length of which determine the number of
columns. ( [' ']*3 )
heading_align -- 'center'|'left'|'right'
horizontally align text in the header row ('center')
heading_valign -- 'middle' |'top'|'bottom'
vertically align text in the header row ('middle')
body_color -- a list of colors, for each column (None)
heading_color -- a list of color for each column heading (None)
For both these the index used is i%len(..._color) so
the color cycles through the columns
body -- a list of lists in row major order containing strings or objects
to populate the body of the table. ( [[' ']*3] )
column1_align -- 'left'|'right'|'center' text alignment of the first column
cell_align -- 'left'|'right'|'center' text alignment for all other cells
cell_line_breaks -- 1|0 flag to determine if newline char in body text will be
converted to <br> symbols; 1 they will, 0 they won't. (1)
|
| |
Methods defined here:
- __init__(self, tabletitle='', **kw)
- Arg1 is a string title for the table caption, optional keyword
arguments follow.
- __str__(self)
- Generates the html for the entire table.
- get_body_color(self, colors, i)
- Return bgcolor argument for column number i
|
class TableLite(AbstractTag) |
| |
Container class for TH TD TR and Caption objects.
|
| |
Data and other attributes defined here:
- attr_dict = {'align': '', 'background': '', 'bgcolor': '', 'border': '', 'bordercolor': '', 'bordercolordark': '', 'bordercolorlight': '', 'cellpadding': '', 'cellspacing': '', 'class': '', ...}
- attr_template = '%(class)s%(id)s%(style)s%(align)s%(background)s%...(bgcolor)s%(nowrap)s%(rules)s%(valign)s%(vspace)s'
- attrs = ('class', 'id', 'style', 'align', 'background', 'border', 'bordercolor', 'bordercolordark', 'bordercolorlight', 'cols', 'frame', 'cellpadding', 'cellspacing', 'height', 'hspace', 'width', 'bgcolor', 'nowrap', 'rules', 'valign', ...)
- tagname = 'TABLE'
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
- trailer = '\n'
|
class TemplateDocument(StringTemplate) |
| |
Generate documents based on a template and a substitution mapping.
Must use Python 1.5 or newer. Uses re and the get method on dictionaries.
Usage:
T = TemplateDocument('Xfile')
T.substitutions = {'month': ObjectY, 'town': 'Scarborough'}
T.write('Maine.html')
A dictionary, or object that behaves like a dictionary, is assigned to the
substitutions attribute which has symbols as keys to objects. Upon every
occurance of these symbols surrounded by braces {} in the source template,
the corresponding value is converted to a string and substituted in the output.
For example, source text which looks like:
I lost my heart at {town} Fair.
becomes:
I lost my heart at Scarborough Fair.
Symbols in braces which do not correspond to a key in the dictionary remain
unchanged.
An optional third argument to the class is a list or two strings to be
used as the delimiters instead of { } braces. They must be of the same
length; for example ['##+', '##'] is invalid.
|
| |
Methods defined here:
- set_template(self, template)
Methods inherited from StringTemplate:
- __getitem__(self, name)
- __init__(self, template, substitutions=None, **kw)
- __setitem__(self, name, value)
- __str__(self)
- keys(self)
- write(self, filename=None)
- Emit the Document HTML to a file or standard output.
Will not overwrite file is it exists and is textually the same.
In Unix you can use environment variables in filenames.
Will print to stdout if no argument given.
|
class Text |
| |
Class to encapsulate text. Escape special characters for HTML.
|
| |
Methods defined here:
- __init__(self, text='')
- __str__(self)
- append(self, text='')
- Concatenate text characters onto the end.
Will escape special characters.
|
class Textarea |
| |
Used for an entry widget to type multi-line text (for forms).
Keyword Arguments:
rows -- sets the number of text rows. (default=4)
cols -- sets the number of text columns. (default=40)
onBlur -- script, which is executed, when the field loses focus
onChange -- script, which is executed, when the field value changed
onFocus -- script, which is executed, when the field receives focus
onSelect -- script, which is executed, when part of the field
is selected
|
| |
Methods defined here:
- __init__(self, text='', **kw)
- __str__(self)
|
Typewriter = class TT(AbstractTag) |
| |
Format teletype style.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'TT'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
class U(AbstractTag) |
| |
Underlined text.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'U'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
|
UL = class List(UserList.UserList) |
| |
Will generate a bulleted list given a list argument.
Now supports rendering a list into multiple columns by setting the
columns attribute to a number greater than one. This is
implemented using tables and you can also set a background color
for the list itself by using the bgcolor attribute.
Supports nested lists, i.e. lists of lists. Each time a list is
encountered in a list it will indent those contents w.r.t. the
prior list entry. This can continue indefinitely through nested
lists although there are only three different bullets provided by
the browser (typically).
Optional keyword indent can be used to indicate whether you want
the list to start left justified or indented. indent=0 will make
it left justified. The default is to indent.
Optional keyword type can be set to either disk, circle, or
square to specify what kind of symbol is used for each list item's
bullet. (Netscape extension)
Since we inherit from the UserList class any normal list
operations work on instances of this class. Any list contents
will do. Each of the items will be emitted in html if they are
themselves objects from this module.
Aliases: UL, BulletList
|
| |
- Method resolution order:
- List
- UserList.UserList
- _abcoll.MutableSequence
- _abcoll.Sequence
- _abcoll.Sized
- _abcoll.Iterable
- _abcoll.Container
- __builtin__.object
Methods defined here:
- __getslice__(self, i, j)
- __init__(self, list=None, **kw)
- __str__(self)
- append(self, *items)
- Append entries to the end of the list
- column_slices(self, columns=1)
- Calculate a list of index pairs bounding column slices.
- end_element(self)
- Closes the HTML element
- multi_column_table(self)
- Return a table containing the list sliced into columns.
- render_list_item(self, item)
- Renders the individual list items
Overloaded by child classes to represent other list styles.
- start_element(self)
- Generic creator for the HTML element opening tag.
Reads tagname, attrs and flags to return appropriate tag.
- sub_list(self, list)
- Recursive method for generating a subordinate list
Data and other attributes defined here:
- I_am_a_list = 1
- __abstractmethods__ = frozenset([])
- attrs = ('type', 'align', 'class', 'id', 'style')
- bgcolor = ''
- columns = 1
- flags = ('compact',)
- indent = 1
- pad = ' '
- tagname = 'UL'
Methods inherited from UserList.UserList:
- __add__(self, other)
- __cmp__(self, other)
- __contains__(self, item)
- __delitem__(self, i)
- __delslice__(self, i, j)
- __eq__(self, other)
- __ge__(self, other)
- __getitem__(self, i)
- __gt__(self, other)
- __iadd__(self, other)
- __imul__(self, n)
- __le__(self, other)
- __len__(self)
- __lt__(self, other)
- __mul__(self, n)
- __ne__(self, other)
- __radd__(self, other)
- __repr__(self)
- __rmul__ = __mul__(self, n)
- __setitem__(self, i, item)
- __setslice__(self, i, j, other)
- count(self, item)
- extend(self, other)
- index(self, item, *args)
- insert(self, i, item)
- pop(self, i=-1)
- remove(self, item)
- reverse(self)
- sort(self, args, *kwds)
Data and other attributes inherited from UserList.UserList:
- __hash__ = None
Methods inherited from _abcoll.Sequence:
- __iter__(self)
- __reversed__(self)
Class methods inherited from _abcoll.Sized:
- __subclasshook__(cls, C) from abc.ABCMeta
Data descriptors inherited from _abcoll.Sized:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from _abcoll.Sized:
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class URL |
| |
Represent a Universal Resource Locator.
Assumed to be of the form: http://www.node.edu/directory/file.html
with http* being an example protocol, *www.node.edu being an example
network node, directory being the directory path on that node, and
file.html being the target filename. The argument string is parsed
into attributes .proto , .node , .dir , .file respectively and may
be altered individually after instantiation. The __str__ method
simply reassembles the components into a full URL string.
|
| |
Methods defined here:
- __init__(self, url)
- __str__(self)
- copy(self)
- No argument. Return a copy of this object.
- parse(self, url)
- split(self, p)
- Same as posixpath.split()
Copied here for availability on the Mac.
|
class Var(AbstractTag) |
| |
Used for variable names.
|
| |
Data and other attributes defined here:
- attr_dict = {'class': '', 'id': '', 'style': ''}
- attr_template = '%(class)s%(id)s%(style)s'
- attrs = ('class', 'id', 'style')
- tagname = 'VAR'
- trailer = ''
Methods inherited from AbstractTag:
- __add__(self, other)
- Support self + list
- __call__(self, text)
- Enable instances to be callable as text processing functions.
For Example:
>>> S = HTMLgen.Strong()
>>> print S('Hi!')
>>> <STRONG>Hi!</STRONG>
- __init__(self, contents, *kw)
- __len__(self)
- Return the integer length of the container list.
- __setattr__(self, name, value)
- Intercept attribute assignments.
If the attribute is a legal HTML tag attribute add it to the
dict used for substitution in __str__, otherwise just set it as
an instance attribute.
- __str__(self)
- Generate an HTML formatted string for this object.
- append(self, *items)
- Append one or more items to the end of the container.
- copy(self)
- Return a full copy of the object.
- empty(self)
- Empty the contents of the container.
- last(self)
- Return a reference to the last item in the container.
- markup(self, rex=None, marker=None, **kw)
- Markup the contained text matching a regular expression with
a tag class instance or function.
Arguments
rex -- a regular expression object or pattern which will be used
to match all text patterns in the Paragraph body. Must have a single
group defined. Group 1 is the matching text that will be marked.
Default to all parenthetical text.
marker -- an HTMLgen class instance to which the found text will
be sent for wrapping (using its __call__ method). Default is Emphasis.
Keywords
collapse -- When set to 1 removes the non-grouped matching text
from the output. Default 0.
Returns the number of matching text groups.
- prepend(self, *items)
- Prepend one or more items to the top of the container.
Data and other attributes inherited from AbstractTag:
- html_escape = 'ON'
| |