get_setting_dependencies(...) - get_setting_dependencies(...) - 2026.1 English - UG1781

Python Scripting Guide for PDM Tool (UG1781)

Document_ID
UG1781
Release_Date
2026-06-23
Version
2026.1 English
Revision

Description

Get IP settings sub-dictionary template, showing the structure of specified setting dependencies with all values initialized to zero or an empty string, alternatively, if the flag is enabled, a list of setting paths that the specified path depends on - ordered from independent to dependent paths.

Syntax

get_setting_dependencies(<setting_path>, paths=False)

Returns

Sub-dictionary of IP settings or a list of corresponding setting paths.

Parameters

Name Description
<setting_path> IP setting path - a list of hierarchical dictionary keys.

For example, ['fec_only_bw'] and ['port2', 'data_rate'] are MRMAC setting paths.

[paths] Enables returning a list of setting paths in the dependency order if True, otherwise, the corresponding settings sub-dictionary template.

For example, {'port1': {'data_rate': 0, 'line_rate': ''}, {'fec_only_bw': ''}} is a subdictionary template of MRMAC settings dictionary, and [['port1', 'data_rate'], ['port1', 'line_rate'], ['fec_only_bw']] is the corresponding list of setting paths.

Default: False

Examples

# Get the settings that a given setting depends on
proj = open_project('my_design.pdm')
handler = proj.get_ip_handler('MRMAC')
deps = handler.get_setting_dependencies(['port0', 'line_rate'])
# deps == {'port0': {'data_rate': 0, 'gt': ''}}
# The returned dictionary contains the required dependent settings
# Use these to provide correct values when calling get_setting_valid_values