After a year of procrastination, I've finally written a script that makes the CIM module sane:
https://github.com/hwelch-fle/cimple
The goal here is to generate a new cim module from the existing one with the added benefit of proper typing of dependent attributes and string literal completion. The overall structure and usability of the CIM is also improved by utilizing dataclasses and removing the original inheritance hierarchy in favor of direct attribute definition.
Example:
# Original CIM definition
class CIMChart():
"""
Provides access to members that control chart properties.
"""
def __init__(self, *args, **Kwargs):
self.name = str()
self.series = []
self.generalProperties = 'CIMChartGeneralProperties'
self.legend = 'CIMChartLegend'
self.axes = []
self.mapSelectionHandling = ChartMapSelectionHandling.Highlight
self.metaData = str()
self.multiSeriesChartProperties = 'CIMMultiSeriesChartProperties'
self.enableServerSideProcessing = False
self.chartType = ChartType.Basic
# cimple CIM definition
@dataclass
class CIMChart:
"""https://github.com/Esri/cim-spec/blob/main/docs/v3/CIMCharts.md#cimchart-1
Provides access to members that control chart properties.
"""
name: str = ''
series: list[Any] = dc_field(default_factory=list[Any])
generalProperties: CIMChartGeneralProperties = dc_field(default_factory=lambda: CIMChartGeneralProperties())
legend: CIMChartLegend = dc_field(default_factory=lambda: CIMChartLegend())
axes: list[Any] = dc_field(default_factory=list[Any])
mapSelectionHandling: ChartMapSelectionHandling = 'Highlight'
metaData: str = ''
multiSeriesChartProperties: CIMMultiSeriesChartProperties = dc_field(default_factory=lambda: CIMMultiSeriesChartProperties())
enableServerSideProcessing: bool = False
chartType: ChartType = 'Basic'
The dc_field factories replace the GetPythonClass call and allow for mutable defaults. There are still some lists and dictionaries that use the Any type since I could'nt infer their type from the original module.
