Documented that nothing should be defined outside the plugin class in Python storage plugins #867
Conversation
…n storage plugins.
| :::{danger} | ||
| **When writing a Python storage plugin, do not define any variables or functions outside the `DLiteStorageBase` subclass!** | ||
|
|
||
| The reason for this requirement is that all plugins will be loaded into the same shared scope within the built-in interpreter. | ||
| Hence, variables or functions outside the plugin class may interfere with other plugins, resulting in confusing and hard-to-find bugs. | ||
| ::: | ||
|
|
There was a problem hiding this comment.
Good, but can we add an example in https://github.com/SINTEF/dlite/blob/master/doc/user_guide/storage_plugin.py (doen't matter if it is not used), and in the template?
There was a problem hiding this comment.
Good, but can we add an example in https://github.com/SINTEF/dlite/blob/master/doc/user_guide/storage_plugin.py (doen't matter if it is not used), and in the template?
Do you mean the note added on line 3 in https://github.com/SINTEF/dlite/blob/81261950afd235dd4c280103bcca798c46ec9463/doc/user_guide/storage_plugin.py?
There was a problem hiding this comment.
No I was thinking more along the lines
class plugin....:
....
...
def _local_help_function():
""" An optional class method or a function if desired.
Note that no functions or variables should be set outside the class
for a DLite plugin python file.
""
There was a problem hiding this comment.
Added an example help method to the storage plugin template
…-define-anything-outside-the-plugin-class
…ing-outside-the-plugin-class' of github.com:SINTEF/dlite into 866-document-that-dlite-plugins-should-not-define-anything-outside-the-plugin-class
…-define-anything-outside-the-plugin-class
jesper-friis
deleted the
866-document-that-dlite-plugins-should-not-define-anything-outside-the-plugin-class
branch
Description
Documented that nothing should be defined outside the plugin class in Python storage plugins,
Type of change
Checklist for the reviewer
This checklist should be used as a help for the reviewer.