Skip to content
Snippets Groups Projects
Commit fb2314c9 authored by Stefano Borini's avatar Stefano Borini
Browse files

Renamed MCO classes to consistency

parent 5965fa24
No related branches found
No related tags found
1 merge request!51Renamed MCO classes to consistency
Showing
with 39 additions and 47 deletions
......@@ -16,6 +16,6 @@ from .kpi.i_kpi_calculator_bundle import IKPICalculatorBundle # noqa
from .mco.base_mco_model import BaseMCOModel # noqa
from .mco.base_mco_communicator import BaseMCOCommunicator # noqa
from .mco.base_multi_criteria_optimizer import BaseMultiCriteriaOptimizer # noqa
from .mco.base_multi_criteria_optimizer_bundle import BaseMultiCriteriaOptimizerBundle # noqa
from .mco.i_multi_criteria_optimizer_bundle import IMultiCriteriaOptimizerBundle # noqa
from .mco.base_mco import BaseMCO # noqa
from .mco.base_mco_bundle import BaseMCOBundle # noqa
from .mco.i_mco_bundle import IMCOBundle # noqa
......@@ -4,8 +4,7 @@ from traits.trait_types import List
from .ids import ExtensionPointID
from .data_sources.i_data_source_bundle import IDataSourceBundle
from .kpi.i_kpi_calculator_bundle import IKPICalculatorBundle
from .mco.i_multi_criteria_optimizer_bundle import \
IMultiCriteriaOptimizerBundle
from .mco.i_mco_bundle import IMCOBundle
class BaseExtensionPlugin(Plugin):
......@@ -25,7 +24,7 @@ class BaseExtensionPlugin(Plugin):
#: A list of available Multi Criteria Optimizers this plugin exports.
mco_bundles = List(
IMultiCriteriaOptimizerBundle,
IMCOBundle,
contributes_to=ExtensionPointID.MCO_BUNDLES
)
......
......@@ -6,8 +6,8 @@ from force_bdss.ids import ExtensionPointID
from .data_sources.i_data_source_bundle import (
IDataSourceBundle)
from .kpi.i_kpi_calculator_bundle import IKPICalculatorBundle
from .mco.i_multi_criteria_optimizer_bundle import (
IMultiCriteriaOptimizerBundle
from .mco.i_mco_bundle import (
IMCOBundle
)
......@@ -28,7 +28,7 @@ class BundleRegistryPlugin(Plugin):
#: A List of the available Multi Criteria Optimizers.
#: This will be populated by MCO plugins.
mco_bundles = ExtensionPoint(
List(IMultiCriteriaOptimizerBundle),
List(IMCOBundle),
id=ExtensionPointID.MCO_BUNDLES)
#: A list of the available Data Sources.
......
from traits.api import String
from force_bdss.api import bundle_id, BaseMultiCriteriaOptimizerBundle
from force_bdss.api import bundle_id, BaseMCOBundle
from .dakota_communicator import DummyDakotaCommunicator
from .dakota_model import DummyDakotaModel
from .dakota_optimizer import DummyDakotaOptimizer
class DummyDakotaBundle(BaseMultiCriteriaOptimizerBundle):
class DummyDakotaBundle(BaseMCOBundle):
id = String(bundle_id("enthought", "dummy_dakota"))
name = "Dummy Dakota"
......
......@@ -3,7 +3,7 @@ import sys
import itertools
import collections
from force_bdss.api import BaseMultiCriteriaOptimizer
from force_bdss.api import BaseMCO
def rotated_range(start, stop, starting_value):
......@@ -14,7 +14,7 @@ def rotated_range(start, stop, starting_value):
return list(d)
class DummyDakotaOptimizer(BaseMultiCriteriaOptimizer):
class DummyDakotaOptimizer(BaseMCO):
def run(self):
parameters = self.model.parameters
......
......@@ -18,15 +18,15 @@ except ImportError:
from force_bdss.ids import bundle_id, mco_parameter_id
from force_bdss.io.workflow_writer import WorkflowWriter
from force_bdss.mco.base_mco_model import BaseMCOModel
from force_bdss.mco.i_multi_criteria_optimizer_bundle import \
IMultiCriteriaOptimizerBundle
from force_bdss.mco.i_mco_bundle import \
IMCOBundle
from force_bdss.workspecs.workflow import Workflow
class TestWorkflowWriter(unittest.TestCase):
def setUp(self):
self.mock_registry = mock.Mock(spec=BundleRegistryPlugin)
mock_mco_bundle = mock.Mock(spec=IMultiCriteriaOptimizerBundle,
mock_mco_bundle = mock.Mock(spec=IMCOBundle,
id=bundle_id("enthought", "mock"))
mock_mco_model = mock.Mock(
spec=BaseMCOModel,
......@@ -69,7 +69,7 @@ class TestWorkflowWriter(unittest.TestCase):
wf = Workflow()
wf.multi_criteria_optimizer = BaseMCOModel(
mock.Mock(
spec=IMultiCriteriaOptimizerBundle,
spec=IMCOBundle,
id=bundle_id("enthought", "mock")))
wf.multi_criteria_optimizer.parameters = [
BaseMCOParameter(
......
......@@ -4,16 +4,16 @@ from traits.api import ABCHasStrictTraits, Instance
from ..bdss_application import BDSSApplication
from .base_mco_model import BaseMCOModel
from .i_multi_criteria_optimizer_bundle import IMultiCriteriaOptimizerBundle
from .i_mco_bundle import IMCOBundle
class BaseMultiCriteriaOptimizer(ABCHasStrictTraits):
class BaseMCO(ABCHasStrictTraits):
"""Base class for the Multi Criteria Optimizer.
Inherit this class for your MCO implementation
"""
#: A reference to the bundle
bundle = Instance(IMultiCriteriaOptimizerBundle)
bundle = Instance(IMCOBundle)
#: A reference to the application
application = Instance(BDSSApplication)
#: A reference to the model class
......@@ -23,7 +23,7 @@ class BaseMultiCriteriaOptimizer(ABCHasStrictTraits):
self.bundle = bundle
self.application = application
self.model = model
super(BaseMultiCriteriaOptimizer, self).__init__(*args, **kwargs)
super(BaseMCO, self).__init__(*args, **kwargs)
@abc.abstractmethod
def run(self):
......
......@@ -3,13 +3,11 @@ import abc
from traits.api import ABCHasStrictTraits, String
from traits.has_traits import provides
from force_bdss.mco.i_multi_criteria_optimizer_bundle import (
IMultiCriteriaOptimizerBundle
)
from force_bdss.mco.i_mco_bundle import IMCOBundle
@provides(IMultiCriteriaOptimizerBundle)
class BaseMultiCriteriaOptimizerBundle(ABCHasStrictTraits):
@provides(IMCOBundle)
class BaseMCOBundle(ABCHasStrictTraits):
"""Base class for the MultiCriteria Optimizer bundle.
"""
# NOTE: any changes to the interface of this class must be replicated
......
......@@ -4,7 +4,7 @@ from traits.api import ABCHasStrictTraits, Instance
from .base_mco_model import BaseMCOModel
from ..bdss_application import BDSSApplication
from .i_multi_criteria_optimizer_bundle import IMultiCriteriaOptimizerBundle
from .i_mco_bundle import IMCOBundle
class BaseMCOCommunicator(ABCHasStrictTraits):
......@@ -19,7 +19,7 @@ class BaseMCOCommunicator(ABCHasStrictTraits):
again specified by the MCO.
"""
#: A reference to the bundle
bundle = Instance(IMultiCriteriaOptimizerBundle)
bundle = Instance(IMCOBundle)
#: A reference to the application
application = Instance(BDSSApplication)
#: A reference to the model class
......
from traits.api import ABCHasStrictTraits, Instance, List
from .parameters.base_mco_parameter import BaseMCOParameter
from .i_multi_criteria_optimizer_bundle import IMultiCriteriaOptimizerBundle
from .i_mco_bundle import IMCOBundle
class BaseMCOModel(ABCHasStrictTraits):
......@@ -14,7 +14,7 @@ class BaseMCOModel(ABCHasStrictTraits):
"""
#: A reference to the creating bundle, so that we can
#: retrieve it as the originating factory.
bundle = Instance(IMultiCriteriaOptimizerBundle,
bundle = Instance(IMCOBundle,
visible=False,
transient=True)
......
from traits.api import Interface, String
class IMultiCriteriaOptimizerBundle(Interface):
class IMCOBundle(Interface):
"""Interface for the MultiCriteria Optimizer bundle.
You should not need it, as its main use is for envisage support.
"""
......
import unittest
from force_bdss.mco.base_mco_model import BaseMCOModel
from force_bdss.mco.base_multi_criteria_optimizer import \
BaseMultiCriteriaOptimizer
from force_bdss.mco.i_multi_criteria_optimizer_bundle import \
IMultiCriteriaOptimizerBundle
from force_bdss.mco.base_mco import BaseMCO
from force_bdss.mco.i_mco_bundle import IMCOBundle
try:
import mock
......@@ -14,14 +12,14 @@ except ImportError:
from force_bdss.bdss_application import BDSSApplication
class DummyMCO(BaseMultiCriteriaOptimizer):
class DummyMCO(BaseMCO):
def run(self, *args, **kwargs):
pass
class TestBaseMultiCriteriaOptimizer(unittest.TestCase):
def test_initialization(self):
bundle = mock.Mock(spec=IMultiCriteriaOptimizerBundle)
bundle = mock.Mock(spec=IMCOBundle)
application = mock.Mock(spec=BDSSApplication)
model = mock.Mock(spec=BaseMCOModel)
mco = DummyMCO(bundle, application, model)
......
import unittest
from force_bdss.mco.base_multi_criteria_optimizer_bundle import (
BaseMultiCriteriaOptimizerBundle
)
from force_bdss.mco.base_mco_bundle import BaseMCOBundle
class DummyMCOBundle(BaseMultiCriteriaOptimizerBundle):
class DummyMCOBundle(BaseMCOBundle):
id = "foo"
name = "bar"
......
......@@ -2,8 +2,7 @@ import unittest
from force_bdss.mco.base_mco_communicator import BaseMCOCommunicator
from force_bdss.mco.base_mco_model import BaseMCOModel
from force_bdss.mco.i_multi_criteria_optimizer_bundle import \
IMultiCriteriaOptimizerBundle
from force_bdss.mco.i_mco_bundle import IMCOBundle
try:
import mock
......@@ -23,7 +22,7 @@ class DummyMCOCommunicator(BaseMCOCommunicator):
class TestBaseMCOCommunicator(unittest.TestCase):
def test_initialization(self):
bundle = mock.Mock(spec=IMultiCriteriaOptimizerBundle)
bundle = mock.Mock(spec=IMCOBundle)
application = mock.Mock(spec=BDSSApplication)
model = mock.Mock(spec=BaseMCOModel)
mcocomm = DummyMCOCommunicator(bundle, application, model)
......
......@@ -14,8 +14,8 @@ from envisage.application import Application
from force_bdss.bundle_registry_plugin import BundleRegistryPlugin
from force_bdss.data_sources.i_data_source_bundle import IDataSourceBundle
from force_bdss.kpi.i_kpi_calculator_bundle import IKPICalculatorBundle
from force_bdss.mco.i_multi_criteria_optimizer_bundle import \
IMultiCriteriaOptimizerBundle
from force_bdss.mco.i_mco_bundle import \
IMCOBundle
class TestBundleRegistry(unittest.TestCase):
......@@ -33,7 +33,7 @@ class TestBundleRegistry(unittest.TestCase):
class MySuperPlugin(BaseExtensionPlugin):
def _mco_bundles_default(self):
return [mock.Mock(spec=IMultiCriteriaOptimizerBundle,
return [mock.Mock(spec=IMCOBundle,
id=bundle_id("enthought", "mco1"))]
def _data_source_bundles_default(self):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment