func_template() - Code Metrics - Inspection of "Fixed #14: Receiver namespace is no longer Weak" - useblocks/groundwork - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0b984b...b1484e )

by Daniel

created 2018-05-28 12:42 UTC

func_template() A

↳ Parent: create_receiver_function()

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10

import pytest
class SomeClass:
    def some_method(self):
        """Do x and return foo."""


def test_signal_registration(basicApp):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    plugin = basicApp.plugins.get("BasicPlugin")
    signals = plugin.signals.get()
    assert len(signals.keys()) == 1
    assert "test" in signals.keys()


def test_signal_send(basicApp):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    answers = basicApp.signals.send("test", basicApp, text="test")
    assert len(answers) == 1
    assert isinstance(answers, list)
    assert len(answers[0]) == 2
    assert isinstance(answers[0], tuple)
    assert answers[0][1] == {'text': 'test'}


def test_signal_connect(basicApp):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def _test_command(plugin, **kwargs):

        return "12345"

    plugin = basicApp.plugins.get("BasicPlugin")
    plugin.signals.connect("12345 receiver", "test", _test_command, "receiver 12345 for test")
    answers = plugin.signals.send("test")
    assert len(answers) == 2
    for answer in answers:
        if answer[0] == _test_command:
            assert answer[1] == "12345"


def test_signal_disconnect(basicApp):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def _test_command(plugin, **kwargs):

        return "12345"

    plugin = basicApp.plugins.get("BasicPlugin")
    plugin.signals.connect("12345 receiver", "test", _test_command, "receiver 12345 for test")
    answers = plugin.signals.send("test")
    assert len(answers) == 2
    for answer in answers:
        if answer[0] == _test_command:
            assert answer[1] == "12345"

    plugin.signals.disconnect("12345 receiver")
    answers = plugin.signals.send("test")
    assert len(answers) == 1


def test_receiver_get(basicApp):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def _test_command(plugin, **kwargs):

        return "12345"

    plugin = basicApp.plugins.get("BasicPlugin")
    receivers = plugin.signals.get_receiver()
    assert len(receivers) == 1  # test receiver
    plugin.signals.connect("12345 receiver", "test", _test_command, "receiver 12345 for test")
    receivers = plugin.signals.get_receiver()
    assert len(receivers) == 2
    plugin.deactivate()
    receivers = plugin.signals.get_receiver()
    assert len(receivers) == 0



def test_multi_plugin_deactivations(basicApp, EmptyPlugin):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def test():
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        pass

    plugin = basicApp.plugins.get("BasicPlugin")
    plugin2 = EmptyPlugin(app=basicApp, name="EmptyPlugin")
    plugin2.activate()
    assert plugin2.active is True

    plugin2.signals.register("test123", "test123 description")
    plugin2_signals = plugin2.signals.get()
    assert len(plugin2_signals) == 1

    plugin_signals = plugin.signals.get()
    # BasicPlugin has already registered a signal during init
    assert len(plugin_signals) == 1

    plugin2.deactivate()
    plugin2_signals = plugin2.signals.get()
    assert len(plugin2_signals) == 0

    assert plugin2.active is False

    assert len(plugin_signals) == 1
    assert plugin.active is True


