CompileNote#

Import

from scenet import CompileNote

Defined in

scenet.pipeline (source)

Install

pip install scenet

Since

0.13

Stability

Public: follows semantic versioning. Below 1.0, a minor release may change it, and the CHANGELOG says how.

class scenet.pipeline.CompileNote[source]#

Bases: object

Something the compiler decided that the source did not literally ask for.

rule#

What kind of decision it was, by its stable name.

Type:

Literal['camera-retreated', 'curved-tail', 'cropped-mouth', 'cropped-marks', 'inset-covers-face', 'slant-cuts-face', 'italic-stand-in', 'bold-italic-stand-in']

message#

The sentence that says so, as CompileResult.notes gives it.

Type:

str

Example

>>> from scenet import CompileNote, compile_source
>>> result = compile_source(
...     "{panel: {size: [600.0, 400.0]}, camera: {shot: close_up},"
...     " cast: {a: {reference: alice, at: left_edge},"
...     " b: {reference: bob, at: right_edge}}}"
... )
>>> [note.rule for note in result.compile_notes][:1]
['camera-retreated']

See also

CompileResult.notes, the messages alone.

__init__(rule, message)#