# This file is part of Sympathy for Data.
# Copyright (c) 2020, Combine Control Systems AB
#
# Sympathy for Data is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Sympathy for Data is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Sympathy for Data. If not, see <http://www.gnu.org/licenses/>.
import os
import typing as _t
import fnmatch
import pkg_resources
import sympathy.utils.library_info
def scan_files(root, filename_pattern='*'):
res = []
for dirpath, dirnames, filenames in os.walk(root, True):
res.extend([os.path.join(dirpath, fn) for fn in fnmatch.filter(
filenames, filename_pattern)])
return res
# Library Plugin interface:
[docs]def required_features() -> _t.List[str]:
"""
Returns:
Features required for enabling the library.
"""
return []
[docs]def identifier() -> str:
"""
Returns:
Library identifier, which should be unique. See
https://en.wikipedia.org/wiki/Reverse_domain_name_notation
"""
return ''
[docs]def name() -> str:
"""
Returns:
Library name as shown in Library View, documentation etc.
"""
return ''
[docs]def icon() -> str:
"""
Returns:
Path to icon file.
"""
return ''
def description() -> str:
"""
Returns:
Brief description of the library.
"""
return ''
[docs]def maintainer() -> str:
"""
Returns:
Maintainer. Format Name <email>.
"""
return ''
[docs]def copyright() -> str:
"""
Returns:
Copyright.
"""
return ''
[docs]def version() -> str:
"""
Returns:
Version. Format minor.major.micro
"""
return ''
[docs]def nodes() -> _t.List[str]:
"""
Returns:
Paths to python files containing nodes.
"""
return []
[docs]def flows() -> _t.List[str]:
"""
Returns:
Paths to python files containing flow nodes.
"""
return []
[docs]def plugins() -> _t.List[str]:
"""
Returns:
Paths to python files containing node plugins.
"""
return []
[docs]def types() -> _t.List['sympathy.api.typeutil.TypeAlias']:
"""
Returns:
Port type definitions.
"""
return []
[docs]def examples_path() -> str:
"""
Returns:
Path to examples.
"""
return ''
[docs]def repository_url() -> str:
"""
Returns:
URL to public source repository.
"""
return ''
[docs]def documentation_url() -> str:
"""
Returns:
URL to public documentation.
"""
return ''
[docs]def home_url() -> str:
"""
Returns:
URL to public home page.
"""
return ''
# Serialization:
def to_dict(library):
res = {}
res['identifier'] = library.identifier()
res['name'] = library.name()
res['description'] = library.description()
res['path'] = os.path.abspath(
os.path.dirname(library.__file__))
for key, default_func in [
('maintainer', default_maintainer),
('copyright', default_copyright),
('version', default_version),
('icon', default_icon),
('nodes', default_nodes),
('flows', default_flows),
('plugins', default_plugins),
('tags', default_tags),
('types', default_types),
('examples_path', default_examples_path),
('required_features', default_required_features),
('repository_url', default_repository_url),
('documentation_url', default_documentation_url),
('home_url', default_home_url),
]:
try:
func = getattr(library, key)
except AttributeError:
res[key] = default_func(library)
else:
res[key] = func()
return res
# Default functions:
def default_maintainer(library):
return ''
def default_copyright(library):
return ''
def default_version(library):
return ''
def default_icon(library):
return ''
def default_nodes(library):
return scan_files(
os.path.dirname(library.__file__), 'node_*.py')
def default_flows(library):
return scan_files(
os.path.dirname(library.__file__), 'flow_*.syx')
def default_plugins(library):
return scan_files(
os.path.dirname(library.__file__), 'plugin_*.py')
def default_tags(library):
return []
def default_types(library):
return []
def default_required_features(library):
return []
def default_examples_path(library):
return os.path.join(os.path.dirname(library.__file__), 'examples')
def default_repository_url(library):
return ''
def default_documentation_url(library):
return ''
def default_home_url(library):
return ''
# Library plugins:
_identifier = 'sympathy.library.plugins'
_libraries = {True: None, False: None}
def available_libraries(load=True):
if _libraries[load] is None:
if load:
plugins = {
entry_point.name: entry_point.load()
for entry_point
in pkg_resources.iter_entry_points(_identifier)
}
else:
plugins = {
entry_point.name: entry_point
for entry_point
in pkg_resources.iter_entry_points(_identifier)
}
_libraries[load] = plugins.values()
return _libraries[load]
# Utilities:
def is_old_style(library_root):
library_ini_path = os.path.join(library_root, 'library.ini')
common_path = os.path.join(library_root, 'Common')
library_path = os.path.join(library_root, 'Library')
return os.path.exists(library_ini_path) or (
os.path.exists(common_path) and os.path.exists(library_path))
def package_python_path(library_root):
if is_old_style(library_root):
return os.path.join(library_root, 'Common')
else:
return os.path.dirname(library_root)
def library_path(library_root):
if is_old_style(library_root):
library_name = sympathy.utils.library_info.library_name(
library_root)
if library_name:
return os.path.join(library_root, 'Library', library_name)
else:
return os.path.join(library_root, 'Library')
else:
return library_root
def package_name(library_root):
if is_old_style(library_root):
return sympathy.utils.library_info.library_name(library_root)
else:
return os.path.basename(library_root)
# Accessors
def library_plugins(library):
try:
return library.plugins()
except AttributeError:
return default_plugins(library)
