The API for the modules in the beta scope may change without notice. The implementation of these modules is stable but the API may still change. They will move to global scope when the API is stable. To import these modules add a beta. prefix to the module name (e.g. beta.xpath).

The current RaptorXML Python API version is 2.6 (default for --script-api-version in release 2019).
The default RaptorXML Python API version is always the current version at the time of the release.
For Python callback scripts a different RaptorXML Python API version may be chosen by the --script-api-version command line option.
For the custom interpreter raptorxml-python the RaptorXML Python API major version can be selected through the importaltova_api.v1 or importaltova_api.v2 Python statements.

document-set of type list containing xml.Instance objects that represent the XML Infoset of the Inline XBRL Document Set documents

target-documents of type dict containing xml.Instance objects indexed by the target property or None if the Inline XBRL transformation failed

A Python script file is specified with the --script option on the command line.
In case of failed validation the errors are stored in xml.Job.error_log.
Script parameters for the above callback functions can be specified on the command line using the --script-param="KEY:VALUE" option.
The --script-param option can be specified multiple times. The specified script parameters are accessible in the xml.Job.script_params dictionary.