CodeOutputProxy

class abjadbooktools.CodeOutputProxy(payload, code_block_specifier=None)

A code output proxy.

>>> from abjad.tools import abjadbooktools
>>> proxy = abjadbooktools.CodeOutputProxy([
...     ">>> print('Hello, world!')",
...     'Hello, world!',
...     '>>> 1 + 1',
...     '2',
...     ])
>>> print(format(proxy))
abjadbooktools.CodeOutputProxy(
    (
        ">>> print('Hello, world!')",
        'Hello, world!',
        '>>> 1 + 1',
        '2',
        )
    )
>>> for line in proxy.as_latex():
...     line
...
'\\begin{lstlisting}'
">>> print('Hello, world!')"
'Hello, world!'
'\\end{lstlisting}'
'\\begin{lstlisting}'
'>>> 1 + 1'
'2'
'\\end{lstlisting}'

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_abjadbooktools { graph [label=abjadbooktools]; "abjad.tools.abjadbooktools.CodeOutputProxy.CodeOutputProxy" [color=black, fontcolor=white, group=1, label=<<B>CodeOutputProxy</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=3, group=2, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.abjadbooktools.CodeOutputProxy.CodeOutputProxy"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

as_docutils([configuration, output_directory]) Creates a docutils node representation of the code output proxy.
as_latex([configuration, output_directory, …]) Creates a LaTeX representation of the code output proxy.
code_block_specifier Gets code block specifier.
payload Gets code output proxy payload.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

CodeOutputProxy.code_block_specifier

Gets code block specifier.

CodeOutputProxy.payload

Gets code output proxy payload.

Returns tuple of strings.

Methods

CodeOutputProxy.as_docutils(configuration=None, output_directory=None)

Creates a docutils node representation of the code output proxy.

Returns list of docutils nodes.

CodeOutputProxy.as_latex(configuration=None, output_directory=None, relative_output_directory=None)

Creates a LaTeX representation of the code output proxy.

Returns list of strings.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.