def test_signal_handling(basicApp, EmptyPlugin):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    from blinker import NamedSignal

    from groundwork.signals import UnknownSignal

    def sig_reg_test(plugin, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return ["data_1", "data_2"]

    plugin1 = EmptyPlugin(app=basicApp, name="EmptyPlugin")

    # This creates a gw receiver and a blinker internal signal called "test"
    plugin1.signals.connect("sig_reg_receiver", "sig_reg_test", sig_reg_test, "receiver sig_reg for test")


    # Check the blinker internal registration
    signal_namespace = basicApp.signals._namespace
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
    assert "sig_reg_test" in signal_namespace.keys()
    test_signal = signal_namespace["sig_reg_test"]
    assert isinstance(test_signal, NamedSignal)

    # Check the gw registration
    plugin_signals = plugin1.signals.get()
    # This must be 0, because gw has not registered a signal, this was done in blinker only
    assert len(plugin_signals) == 0


    app_signals = basicApp.signals.get()
    assert "sig_reg_test" not in app_signals.keys()

    # Check if signal sending throws an error (without a registered gw signal)
    with pytest.raises(UnknownSignal):
        plugin1.signals.send("sig_reg_test")

    # Check if gw has a registered receiver
    plugin_receivers = plugin1.signals.get_receiver()
    assert "sig_reg_receiver" in plugin_receivers.keys()

    # Register the missing gw signal
    plugin_signal = plugin1.signals.register("sig_reg_test", "signal for sig_reg_test")
    assert plugin_signal is not None

    # Recheck the gw registration
    plugin_signals = plugin1.signals.get()
    # This must be 1, because gw has registered a signal now
    assert len(plugin_signals) == 1

    # Sending should work now
    return_values = plugin1.signals.send("sig_reg_test")
    # Check if the receivers sends back needed data
    assert len(return_values) == 1
    assert return_values[0][1][0] == "data_1"


def test_signal_handling_via_plugins(basicApp, EmptyPlugin):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def sig_reg_test_1(plugin, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return ["data_1", "data_2"]

    def sig_reg_test_2(plugin, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return ["data_3", "data_4"]

    plugin_send = EmptyPlugin(app=basicApp, name="Plugin_send")

    plugin_receive_pre = EmptyPlugin(app=basicApp, name="Plugin_receive_pre")
    plugin_receive_post = EmptyPlugin(app=basicApp, name="Plugin_receive_post")

    plugin_receive_pre.activate()
    plugin_receive_pre.signals.connect("sig_reg_pre_receiver", "signal_test",
                                       sig_reg_test_1, "receiver signal_test for test")

    plugin_send.activate()
    plugin_send.signals.register("signal_test", "signal_test doc")

    return_values = plugin_send.signals.send("signal_test")
    assert len(return_values) == 1

    plugin_receive_post.activate()
    plugin_receive_post.signals.connect("sig_reg_post_receiver", "signal_test",
                                        sig_reg_test_2, "receiver signal_test for test")

    return_values = plugin_send.signals.send("signal_test")
    assert len(return_values) == 2

    # Send signal and check return vales


def test_multi_plugin_sending(basicApp, EmptyPlugin):

    """
    Nearly some test as "test_signal_handling_via_plugins", but with an adjustable amount of plugins for sending

    and receiving.

    Registers receivers before the signal gets registers itself and afterwards.
    Checks if all receivers get correctly called, if signal is send.

    This tests will normally fail, if Weaknamespace is used in groundwork/signals.py:
    from blinker import WeakNamespace as Namespace

    So use always Namespace and if need do clean ups on groundwork site.
    """

    amount_pre_plugins = 30
    amount_post_plugins = 10
    amount_send_plugins = 30

    def create_receiver_function(start):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def func_template(*args, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            return ["data_{0}_A".format(start),
                    "data_{0}_B".format(start)]

        return func_template

    # PRE receivers
    plugin_receive_pre = []
    for i in range(0, amount_pre_plugins):
        plugin_receive_pre.append(EmptyPlugin(app=basicApp, name="Plugin_receive_pre_{0}".format(i)))

        plugin_receive_pre[i].activate()
        plugin_receive_pre[i].signals.connect("sig_reg_pre_receiver_{0}".format(i), "signal_test",
                                              create_receiver_function(i),
                                              "receiver signal_test_{0} for test".format(i))

    # Count gw internal registered receivers
    amount = 0
    for receiver in basicApp.signals.receivers.keys():
        if "sig_reg_pre_receiver" in receiver:
            amount += 1
    assert amount == amount_pre_plugins

    # Senders
    plugin_send = []
    for i in range(0, amount_send_plugins):
        plugin_send.append(EmptyPlugin(app=basicApp, name="Plugin_send_{0}".format(i)))
        plugin_send[i].activate()
        if i == 0:
            # We only need to register our signal once
            plugin_send[0].signals.register("signal_test", "signal_test")
            assert amount_pre_plugins == len(basicApp.signals.signals["signal_test"]._signal.receivers)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

    # Check, if for our signal all receivers have been registered
    print("Registered receivers for signal_test: {0}".format(
        len(basicApp.signals.signals["signal_test"]._signal.receivers)))
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
    assert amount_pre_plugins == len(basicApp.signals.signals["signal_test"]._signal.receivers)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent

    # Send signal
    for index, plugin in enumerate(plugin_send):
        print(" {0} sending...".format(index))
        return_values = plugin.signals.send("signal_test")

        # check return length and content
        assert len(return_values) == amount_pre_plugins
        for i in range(0, amount_pre_plugins):
            found = False
            for value in return_values:
                if value[1][0] == "data_{0}_A".format(i) and value[1][1] == "data_{0}_B".format(i):
                    found = True
                    break
            assert found is True

    # Register POST receivers
    plugin_receive_post = []
    for i in range(0, amount_post_plugins):
        plugin_receive_post.append(EmptyPlugin(app=basicApp, name="Plugin_receive_post_{0}".format(i)))

        plugin_receive_post[i].activate()
        plugin_receive_post[i].signals.connect("sig_reg_post_receiver_{0}".format(i), "signal_test",
                                               create_receiver_function(amount_pre_plugins + i),
                                               "receiver signal_test_{0} for test".format(i))

    # Send again a signal and check return values
    # Send signal
    for index, plugin in enumerate(plugin_send):
        print(" {0} sending again...".format(index))
        return_values = plugin.signals.send("signal_test")

        # check return length and content
        assert len(return_values) == amount_pre_plugins + amount_post_plugins
        for i in range(0, amount_pre_plugins + amount_post_plugins):
            found = False
            for value in return_values:
                if value[1][0] == "data_{0}_A".format(i) and value[1][1] == "data_{0}_B".format(i):
                    found = True
                    break
            assert found is True


1			import pytest
			0 ignored issues – show Coding Style introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report Unable to import 'pytest' Loading history...
2
3
4			def test_signal_registration(basicApp):
			0 ignored issues – show Coding Style Naming introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
5			plugin = basicApp.plugins.get("BasicPlugin")
6			signals = plugin.signals.get()
7			assert len(signals.keys()) == 1
8			assert "test" in signals.keys()
9
10
11			def test_signal_send(basicApp):
			0 ignored issues – show Coding Style Naming introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
12			answers = basicApp.signals.send("test", basicApp, text="test")
13			assert len(answers) == 1
14			assert isinstance(answers, list)
15			assert len(answers[0]) == 2
16			assert isinstance(answers[0], tuple)
17			assert answers[0][1] == {'text': 'test'}
18
19
20			def test_signal_connect(basicApp):
			0 ignored issues – show Coding Style Naming introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
21			def _test_command(plugin, **kwargs):
			0 ignored issues – show Unused Code introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The argument `plugin` seems to be unused. Loading history... Unused Code introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The argument `kwargs` seems to be unused. Loading history...
22			return "12345"
23
24			plugin = basicApp.plugins.get("BasicPlugin")
25			plugin.signals.connect("12345 receiver", "test", _test_command, "receiver 12345 for test")
26			answers = plugin.signals.send("test")
27			assert len(answers) == 2
28			for answer in answers:
29			if answer[0] == _test_command:
30			assert answer[1] == "12345"
31
32
33			def test_signal_disconnect(basicApp):
			0 ignored issues – show Coding Style Naming introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report The name `basicApp` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2017-09-19 14:07 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
34			def _test_command(plugin, **kwargs):

useblocks / groundwork

Push — master ( 0b984b...b1484e )

func_template() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like