example_record¶
$ target-query <path/to/target> -f example_record
Module |
|
Output |
|
Module documentation
Example plugin.
This plugin serves as an example for new plugins. Use it as a guideline.
Docstrings are used in help messages of plugins. Make sure to document your plugin and plugin functions. Use Google docstring format:
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
Plugins can optionally be namespaced by specifying the __namespace__
class attribute. Namespacing results in your plugin needing to be prefixed
with this namespace when being called. For example, if your plugin has
specified test as namespace and a function called example, you must
call your plugin with test.example:
__namespace__ = "test"
The __init__ takes the target as only argument. Perform additional
initialization here if necessary:
def __init__(self, target):
super().__init__(target)
Function documentation
Example plugin that generates records.
To create a new plugin function that yields records, you must define a record descriptor
and pass it to @export. This will implicitly mark the output type as record.