polyspace.project.CodeInfo Class

Namespace: polyspace.project

(Python) Store information about types, functions, and globals in parsed source code

Since R2025a

Description

This Python^® class contains information about data types, functions, and global variables in your source code. When authoring tests using the Polyspace^® Test™ Python API, create an object of this class. Then use the information stored in this object to create test data, parameters, and steps.

Creation

Syntax

codeInfo = polyspace.project.parseCode(proj)

Description

codeInfo = polyspace.project.parseCode(proj) parses the source code in the project proj and stores information about data types, functions, and global variables in the polyspace.project.CodeInfo object codeInfo. For extensions of this syntax, see polyspace.project.parseCode.

If an error occurs during code parsing, the function throws an exception of type polyspace.ErrorWithLog. (since R2026a)

Input Arguments

proj — Polyspace Platform project

polyspace.project.Project object

Polyspace Platform project, specified as a polyspace.project.Project object.

Properties

ParseLog — Parse log information

polyspace.ExecutionLog object

Since R2026a

Parse log information, returned as a polyspace.ExecutionLog object.

This polyspace.ExecutionLog object has the following property:

Property	Description
Content	Parse log content, specified as a single string. To display the parse log string from a polyspace.project.CodeInfo object codeInfo in a human readable format, enter: print(codeInfo.ParseLog.Content)

To save the run log content to a file, use the save() method. For instance, to save the error string from a polyspace.project.CodeInfo object codeInfo to a file logs.txt, enter:

codeInfo.ParseLog.save("logs.txt")

Note

This property contains the logs from a successful code parsing. If an error occurs during code parsing, the polyspace.project.parseCode() function throws an exception of type polyspace.ErrorWithLog. Catch this exception in an except block to see the error log content. For more information, see polyspace.ErrorWithLog.

Functions — List of functions in source code

list of polyspace.project.Function values

Functions in the source code, specified as a list of polyspace.project.Function objects. Each object in this list has the following properties.

Property	Value	Description
Name	str value	Name of the function. For example, "saturate_value".
Signature	str value	Signature of the function. For example, "int saturate_value(int)".
StubbingSupport	True or False	Whether the function is undefined and requires a stub.
IsStub	True or False	Whether the function has a stub in an external stub file. This property is set to True only if a function stub is sourced from an external C/C++ file. It is set to False if the function is stubbed with a project-specific polyspace.project.FunctionStub object.
MockingSupport	True or False	Whether the function is supported for mocking.
TestingSupport	True or False	Whether the function is supported for testing.

Globals — List of globals in source code

list of polyspace.project.Global values

Global variables in the source code, specified as a list of polyspace.project.Global objects. Each object in the list contains the following properties.

Property	Value	Description
Name	str value	Name of the global variable.
StubbingSupport	True or False	Whether the variable is undefined and requires a stub.
IsStub	True or False	Whether the variable has a stub in an external stub file. This property is set to True only if a variable stub is sourced from an external C/C++ file. It is set to False if the variable is stubbed with a project-specific polyspace.project.VariableStub object.

Types — List of data types in source code

list of polyspace.project.Type values

Data types in the source code, specified as a list of polyspace.project.Type objects. Each object in the list contains the following properties.

Property	Value	Description
Name	str value	Name of the data type.

Examples

Find Undefined Functions and Variables

Import the required modules, create a project, and add the source files.

## Import modules
import polyspace.project
import os

## Create project
examples_path = os.path.join(polyspace.__install_path__, "polyspace", 
                            "examples", "doc_pstest", "getting_started_test_manager")

proj = polyspace.project.Project("parseProject.psprjx")

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

Parse the code to get information about the source code in the project proj.

codeInfo = polyspace.project.parseCode(proj)

Identify undefined functions in the project. Use the StubbingSupport property of each polyspace.project.Function object to create a list of functions that require a stub.

undefinedFuncList = [f for f in codeInfo.Functions if f.StubbingSupport]

Identify undefined variables in the project. Use the StubbingSupport property of each polyspace.project.Global object to create a list of variables that require a stub.

undefinedVarList = [v for v in codeInfo.Globals if v.StubbingSupport]

Once you identify the undefined functions and variables, you can create stubs for them in one of these ways:

• Use external stub files — Create C or C++ stub files that contain default or custom definitions for one or more of the undefined callees and add it to the project. For more information see polyspace.project.Stubs.

• Use project-specific stubs — Create default or custom project-specific stubs for your functions and variables using polyspace.project.FunctionStubs and polyspace.project.VariableStubs, respectively. For more information see polyspace.project.Project, polyspace.project.FunctionStub, and polyspace.project.VariableStub.

Methods

Public Methods

Method	Description
getFunctionBySignature()	Returns the polyspace.project.Function object for the function with a specified signature. You can specify the signature either with or without the argument names. All names and types that you use in this signature must be qualified with namespaces. Examples: functionSaturateValue = codeInfo.getFunctionBySignature("int saturate_value(int)") functionToTest = codeInfo.getFunctionBySignature("int saturate_value(int value)")
getGlobalByName()	Returns the polyspace.project.Global object for a global variable with a specified name. The global variable name you supply to this method must be qualified with the namespace. Example: minValue = codeInfo.getGlobalByName("minValue")
getType()	Returns the polyspace.project.Type object for a data type with a specified name. The type name you supply to this method must be qualified with the namespace. Example: intType = codeInfo.getType("int") You can also use this function to create an array type, which you use to create test data for pointer targets. Example: arrayType = codeInfo.getType("int[4]")

Version History

Introduced in R2025a

R2026a: New property that supports reading parse logs

Starting in R2026a, a polyspace.project.CodeInfo object contains a ParseLog property with a Content subproperty that contains logs from the code parsing as a string.