Disallow repeated capability on session #883
Merged
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
marcoskirsch
previously requested changes
Jun 1, 2018
CHANGELOG.md
Outdated
| @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. | |||
| * #### Added | |||
| * #### Changed | |||
| * #### Removed | |||
| * Explicitly disallow using a repeated capability on Session. `session['0'].vertical_range = 1.0` will no longer work. Instead use `session.channels['0'].vertical_range = 1.0` - [#853](https://github.com/ni/nimi-python/issues/853) | |||
There was a problem hiding this comment.
I think in example snippets we should show the use of indices with numbers.
Meaning: session[0].vertical_range = 1.0 as opposed to session['0'].vertical_range = 1.0
| @@ -190,6 +190,9 @@ constructor_params = helper.filter_parameters(init_function, helper.ParameterUsa | |||
| raise AttributeError("'{0}' object has no attribute '{1}'".format(type(self).__name__, key)) | |||
| object.__setattr__(self, key, value) | |||
|
|
|||
| def __getitem__(self, key): | |||
There was a problem hiding this comment.
Is this needed? When you try to index a class that doesn't support it, the error is:
TypeError: 'Foo' object does not support indexing
We wouldn't want this to be different. Let's let Python do its thing.
If you think the text in the exception is a good enough reason (I'm not convinced) then let's make it really useful:
- raise TypeError
- text should say `'Session' object does not support indexing. XXX
- XXX should be something that talks about the repeated capability containers for the class. The magic of codegen! (or we could at runtime figure it out)
Regardless, I'm not sure it's worth it.
There was a problem hiding this comment.
Yes, this is needed. Without it, it does not error when using session[0]. I'm not sure it actually works, but it doesn't error.
- Changed to
TypeError - Text now says "'Session' object does not support indexing. You should use the applicable repeated capabilities container(s): {}"
- where {} is the list of containers supported by that driver
| try: | ||
| session['100'].read_write_double = 5.0 | ||
| assert False | ||
| except AttributeError: |
marcoskirsch
approved these changes
Jun 4, 2018
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.
What does this Pull Request accomplish?
session[0].vertical_range = 1.0will no longer work. Instead usesession.channels[0].vertical_range = 1.0List issues fixed by this Pull Request below, if any.
What testing has been done?