eds: Support custom_options for unknown EDS fields#653
Open
bizfsc wants to merge 1 commit intocanopen-python:masterfrom
Open
eds: Support custom_options for unknown EDS fields#653bizfsc wants to merge 1 commit intocanopen-python:masterfrom
bizfsc wants to merge 1 commit intocanopen-python:masterfrom
Conversation
When importing an EDS/DCF file, any key that is not part of the CiA 306 standard field set is now collected into a custom_options dict on the object. This allows applications to round-trip vendor-specific metadata without losing it. Co-authored-by: FedericoSpada <FedericoSpada@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Adds support for round-tripping vendor-specific (non-CiA-306) EDS/DCF keys by collecting them into a new custom_options dict on object dictionary objects and exporting them back out.
Changes:
- Introduces
custom_optionsonODVariable,ODRecord, andODArrayto store unknown EDS keys. - Updates EDS import/export to populate and persist
custom_optionsusing a_STANDARD_OPTIONSallowlist and_get_custom_options()helper. - Adds tests and sample EDS entries covering read + export/import round-trip behavior.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
canopen/objectdictionary/eds.py |
Collects unknown keys into custom_options during import and writes them back during export. |
canopen/objectdictionary/__init__.py |
Adds custom_options attribute to OD object types. |
test/test_eds.py |
Adds unit tests for reading and round-tripping custom_options. |
test/sample.eds |
Adds sample objects containing vendor-specific keys to validate behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| if object_type in (objectcodes.VAR, objectcodes.DOMAIN): | ||
| var = build_variable(eds, section, node_id, index) | ||
| var.custom_options = _get_custom_options(eds, section) |
| "ParameterValue", "Factor", "Description", "Unit", | ||
| "StorageLocation", "CompactSubObj", | ||
| # CiA 306 fields parsed explicitly: | ||
| "SubNumber", "ObjFlags", "Denotation", |
Comment on lines
+429
to
+431
| for option, value in var.custom_options.items(): | ||
| eds.set(section, option, value) | ||
|
|
Comment on lines
437
to
+439
| eds.set(section, "ObjectType", f"0x{ot:X}") | ||
| for option, value in var.custom_options.items(): | ||
| eds.set(section, option, value) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Supersedes #615.
When importing an EDS/DCF file, any key that is not part of the CiA 306 standard field set is now collected into a
custom_optionsdict on the object. This allows applications to round-trip vendor-specific metadata without losing it.Changes
ODVariable,ODRecordandODArraygain acustom_options: dictattribute (default{})._STANDARD_OPTIONSset ineds.pylists all keys that are parsed explicitly (includingObjFlagsandDenotationwhich are handled by a separate PR)._get_custom_options(eds, section)helper collects every key that is not in_STANDARD_OPTIONS.custom_optionsis populated for top-level VAR/DOMAIN, ARRAY and RECORD objects as well as for sub-variables viabuild_variable().export_variable()andexport_record()writecustom_optionsback to the EDS file, preserving all unknown fields through a round-trip.from canopen.objectdictionary import …, objectcodes).DOMAIN/VAR/ARR/RECORDconstants removed; replaced withobjectcodes.DOMAIN/VAR/ARRAY/RECORD.Tests
test_reading_custom_options— VAR withCategory=Motor,Offset=100test_custom_options_standard_keys_excluded— standard keys absent fromcustom_optionstest_custom_options_empty_for_standard_object— heartbeat time has{}test_custom_options_record— RECORD-levelcustom_optionstest_roundtrip_custom_options— full EDS export/import cycle preserves valuestest_roundtrip_custom_options_not_duplicated_as_standard— standard keys stay out after round-trip