rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added docs for subclassing and lifecycle hooks

Browse source
This commit is contained in:
Joel Collins 2020-03-24 10:22:39 +00:00
parent 093e5a0a7a
commit 4626fa0565
4 changed files with 107 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/extensions/structure.rst
View file

@ -23,4 +23,14 @@ Once this extension is loaded, any other extensions will have access to your met
# Call a function from your extension
if my_found_extension:
my_found_extension.identify()
my_found_extension.identify()
Subclassing ``BaseExtension``
-------------------------------
The syntax used above allows novice programmers to easily start building extensions, without having to deal with subclassing. However, for more complex extensions which require persistent state, subclassing :py:class:`labthings.server.extensions.BaseExtension` is recommended.
The same simple extension as seen above can be written using subclassing:
.. literalinclude:: ./example_extension/01b_basic_structure_subclass.py