edit(...) - edit(...) - 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

Edit clock by name and settings dictionary. Only the settings specified in a dictionary are applied.

Syntax

edit(<name>, <settings_dict>)

Parameters

Name Description
<name> Clock name.
<settings_dict> Clock settings dictionary. Execute get_sample_settings(template=True) to see the full clock settings dictionary structure.

Examples

# Edit the frequency of an existing clock
proj = open_project('my_design.pdm')
clock_handler = proj.get_clock_handler()
clock_handler.edit('clk1', {'freq': 250.0})
# Edit multiple settings at once
clock_handler.edit('clk1', {'is_gated': True, 'min_scaled_freq': 100.0})
# Empty dictionary has no effect
clock_handler.edit('clk1', {})