render_to_dorico
Render a ScoreSpec at the caret in Dorico, or preview the command plan without sending to verify before execution.
Instructions
Render a ScoreSpec through the caret path, or plan it without sending.
The lower half of write_score, exposed on its own for the two cases where that
matters: seeing the command plan before it runs, and skipping the preflight
checks and the MusicXML option that write_score adds on top.
Returns:
Result dictionary with the command plan when dry_run is true, or the
execution outcome when it is false.
Note:
Prefer write_score for ordinary composition: it runs the range and voice
leading checks first and can take the MusicXML path when a key or time
signature is needed. Come here to inspect what would be sent, or when the
caret path is specifically what is wanted.
With dry_run true this is a read: nothing is dispatched and Dorico need not
even be running.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| score | Yes | The score to work on, as a ScoreSpec object: metadata, parts, and the events inside them. Call score_schema first for the exact shape, which refuses unknown keys rather than ignoring them. | |
| dry_run | No | True plans the commands and returns them without sending any, which changes nothing in Dorico and needs no connection to it. False dispatches them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||