-
Notifications
You must be signed in to change notification settings - Fork 106
add overwrite to repeated capabilities #2183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
elebel-emerson
wants to merge
3
commits into
ni:master
Choose a base branch
from
elebel-emerson:updateRepeatedCaps
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| from pathlib import Path | ||
| from types import SimpleNamespace | ||
|
|
||
| from mako.template import Template | ||
|
|
||
|
|
||
| def _render_rep_caps(config): | ||
| repo_root = Path(__file__).resolve().parents[2] | ||
| template_path = repo_root / 'build' / 'templates' / 'rep_caps.rst.mako' | ||
| template = Template(filename=str(template_path)) | ||
| metadata = SimpleNamespace(config=config) | ||
| return template.render(template_parameters={'metadata': metadata}) | ||
|
|
||
|
|
||
| def test_rep_caps_template_uses_custom_documentation_overrides(): | ||
| config = { | ||
| 'module_name': 'nifake', | ||
| 'c_function_prefix': 'niFake_', | ||
| 'repeated_capabilities': [ | ||
| { | ||
| 'prefix': 'res', | ||
| 'python_name': 'resources', | ||
| 'documentation': { | ||
| 'description': 'Resource repeated capabilities use fully-qualified identifiers.', | ||
| 'auto_prefix_addition_supported': False, | ||
| 'valid_identifiers': ['dev0/res0', 'dev0/res1'], | ||
| 'examples': [ | ||
| "session.resources['dev0/res0'].channel_enabled = True", | ||
| "session.resources['dev0/res1'].channel_enabled = True", | ||
| ], | ||
| }, | ||
| } | ||
| ], | ||
| } | ||
|
|
||
| rendered = _render_rep_caps(config) | ||
|
|
||
| assert 'Resource repeated capabilities use fully-qualified identifiers.' in rendered | ||
| assert "Valid identifiers: :python:`'dev0/res0, dev0/res1'`." in rendered | ||
| assert "session.resources['dev0/res0'].channel_enabled = True" in rendered | ||
| assert "session.resources['dev0/res1'].channel_enabled = True" in rendered | ||
|
|
||
| # Generic auto-prefix guidance should be suppressed when override disables it. | ||
| assert 'If no prefix is added to the items in the parameter' not in rendered | ||
| assert "session.resources['0-2'].channel_enabled = True" not in rendered | ||
| assert "'res0, res1, res2'" not in rendered | ||
|
|
||
|
|
||
| def test_rep_caps_template_preserves_default_prefixed_behavior(): | ||
| config = { | ||
| 'module_name': 'nifake', | ||
| 'c_function_prefix': 'niFake_', | ||
| 'repeated_capabilities': [ | ||
| { | ||
| 'prefix': 'channel', | ||
| 'python_name': 'channels', | ||
| } | ||
| ], | ||
| } | ||
|
|
||
| rendered = _render_rep_caps(config) | ||
|
|
||
| assert 'If no prefix is added to the items in the parameter' in rendered | ||
| assert "session.channels['0-2'].channel_enabled = True" in rendered | ||
| assert "'channel0, channel1, channel2'" in rendered |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,5 +34,3 @@ channels | |
|
|
||
| passes a string of :python:`'0, 1, 2'` to the set attribute function. | ||
|
|
||
|
|
||
|
|
||
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So you want a way to ignore the prefix, if it's specified?
That's the only reason I can think of for this
auto_prefix_addition_supportedvalue.