Skip to main content

export_physical_connection_layer_json_rpath

Kind: Function
Domain: Physical connections
Canonical import: from cadflow import export_physical_connection_layer_json_rpath

Signature

def export_physical_connection_layer_json_rpath(layer: 'PhysicalConnectionLayer', path: 'str | Path', *, indent: 'Optional[int]' = 2) -> 'Path'

Description

Public function in the CadFlow physical connections API.

Other public imports

  • from cadflow.physical import export_physical_connection_layer_json_rpath

Parameters

NameTypeRequiredDefaultSource description
layer'PhysicalConnectionLayer'yes-Not explicitly described in the source docstring.
path'str | Path'yes-Not explicitly described in the source docstring.
indent'Optional[int]'no2Not explicitly described in the source docstring.

Returns

Type: 'Path'

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.
  • Serialized data is intended to remain JSON-safe and should be schema-validated when crossing trust boundaries.

Import check

from cadflow import export_physical_connection_layer_json_rpath

See also