polyspace.project.BuildConfigurationRef Class

R2026b

Namespace: polyspace.project

(Python) Manage references from project to external build configurations

Since R2026a

expand all in page

Description

This Python® class contains information about an external build configuration that is saved in a separate file, referenced by a Polyspace® Platform project. Polyspace supports two file formats for external configurations: the native JSON-based format (.pscfg) and the human-readable TOML format (.toml.pscfg). Saving your build configurations in external files and referencing those files from one or more projects enables you to create a modular project structure that improves sharing and version control workflows. For more information about project structure, see Modularize Project by Using External Configurations, Test References, and External Stub Files.

To work with external build configurations, use this class, which contains the name of the build configuration and the path to the external configuration file where it is saved, together with the polyspace.project.BuildConfiguration class, which contains the build configuration.

To work with build configurations that are attached to a specific project, see polyspace.project.OwnedBuildConfiguration.

Creation

Syntax

buildConfigRef = proj.BuildConfigurationRefs.add(buildConfig, buildConfigRefName)
buildConfigRef = proj.BuildConfigurationRefs.add(buildConfigRefObj)
buildConfigRef = proj.BuildConfigurationRefs.add(buildConfigRefObj, buildConfigRefName)
buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile)
buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile, buildConfigRefName)
buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile, configFileFormat)

Description

Import Configuration by Reference

buildConfigRef = proj.BuildConfigurationRefs.add(buildConfig, buildConfigRefName) adds a reference from the project to the build configuration buildConfig, which is an existing external configuration file (.pscfg or .toml.pscfg) or a polyspace.project.BuildConfiguration object. The Name property of the resulting polyspace.project.BuildConfigurationRef object is set to buildConfigRefName.

buildConfigRef = proj.BuildConfigurationRefs.add(buildConfigRefObj) adds a reference from the project to an existing polyspace.project.BuildConfigurationRef object buildConfigRefObj and inherits the configuration name.

buildConfigRef = proj.BuildConfigurationRefs.add(buildConfigRefObj, buildConfigRefName) adds a reference from the project to an existing polyspace.project.BuildConfigurationRef object buildConfigRefObj. Use the buildConfigRefName argument to set the Name property of the resulting buildConfigRef object.

Convert Configuration

buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile) converts the existing ownedBuildConfigObj to a polyspace.project.BuildConfigurationRef object in the same project. After conversion, the project references the external configuration saved in buildConfigFile. You can specify buildConfigFile as an absolute or relative path, where relative paths are considered relative to the location of the .psprjx project file. The resulting polyspace.project.BuildConfigurationRef object has its Path property set to buildConfigFile and its Name property is inherited from the owned build configuration.

example

buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile, buildConfigRefName) converts the existing ownedBuildConfigObj to a polyspace.project.BuildConfigurationRef object in the same project. After conversion, the project references the external configuration saved in buildConfigFile. You can specify buildConfigFile as an absolute or relative path, where relative paths are considered relative to the location of the .psprjx project file. The resulting polyspace.project.BuildConfigurationRef object has its Path property set to buildConfigFile and its Name property is set by the buildConfigRefName argument you provide.

buildConfigRef = proj.BuildConfigurationRefs.moveAsRef(ownedBuildConfigObj,buildConfigFile, configFileFormat) converts the existing ownedBuildConfigObj to a polyspace.project.BuildConfigurationRef object in the same project and saves the external configuration in the format specified by configFileFormat.

Input Arguments

expand all

Build configuration to add a reference to from the project, specified as a polyspace.project.BuildConfiguration object or a path to an existing external configuration file (.pscfg or .toml.pscfg).

Name to assign the referenced build configuration, specified as a string. This argument sets the Name property of the polyspace.project.BuildConfigurationRef object.

Existing buildConfigRefObj to add a reference to from the project, specified as a polyspace.project.BuildConfigurationRef object.

Existing owned build configuration to convert to an external configuration and reference from the project, specified as a polyspace.project.OwnedBuildConfiguration object.

Build configurations created from a build command (using polyspace-configure) or from Polyspace for AUTOSAR workspaces cannot be converted to external configurations. To save a copy of these configurations to a file, use the export() method. See polyspace.project.OwnedBuildConfiguration.

Relative or absolute path of the external configuration file to create when converting an existing owned build configuration to an external configuration, referenced by the project. You can include a file extension as part of the buildConfigFile argument to specify the file format to create: use .pscfg to create the file in native format, or .toml.pscfg to create the file in the full TOML format. Alternatively, do not include an extension in the buildConfigFile argument, and use the configFileFormat argument to specify the file format. Relative paths are considered relative to the location of the .psprjx project file.

Format of the configuration file to create, specified as one of:

  • FileFormat.NATIVE — original, JSON-based file.

  • FileFormat.TOML_FULL — TOML file containing all configuration values, including defaults.

  • FileFormat.TOML_CONCISE — TOML file containing only non-default values.

To use FileFormat as an argument, you must first import it from polyspace.project:

from polyspace.project import FileFormat
If you do not import it, use the full syntax when specifying the argument. For example, 
polyspace.project.FileFormat.TOML_FULL

Properties

expand all

Name of the referenced external build configuration, specified as a string. If you do not specify a Name argument, the name defaults to that of the existing build configuration you are adding or converting.

Path to the .pscfg or .toml.pscfg file where the referenced external build configuration is saved, specified as a string. All relative paths are considered relative to the location of the .psprjx project file.

Methods

expand all

Examples

collapse all

Modularize a Polyspace Platform project by converting an owned build configuration to an external configuration, referenced by the project. An external configuration is a build, static analysis, or testing and profiling configuration that is saved in a .pscfg or .toml.pscfg file that is referenced by the project.

Create the project, add your source files, and parse the code.

## Import modules
import polyspace.project
import polyspace.test
import os

## Create project
examples_path = os.path.join(polyspace.__install_path__, "polyspace", 
                            "examples", "doc_pstest", "python_api_test_authoring")
proj = polyspace.project.Project("externalConfigProject.psprjx")

## Add source files and include headers
proj.Code.Files.add(os.path.join(examples_path, "src", "algo.c"))
proj.Code.Files.add(os.path.join(examples_path, "src", "saturate.c"))
proj.IncludePaths.add(os.path.join(examples_path, "src"))

## Save project and parse code
proj.save()
codeInfo = polyspace.project.parseCode(proj)

Convert the existing build configuration to an external configuration, referenced by the project using the moveAsRef method.

# Convert the configuration 
buildConfig = proj.BuildConfigurations[0]   
proj.BuildConfigurationRefs.moveAsRef(buildConfig, "externalBuildConfig.pscfg")

# Alternatively, convert to full TOML using: 
# proj.BuildConfigurationRefs.moveAsRef(buildConfig, "externalBuildConfig.toml.pscfg")

When you convert a configuration that is active in a project, Polyspace updates the active configuration accordingly. Check the active build configuration for the project, then save and build the project.

proj.ActiveBuildConfiguration
proj.save()
status = polyspace.test.build(proj)

Version History

Introduced in R2026a

expand all

See Also

| | | | |

Topics