1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining a copy
6 # of this software and associated documentation files (the "Software"), to deal
7 # in the Software without restriction, including without limitation the rights
8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 # copies of the Software, and to permit persons to whom the Software is
10 # furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 from bt2
import component
as bt2_component
28 # Python plugin path to `_PluginInfo` (cache)
32 def plugin_component_class(component_class
):
33 if not issubclass(component_class
, bt2_component
._UserComponent
):
34 raise TypeError('component class is not a subclass of a user component class')
36 component_class
._bt
_plugin
_component
_class
= None
37 return component_class
41 module_name
, name
, description
=None, author
=None, license
=None, version
=None
43 if module_name
not in sys
.modules
:
45 "cannot find module '{}' in loaded modules".format(module_name
)
48 utils
._check
_str
(name
)
50 if description
is not None:
51 utils
._check
_str
(description
)
53 if author
is not None:
54 utils
._check
_str
(author
)
56 if license
is not None:
57 utils
._check
_str
(license
)
59 if version
is not None:
60 if not _validate_version(version
):
62 'wrong version: expecting a tuple: (major, minor, patch) or (major, minor, patch, extra)'
65 sys
.modules
[module_name
]._bt
_plugin
_info
= _PluginInfo(
66 name
, description
, author
, license
, version
70 def _validate_version(version
):
74 if not isinstance(version
, tuple):
77 if len(version
) < 3 or len(version
) > 4:
80 if not isinstance(version
[0], int):
83 if not isinstance(version
[1], int):
86 if not isinstance(version
[2], int):
90 if not isinstance(version
[3], str):
97 def __init__(self
, name
, description
, author
, license
, version
):
99 self
.description
= description
101 self
.license
= license
102 self
.version
= version
103 self
.comp_class_addrs
= None
106 # called by the BT plugin system
107 def _try_load_plugin_module(path
):
108 if path
in _plugin_infos
:
109 # do not load module and create plugin info twice for this path
110 return _plugin_infos
[path
]
112 import importlib
.machinery
117 raise TypeError('missing path')
119 # In order to load the module uniquely from its path, even from
120 # different files which have the same basename, we hash the path
121 # and prefix with `bt_plugin_`. This is its key in sys.modules.
123 h
.update(path
.encode())
124 module_name
= 'bt_plugin_{}'.format(h
.hexdigest())
125 assert module_name
not in sys
.modules
126 # try loading the module: any raised exception is catched by the caller
127 mod
= importlib
.machinery
.SourceFileLoader(module_name
, path
).load_module()
129 # we have the module: look for its plugin info first
130 if not hasattr(mod
, '_bt_plugin_info'):
131 raise RuntimeError("missing '_bt_plugin_info' module attribute")
133 plugin_info
= mod
._bt
_plugin
_info
135 # search for user component classes
136 def is_user_comp_class(obj
):
137 if not inspect
.isclass(obj
):
140 if not hasattr(obj
, '_bt_plugin_component_class'):
145 comp_class_entries
= inspect
.getmembers(mod
, is_user_comp_class
)
146 plugin_info
.comp_class_addrs
= [entry
[1].addr
for entry
in comp_class_entries
]
147 _plugin_infos
[path
] = plugin_info
This page took 0.035381 seconds and 4 git commands to generate.