export_scene
Kind: Function
Domain: Scene and artifacts
Canonical import: from cadflow import export_scene
Signature
def export_scene(*, package: 'CompiledScenePackage', path: 'str | os.PathLike[str]') -> 'None'
Description
Public function in the CadFlow scene and artifacts API.
Other public imports
from cadflow.scene import export_scene
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
package | 'CompiledScenePackage' | yes | - | Not explicitly described in the source docstring. |
path | 'str | os.PathLike[str]' | yes | - | Not explicitly described in the source docstring. |
Returns
Type: 'None'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- This operation writes an external artifact. Validate the returned path or output file before delivery.
Import check
from cadflow import export_scene