Skip to content

Interfaces

Collection of custom adapters for interfacing with various systems.

ScriptAdapterFactory

Bases: object

Factory for constructing specific script adapter objects. Uses iter_adapters to find all concrete implementations of ScriptAdapter.

Source code in maestrowf/interfaces/__init__.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class ScriptAdapterFactory(object):
    """
    Factory for constructing specific script adapter objects.  Uses
    iter_adapters to find all concrete implementations of ScriptAdapter.
    """
    factories = {
       adapter.key: adapter for adapter in iter_adapters()
    }

    @classmethod
    def get_adapter(cls, adapter_id):
        if adapter_id.lower() not in cls.factories:
            msg = "Adapter '{0}' not found. Specify an adapter that exists " \
                  "or implement a new one mapping to the '{0}'" \
                  .format(str(adapter_id))
            LOGGER.error(msg)
            raise Exception(msg)

        return cls.factories[adapter_id]

    @classmethod
    def get_valid_adapters(cls):
        return cls.factories.keys()

iter_adapters()

Based off of packaging.python.org loop over a namespace and find the modules. This has been adapted for this particular use case of loading all classes implementing ScriptAdapter loaded from all modules in maestrowf.interfaces.script.

Returns:

Type Description

an iterable of the classes existing in the namespace
Source code in maestrowf/interfaces/__init__.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def iter_adapters():
    """
    Based off of packaging.python.org loop over a namespace and find the
    modules. This has been adapted for this particular use case of loading
    all classes implementing ScriptAdapter loaded from all modules in
    maestrowf.interfaces.script.
    :return: an iterable of the classes existing in the namespace
    """
    # get loader for the script adapter package
    loader = pkgutil.get_loader('maestrowf.interfaces.script')
    # get all of the modules in the package
    mods = [(name, ispkg) for finder, name, ispkg in pkgutil.iter_modules(
            loader.load_module('maestrowf.interfaces.script').__path__,
            loader.load_module('maestrowf.interfaces.script').__name__ + ".")]
    cs = []
    for name, _ in mods:
        # get loader for every module
        m = pkgutil.get_loader(name).load_module(name)
        # get all classes that implement ScriptAdapter and are not abstract
        for n, cls in m.__dict__.items():
            if isinstance(cls, type) and issubclass(cls, ScriptAdapter) and \
                    not inspect.isabstract(cls):
                cs.append(cls)

    return cs