Replace first TODO instruction to import the wrapper of the instrument#33
Merged
seb5g merged 3 commits intoPyMoDAQ:5.0.xfrom Dec 17, 2025
Merged
Conversation
… The previous instruction was a bit misleading and lead to copy-paste the content of the wrapper file.
seb5g
requested changes
Dec 16, 2025
| # TODO Replace this fake class with the import of the real python wrapper of your instrument | ||
| pass | ||
| # TODO Replace this fake import with the import of the real python wrapper of your instrument | ||
| from pymodaq_plugins_template.hardware.PythonWrapperFileOfYourInstrument import PythonWrapperObjectOfYourInstrument |
Contributor
There was a problem hiding this comment.
maybe say the import is not exclusive from hardware but could be from another package: pymeasure, pylablib...
Contributor
There was a problem hiding this comment.
for the file (module) write it in lowercase with underscore
| pass | ||
|
|
||
| # TODO Replace this fake import with the import of the real python wrapper of your instrument | ||
| from pymodaq_plugins_template.hardware.PythonWrapperFileOfYourInstrument import PythonWrapperObjectOfYourInstrument |
* consider the possibility of import from an external librairy like Pylablib or PyMeasure. * use lower case for wrapper file name
seb5g
approved these changes
Dec 17, 2025
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
2 participants
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.
Modification of the first TODO instruction that was a bit misleading for the newcomer, and could lead him to copy-paste the content of his instrument wrapper in the plugin.
The good practise is rather to lead him to import the wrapper object.