Completed
Pull Request — master (#303)
by Björn
22:48
created

AsyncioEventLoop._stop()   A

Complexity

Conditions 1

Size

Total Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
c 0
b 0
f 0
dl 0
loc 2
ccs 1
cts 1
cp 1
crap 1
rs 10
1
"""Event loop implementation that uses the `asyncio` standard module.
2
3
The `asyncio` module was added to python standard library on 3.4, and it
4
provides a pure python implementation of an event loop library. It is used
5
as a fallback in case pyuv is not available(on python implementations other
6
than CPython).
7
8
Earlier python versions are supported through the `trollius` package, which
9
is a backport of `asyncio` that works on Python 2.6+.
10
"""
11 5
from __future__ import absolute_import
12
13 5
import os
14 5
import sys
15 5
from collections import deque
16
17 5
try:
18
    # For python 3.4+, use the standard library module
19 5
    import asyncio
20 3
except (ImportError, SyntaxError):
21
    # Fallback to trollius
22 3
    import trollius as asyncio
0 ignored issues
show
Configuration introduced by
The import trollius could not be resolved.

This can be caused by one of the following:

1. Missing Dependencies

This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands.

# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version.

2. Missing __init__.py files

This error could also result from missing __init__.py files in your module folders. Make sure that you place one file in each sub-folder.

Loading history...
23
24 5
from .base import BaseEventLoop
25
26
27 5
loop_cls = asyncio.SelectorEventLoop
28 5
if os.name == 'nt':
29
    # On windows use ProactorEventLoop which support pipes and is backed by the
30
    # more powerful IOCP facility
31
    loop_cls = asyncio.ProactorEventLoop
32
33
34 5
class AsyncioEventLoop(BaseEventLoop, asyncio.Protocol,
35
                       asyncio.SubprocessProtocol):
36
37
    """`BaseEventLoop` subclass that uses `asyncio` as a backend."""
38
39 5
    def connection_made(self, transport):
40
        """Used to signal `asyncio.Protocol` of a successful connection."""
41 5
        self._transport = transport
0 ignored issues
show
Coding Style introduced by
The attribute _transport was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
42 5
        self._raw_transport = transport
0 ignored issues
show
Coding Style introduced by
The attribute _raw_transport was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
43 5
        if isinstance(transport, asyncio.SubprocessTransport):
44
            self._transport = transport.get_pipe_transport(0)
0 ignored issues
show
Coding Style introduced by
The attribute _transport was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
45 5
46
    def connection_lost(self, exc):
47
        """Used to signal `asyncio.Protocol` of a lost connection."""
48
        self._on_error(exc.args[0] if exc else 'EOF')
49 5
50
    def data_received(self, data):
51
        """Used to signal `asyncio.Protocol` of incoming data."""
52
        if self._on_data:
53
            self._on_data(data)
54
            return
55
        self._queued_data.append(data)
56 5
57
    def pipe_connection_lost(self, fd, exc):
58 4
        """Used to signal `asyncio.SubprocessProtocol` of a lost connection."""
59
        self._on_error(exc.args[0] if exc else 'EOF')
60 5
61
    def pipe_data_received(self, fd, data):
62 5
        """Used to signal `asyncio.SubprocessProtocol` of incoming data."""
63 4
        if fd == 2:  # stderr fd number
64 5
            self._on_stderr(data)
0 ignored issues
show
Bug introduced by
The Instance of AsyncioEventLoop does not seem to have a member named _on_stderr.

This check looks for calls to members that are non-existent. These calls will fail.

The member could have been renamed or removed.

Loading history...
65 5
        elif self._on_data:
66
            self._on_data(data)
67
        else:
68
            self._queued_data.append(data)
69 5
70
    def process_exited(self):
71
        """Used to signal `asyncio.SubprocessProtocol` when the child exits."""
72
        self._on_error('EOF')
73 5
74 5
    def _init(self):
75 5
        self._loop = loop_cls()
0 ignored issues
show
Coding Style introduced by
The attribute _loop was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
76 5
        self._queued_data = deque()
0 ignored issues
show
Coding Style introduced by
The attribute _queued_data was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
77
        self._fact = lambda: self
0 ignored issues
show
Coding Style introduced by
The attribute _fact was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
78 5
        self._raw_transport = None
0 ignored issues
show
Coding Style introduced by
The attribute _raw_transport was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
79
80
    def _connect_tcp(self, address, port):
81
        coroutine = self._loop.create_connection(self._fact, address, port)
82 5
        self._loop.run_until_complete(coroutine)
83
84
    def _connect_socket(self, path):
85
        if os.name == 'nt':
86
            coroutine = self._loop.create_pipe_connection(self._fact, path)
87
        else:
88
            coroutine = self._loop.create_unix_connection(self._fact, path)
89 5
        self._loop.run_until_complete(coroutine)
90
91
    def _connect_stdio(self):
92
        coroutine = self._loop.connect_read_pipe(self._fact, sys.stdin)
93 1
        self._loop.run_until_complete(coroutine)
94
        coroutine = self._loop.connect_write_pipe(self._fact, sys.stdout)
95 5
        self._loop.run_until_complete(coroutine)
96 5
97 5
    def _connect_child(self, argv):
98
        self._child_watcher = asyncio.get_child_watcher()
0 ignored issues
show
Coding Style introduced by
The attribute _child_watcher was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
99 5
        self._child_watcher.attach_loop(self._loop)
100 5
        coroutine = self._loop.subprocess_exec(self._fact, *argv)
101
        self._loop.run_until_complete(coroutine)
102 5
103 5
    def _start_reading(self):
104
        pass
105 5
106 5
    def _send(self, data):
107
        self._transport.write(data)
108 5
109
    def _run(self):
110 5
        while self._queued_data:
111 5
            self._on_data(self._queued_data.popleft())
112
        self._loop.run_forever()
113 5
114 5
    def _stop(self):
115
        self._loop.stop()
116 5
117 5
    def _close(self):
118
        if self._raw_transport is not None:
119
            self._raw_transport.close()
120
        self._loop.close()
121
122 5
    def _threadsafe_call(self, fn):
123 5
        self._loop.call_soon_threadsafe(fn)
124 5
125
    def _setup_signals(self, signals):
126 5
        if os.name == 'nt':
127 5
            # add_signal_handler is not supported in win32
128 5
            self._signals = []
0 ignored issues
show
Coding Style introduced by
The attribute _signals was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
129
            return
130
131
        self._signals = list(signals)
0 ignored issues
show
Coding Style introduced by
The attribute _signals was defined outside __init__.

It is generally a good practice to initialize all attributes to default values in the __init__ method:

class Foo:
    def __init__(self, x=None):
        self.x = x
Loading history...
132
        for signum in self._signals:
133
            self._loop.add_signal_handler(signum, self._on_signal, signum)
134
135
    def _teardown_signals(self):
136
        for signum in self._signals:
137
            self._loop.remove_signal_handler(signum)
138