Feature: Properties for global fields #116
Open
Conversation
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
* created new get/set dynamic interface for global fields * fixed bug where (data_doi, meta_doi) was incorrectly (data-doi, meta_doi) * increment API version * Thanks to @gregparkes for base implementation * add documentation * add tests
gregparkes
reviewed
Dec 16, 2025
| return self.get_global_field(self.NUM_CHANNELS_KEY, 1) | ||
| """Return integer number of channels.""" | ||
| warnings.warn( | ||
| "get_num_channels() is deprecated and will be removed in a future version of sigmf. " |
Contributor
There was a problem hiding this comment.
It might be worth informing the user what version the feature will removed, such as sigmf-python v2.0+
Collaborator
Author
There was a problem hiding this comment.
I thought about this, but we have neither a timeline nor a reason beside cleanliness to remove for now.
Contributor
There was a problem hiding this comment.
Fair enough - also with regards to using __getattr__ and __setattr__ it involves less code writing, but I'd still argue that the @property approach is more readable, faster and better for long-term code maintainability. But that may just be my preferred style.
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.
get_num_channelsSimilar to #115 but does more. Closes #102.