DBC: parse bus comments even when no DBName specified #565
Conversation
This file contains 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
Pull Request Test Coverage Report for Build 4988374293
💛 - Coveralls |
andlaus
reviewed
May 16, 2023
| @@ -1675,7 +1677,7 @@ def _load_bus(attributes, comments): | |||
| try: | |||
| bus_name = attributes['database']['DBName'].value | |||
| except KeyError: | |||
| return None | |||
| bus_name = '' | |||
There was a problem hiding this comment.
not sure if empty bus names are valid...
There was a problem hiding this comment.
Yeah, this is my main concern as well. I'm sure None is more-invalid, so hopefully juleq can chime in with better detail.
Other options could be a dummy bus name "bus" or somehow bring forward the DBC filename to use as CANdb++ does.
|
can you see any obstacles to merging this, @juleq? |
|
Yes, candb++ is authoritative, thanks for checking and adapting. Merging now. |
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.
This PR fixes two discrepancies I found vs CANdb++'s bus comment behaviour (I assume CANdb++ is the standard to match here?).
Firstly, a DBName is not actually required for a bus comment to be valid, and the filename (without extension) is used if one isn't specified. This auto-name isn't serialised on save.
Secondly, multiple
CM_entries get concatenated together. This behaviour is frankly a bit odd and feels wrong, especially since CANdb++ will then serialise the concatenated version to a singleCM_. But since it's "correct" behaviour, I've added it.I'm happy to amend the PR to remove the comment concatenation if you'd prefer to just drop extra CM_ entries (which is what cantools does at the moment).
Screenshot of CANdb++ behaviour on the newly added test dbc:
