epydoc.util

wordwrap(str, indent=0, right=75, startindex=0, splitchars=`''`)

Word-wrap the given string. I.e., add newlines to the string such that any lines that are longer than right are broken into shorter lines (at the first whitespace sequence that occurs before index right). If the given string contains newlines, they will not be removed. Any lines that begin with whitespace will not be wordwrapped.

Parameters:

indent (int) - If specified, then indent each line by this number of spaces.
right (int) - The right margin for word wrapping. Lines that are longer than right will be broken at the first whitespace sequence before the right margin.
startindex (int) - If specified, then assume that the first line is already preceeded by startindex characters.
splitchars - A list of non-whitespace characters which can be used to split a line. (E.g., use '/\' to allow path names to be split over multiple lines.)

Returns: str

plaintext_to_html(s)

source code
call graph

Returns: string: An HTML string that encodes the given plaintext string. In particular, special characters (such as '<' and '&') are escaped.

plaintext_to_latex(str, nbsp=0, breakany=0)

source code

Parameters:

breakany - Insert hyphenation marks, so that LaTeX can break the resulting string at any point. This is useful for small boxes (e.g., the type box in the variable list table).
nbsp - Replace every space with a non-breaking space ('~').

Returns: string

A LaTeX string that encodes the given plaintext string. In particular, special characters (such as '$' and '_') are escaped, and tabs are expanded.

run_subprocess(cmd, data=True)

source code
call graph

Execute the command cmd in a subprocess.

Parameters:

cmd - The command to execute, specified as a list of string.
data - A string containing data to send to the subprocess.

Returns:

A tuple (out, err).

Raises:

OSError - If there is any problem executing the command, or if its exitval is not 0.

Module util

decode_with_backslashreplace(s)

wordwrap(str, indent=0, right=75, startindex=0, splitchars=`''`)

plaintext_to_html(s)

plaintext_to_latex(str, nbsp=0, breakany=0)

run_subprocess(cmd, data=True)

Module util

decode_with_backslashreplace(s)

wordwrap(str, indent=0, right=75, startindex=0, splitchars='')

plaintext_to_html(s)

plaintext_to_latex(str, nbsp=0, breakany=0)

run_subprocess(cmd, data=True)

wordwrap(str, indent=0, right=75, startindex=0, splitchars=`''`)