163 lines
4.5 KiB
Python
163 lines
4.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2020-2022 Salvador E. Tropea
|
|
# Copyright (c) 2020-2022 Instituto Nacional de Tecnología Industrial
|
|
# License: GPL-3.0
|
|
# Project: KiBot (formerly KiPlot)
|
|
from collections import OrderedDict
|
|
from .optionable import Optionable
|
|
from .error import KiPlotConfigurationError
|
|
from .misc import ToolDependency, ToolDependencyRole
|
|
|
|
|
|
class Registrable(object):
|
|
""" This class adds the mechanism to register plug-ins """
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
@classmethod
|
|
def register(cl, name, aclass):
|
|
cl._registered[name] = aclass
|
|
|
|
@classmethod
|
|
def is_registered(cl, name):
|
|
return name in cl._registered
|
|
|
|
@classmethod
|
|
def get_class_for(cl, name):
|
|
return cl._registered[name]
|
|
|
|
@classmethod
|
|
def get_registered(cl):
|
|
return cl._registered
|
|
|
|
def __str__(self):
|
|
return "'{}' ({}) [{}]".format(self.comment, self.name, self.type)
|
|
|
|
|
|
class RegOutput(Optionable, Registrable):
|
|
""" An optionable that is also registrable.
|
|
Used by BaseOutput.
|
|
Here because it doesn't need macros. """
|
|
_registered = {}
|
|
# List of defined filters
|
|
_def_filters = {}
|
|
# List of defined variants
|
|
_def_variants = {}
|
|
# List of defined outputs
|
|
_def_outputs = OrderedDict()
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
@staticmethod
|
|
def reset():
|
|
# List of defined filters
|
|
RegOutput._def_filters = {}
|
|
# List of defined variants
|
|
RegOutput._def_variants = {}
|
|
# List of defined outputs
|
|
RegOutput._def_outputs = OrderedDict()
|
|
|
|
@staticmethod
|
|
def add_variants(variants):
|
|
RegOutput._def_variants.update(variants)
|
|
|
|
@staticmethod
|
|
def is_variant(name):
|
|
return name in RegOutput._def_variants
|
|
|
|
@staticmethod
|
|
def get_variant(name):
|
|
return RegOutput._def_variants[name]
|
|
|
|
@staticmethod
|
|
def add_filters(filters):
|
|
RegOutput._def_filters.update(filters)
|
|
|
|
@staticmethod
|
|
def is_filter(name):
|
|
return name in RegOutput._def_filters
|
|
|
|
@staticmethod
|
|
def get_filter(name):
|
|
return RegOutput._def_filters[name]
|
|
|
|
@staticmethod
|
|
def add_filter(obj):
|
|
RegOutput._def_filters[obj.name] = obj
|
|
|
|
@staticmethod
|
|
def add_output(obj, file=None):
|
|
if obj.name in RegOutput._def_outputs:
|
|
msg = "Output name `{}` already defined".format(obj.name)
|
|
if file:
|
|
msg += ", while importing from `{}`".format(file)
|
|
raise KiPlotConfigurationError(msg)
|
|
RegOutput._def_outputs[obj.name] = obj
|
|
|
|
@staticmethod
|
|
def add_outputs(objs, file=None):
|
|
for o in objs:
|
|
RegOutput.add_output(o, file)
|
|
|
|
@staticmethod
|
|
def get_outputs():
|
|
return RegOutput._def_outputs.values()
|
|
|
|
@staticmethod
|
|
def get_output(name):
|
|
return RegOutput._def_outputs.get(name, None)
|
|
|
|
@staticmethod
|
|
def check_variant(variant):
|
|
if variant:
|
|
if not RegOutput.is_variant(variant):
|
|
raise KiPlotConfigurationError("Unknown variant name `{}`".format(variant))
|
|
return RegOutput.get_variant(variant)
|
|
return None
|
|
|
|
|
|
class RegVariant(Optionable, Registrable):
|
|
""" An optionable that is also registrable.
|
|
Used by BaseVariant.
|
|
Here because it doesn't need macros. """
|
|
_registered = {}
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
|
|
class RegFilter(Optionable, Registrable):
|
|
""" An optionable that is also registrable.
|
|
Used by BaseFilter.
|
|
Here because it doesn't need macros. """
|
|
_registered = {}
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
|
|
class RegDependency(Registrable):
|
|
""" Used to register output tools dependencies """
|
|
_registered = {}
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
@classmethod
|
|
def register(cl, aclass):
|
|
name = aclass.name
|
|
if name in cl._registered:
|
|
# Already registered, add the roles
|
|
old_reg = cl._registered[name]
|
|
old_reg.roles.extend(aclass.roles)
|
|
else:
|
|
cl._registered[name] = aclass
|
|
|
|
|
|
# Here we register some global dependencies
|
|
RegDependency.register(ToolDependency('global', 'Colorama', is_python=True,
|
|
roles=ToolDependencyRole(desc='get color messages in a portable way')))
|
|
RegDependency.register(ToolDependency('global', 'Requests', is_python=True))
|
|
RegDependency.register(ToolDependency('global', 'PyYAML', is_python=True, deb='python3-yaml', module_name='yaml'))
|