CodeBlock

class abjadbooktools.CodeBlock(input_file_contents, code_block_specifier=None, document_source=None, executed_lines=None, image_layout_specifier=None, image_render_specifier=None, starting_line_number=None)

A code block.

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.CodeBlock.CodeBlock" [color=black, fontcolor=white, group=1, label=<<B>CodeBlock</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.CodeBlock.CodeBlock"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

as_docutils([configuration, output_directory])
as_latex([configuration, output_directory, ...])
code_block_specifier
current_lines
document_source
executed_lines
filter_output_proxies()
flush()
from_docutils_abjad_import_block(block)
from_docutils_abjad_input_block(block)
from_docutils_literal_block(block)
from_latex_abjad_block(input_file_contents)
from_latex_abjadextract_block(source_line[, ...])
graph(argument[, layout, graph_attributes, ...]) Proxies Abjad’s toplevel graph() function.
image_layout_specifier
image_render_specifier
input_file_contents
interpret(console)
output_proxies
play(argument) Proxies Abjad’s toplevel play() function.
print(*arguments, **keywords) Proxies Python’s builtin print() function.
push_asset_output_proxy(asset_output_proxy)
push_code_output_proxy()
push_line_to_console(line, console, line_number)
quit() Proxies Python’s builtin quit() function.
setup_capture_hooks(console)
show(argument[, return_timing]) Proxies Abjad’s toplevel show() function.
starting_line_number
write(string)
__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

CodeBlock.code_block_specifier
CodeBlock.current_lines
CodeBlock.document_source
CodeBlock.executed_lines
CodeBlock.image_layout_specifier
CodeBlock.image_render_specifier
CodeBlock.input_file_contents
CodeBlock.output_proxies
CodeBlock.starting_line_number

Methods

CodeBlock.as_docutils(configuration=None, output_directory=None)
CodeBlock.as_latex(configuration=None, output_directory=None, relative_output_directory=None)
CodeBlock.filter_output_proxies()
CodeBlock.flush()
CodeBlock.graph(argument, layout='dot', graph_attributes=None, node_attributes=None, edge_attributes=None, **keywords)

Proxies Abjad’s toplevel graph() function.

CodeBlock.interpret(console)
CodeBlock.play(argument)

Proxies Abjad’s toplevel play() function.

CodeBlock.print(*arguments, **keywords)

Proxies Python’s builtin print() function.

Proxying print() is necessary because the original print function makes multiple calls to sys.stdout.write() rather than one. In the context of abjad-book code block interpretation, each write operation adds a new line, hence the necessity of joining the print() arguments into a single string and then writing that.

Note that this will produce unexpected results if attempting to do fancy operations like overwriting the current line.

CodeBlock.push_asset_output_proxy(asset_output_proxy)
CodeBlock.push_code_output_proxy()
CodeBlock.push_line_to_console(line, console, line_number)
CodeBlock.quit()

Proxies Python’s builtin quit() function.

CodeBlock.setup_capture_hooks(console)
CodeBlock.show(argument, return_timing=False, **keywords)

Proxies Abjad’s toplevel show() function.

CodeBlock.write(string)

Class & static methods

static CodeBlock.from_docutils_abjad_import_block(block)
static CodeBlock.from_docutils_abjad_input_block(block)
static CodeBlock.from_docutils_literal_block(block)
static CodeBlock.from_latex_abjad_block(input_file_contents, starting_line_number=None, **options)
static CodeBlock.from_latex_abjadextract_block(source_line, starting_line_number=None, **options)

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.