AsyncioEventLoop._setup_signals() - Code Metrics - Inspection of "WIP: reimplement stdio on windows" - neovim/python-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#307)

by Björn

created 2018-03-05 18:22 UTC

AsyncioEventLoop._setup_signals() A

↳ Parent: AsyncioEventLoop

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
c	1
b	0
f	0
dl	0
loc	9
ccs	0
cts	0
cp	0
crap	12
rs	9.6666

"""Event loop implementation that uses the `asyncio` standard module.

The `asyncio` module was added to python standard library on 3.4, and it
provides a pure python implementation of an event loop library. It is used
as a fallback in case pyuv is not available(on python implementations other
than CPython).

Earlier python versions are supported through the `trollius` package, which
is a backport of `asyncio` that works on Python 2.6+.
"""
from __future__ import absolute_import

import os
import sys
from collections import deque

try:
    # For python 3.4+, use the standard library module
    import asyncio
except (ImportError, SyntaxError):
    # Fallback to trollius
    import trollius as asyncio
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from .base import BaseEventLoop


loop_cls = asyncio.SelectorEventLoop
if os.name == 'nt':
    # On windows use ProactorEventLoop which support pipes and is backed by the
    # more powerful IOCP facility
    # NOTE: we override in the stdio case, because it doesn't work.
    loop_cls = asyncio.ProactorEventLoop

    import msvcrt
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
    from ctypes import windll, byref, wintypes, GetLastError, WinError

    from ctypes.wintypes import HANDLE, DWORD, POINTER, BOOL


    LPDWORD = POINTER(DWORD)

    PIPE_NOWAIT = wintypes.DWORD(0x00000001)

    ERROR_NO_DATA = 232

    def pipe_no_wait(pipefd):
        SetNamedPipeHandleState = windll.kernel32.SetNamedPipeHandleState
        SetNamedPipeHandleState.argtypes = [HANDLE, LPDWORD, LPDWORD, LPDWORD]
        SetNamedPipeHandleState.restype = BOOL

        h = msvcrt.get_osfhandle(pipefd)

        res = windll.kernel32.SetNamedPipeHandleState(h, byref(PIPE_NOWAIT), None, None)
        if res == 0:
            print(WinError())
            return False
        return True

class AsyncioEventLoop(BaseEventLoop, asyncio.Protocol,
                       asyncio.SubprocessProtocol):

    """`BaseEventLoop` subclass that uses `asyncio` as a backend."""

    def connection_made(self, transport):
        """Used to signal `asyncio.Protocol` of a successful connection."""
        self._transport = transport
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._raw_transport = transport
class Foo:
    def __init__(self, x=None):
        self.x = x
        if isinstance(transport, asyncio.SubprocessTransport):
            self._transport = transport.get_pipe_transport(0)
class Foo:
    def __init__(self, x=None):
        self.x = x

    def connection_lost(self, exc):
        """Used to signal `asyncio.Protocol` of a lost connection."""
        self._on_error(exc.args[0] if exc else 'EOF')

    def data_received(self, data):
        """Used to signal `asyncio.Protocol` of incoming data."""
        if self._on_data:
            self._on_data(data)
            return
        self._queued_data.append(data)

    def pipe_connection_lost(self, fd, exc):
        """Used to signal `asyncio.SubprocessProtocol` of a lost connection."""
        self._on_error(exc.args[0] if exc else 'EOF')

    def pipe_data_received(self, fd, data):
        """Used to signal `asyncio.SubprocessProtocol` of incoming data."""
        if fd == 2:  # stderr fd number
            self._on_stderr(data)

        elif self._on_data:
            self._on_data(data)
        else:
            self._queued_data.append(data)

    def process_exited(self):
        """Used to signal `asyncio.SubprocessProtocol` when the child exits."""
        self._on_error('EOF')

    def _init(self):
        self._queued_data = deque()
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._fact = lambda: self
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._raw_transport = None
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._raw_stdio = False
class Foo:
    def __init__(self, x=None):
        self.x = x

    def _connect_tcp(self, address, port):
        self._loop = loop_cls()
class Foo:
    def __init__(self, x=None):
        self.x = x
        coroutine = self._loop.create_connection(self._fact, address, port)
        self._loop.run_until_complete(coroutine)

    def _connect_socket(self, path):
        self._loop = loop_cls()
class Foo:
    def __init__(self, x=None):
        self.x = x
        if os.name == 'nt':
            coroutine = self._loop.create_pipe_connection(self._fact, path)
        else:
            coroutine = self._loop.create_unix_connection(self._fact, path)
        self._loop.run_until_complete(coroutine)

    def _on_stdin(self):
        data = sys.stdin.buffer.read(1)
        self.data_received(data)

    def _connect_stdio(self):
        if True or os.name == "nt":
            # work around broken windows implementation
            self._loop = asyncio.SelectorEventLoop()
class Foo:
    def __init__(self, x=None):
        self.x = x
            self._raw_stdio = True
class Foo:
    def __init__(self, x=None):
        self.x = x
            self._loop.add_reader(sys.stdin.fileno(), self._on_stdin)
            if os.name == "nt":
                pipe_no_wait(sys.stdin.fileno())
            else:
                import fcntl
                orig_fl = fcntl.fcntl(sys.stdin.fileno(), fcntl.F_GETFL)
                fcntl.fcntl(sys.stdin.fileno(), fcntl.F_SETFL, orig_fl | os.O_NONBLOCK)
        else:
            self._loop = loop_cls()
class Foo:
    def __init__(self, x=None):
        self.x = x
            coroutine = self._loop.connect_read_pipe(self._fact, sys.stdin)
            self._loop.run_until_complete(coroutine)
            coroutine = self._loop.connect_write_pipe(self._fact, sys.stdout)
            self._loop.run_until_complete(coroutine)

    def _connect_child(self, argv):
        self._loop = loop_cls()
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._child_watcher = asyncio.get_child_watcher()
class Foo:
    def __init__(self, x=None):
        self.x = x
        self._child_watcher.attach_loop(self._loop)
        coroutine = self._loop.subprocess_exec(self._fact, *argv)
        self._loop.run_until_complete(coroutine)

    def _start_reading(self):
        pass

    def _send(self, data):
        if self._raw_stdio:
            sys.stdout.buffer.write(data)
        else:
            self._transport.write(data)

    def _run(self):
        while self._queued_data:
            self._on_data(self._queued_data.popleft())
        self._loop.run_forever()

    def _stop(self):
        self._loop.stop()

    def _close(self):
        if self._raw_transport is not None:
            self._raw_transport.close()
        self._loop.close()

    def _threadsafe_call(self, fn):
        self._loop.call_soon_threadsafe(fn)

    def _setup_signals(self, signals):
        if os.name == 'nt':
            # add_signal_handler is not supported in win32
            self._signals = []
class Foo:
    def __init__(self, x=None):
        self.x = x
            return

        self._signals = list(signals)
class Foo:
    def __init__(self, x=None):
        self.x = x
        for signum in self._signals:
            self._loop.add_signal_handler(signum, self._on_signal, signum)

    def _teardown_signals(self):
        for signum in self._signals:
            self._loop.remove_signal_handler(signum)


Pull Request — master (#307)

AsyncioEventLoop._setup_signals() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

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 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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		# NOTE: we override in the stdio case, because it doesn't work.
32		loop_cls = asyncio.ProactorEventLoop
33
34	5	import msvcrt
		0 ignored issues – show Configuration introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report The import `msvcrt` 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...
35		from ctypes import windll, byref, wintypes, GetLastError, WinError
		0 ignored issues – show Unused Code introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report Unused GetLastError imported from ctypes Loading history...
36		from ctypes.wintypes import HANDLE, DWORD, POINTER, BOOL
		0 ignored issues – show Bug introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report The name `POINTER` does not seem to exist in module `ctypes.wintypes`. Loading history...
37
38		LPDWORD = POINTER(DWORD)
39	5
40		PIPE_NOWAIT = wintypes.DWORD(0x00000001)
41	5
42	5	ERROR_NO_DATA = 232
43	5
44		def pipe_no_wait(pipefd):
45	5	SetNamedPipeHandleState = windll.kernel32.SetNamedPipeHandleState
46		SetNamedPipeHandleState.argtypes = [HANDLE, LPDWORD, LPDWORD, LPDWORD]
47		SetNamedPipeHandleState.restype = BOOL
48
49	5	h = msvcrt.get_osfhandle(pipefd)
50
51		res = windll.kernel32.SetNamedPipeHandleState(h, byref(PIPE_NOWAIT), None, None)
52		if res == 0:
53		print(WinError())
54		return False
55		return True
56	5
57		class AsyncioEventLoop(BaseEventLoop, asyncio.Protocol,
58	4	asyncio.SubprocessProtocol):
59
60	5	"""`BaseEventLoop` subclass that uses `asyncio` as a backend."""
61
62	5	def connection_made(self, transport):
63	4	"""Used to signal `asyncio.Protocol` of a successful connection."""
64	5	self._transport = transport
		0 ignored issues – show Coding Style introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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...
65	5	self._raw_transport = transport
		0 ignored issues – show Coding Style introduced 2018-02-27 20:13 UTC by Report Bug Copy Issue Report 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...
66		if isinstance(transport, asyncio.SubprocessTransport):
67		self._transport = transport.get_pipe_transport(0)
		0 ignored issues – show Coding Style introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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...
68
69	5	def connection_lost(self, exc):
70		"""Used to signal `asyncio.Protocol` of a lost connection."""
71		self._on_error(exc.args[0] if exc else 'EOF')
72
73	5	def data_received(self, data):
74	5	"""Used to signal `asyncio.Protocol` of incoming data."""
75	5	if self._on_data:
76	5	self._on_data(data)
77		return
78	5	self._queued_data.append(data)
79
80		def pipe_connection_lost(self, fd, exc):
81		"""Used to signal `asyncio.SubprocessProtocol` of a lost connection."""
82	5	self._on_error(exc.args[0] if exc else 'EOF')
83
84		def pipe_data_received(self, fd, data):
85		"""Used to signal `asyncio.SubprocessProtocol` of incoming data."""
86		if fd == 2: # stderr fd number
87		self._on_stderr(data)
		0 ignored issues – show Bug introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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...
88		elif self._on_data:
89	5	self._on_data(data)
90		else:
91		self._queued_data.append(data)
92
93	1	def process_exited(self):
94		"""Used to signal `asyncio.SubprocessProtocol` when the child exits."""
95	5	self._on_error('EOF')
96	5
97	5	def _init(self):
98		self._queued_data = deque()
		0 ignored issues – show Coding Style introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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...
99	5	self._fact = lambda: self
		0 ignored issues – show Coding Style introduced 2018-02-27 20:38 UTC by Report Bug Copy Issue Report 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...
100	5	self._raw_transport = None
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
101		self._raw_stdio = False
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report The attribute `_raw_stdio` 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...
102	5
103	5	def _connect_tcp(self, address, port):
104		self._loop = loop_cls()
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
105	5	coroutine = self._loop.create_connection(self._fact, address, port)
106	5	self._loop.run_until_complete(coroutine)
107
108	5	def _connect_socket(self, path):
109		self._loop = loop_cls()
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
110	5	if os.name == 'nt':
111	5	coroutine = self._loop.create_pipe_connection(self._fact, path)
112		else:
113	5	coroutine = self._loop.create_unix_connection(self._fact, path)
114	5	self._loop.run_until_complete(coroutine)
115
116	5	def _on_stdin(self):
117	5	data = sys.stdin.buffer.read(1)
118		self.data_received(data)
119
120		def _connect_stdio(self):
121		if True or os.name == "nt":
122	5	# work around broken windows implementation
123	5	self._loop = asyncio.SelectorEventLoop()
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
124	5	self._raw_stdio = True
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report The attribute `_raw_stdio` 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...
125		self._loop.add_reader(sys.stdin.fileno(), self._on_stdin)
126	5	if os.name == "nt":
127	5	pipe_no_wait(sys.stdin.fileno())
128	5	else:
129		import fcntl
130		orig_fl = fcntl.fcntl(sys.stdin.fileno(), fcntl.F_GETFL)
131		fcntl.fcntl(sys.stdin.fileno(), fcntl.F_SETFL, orig_fl \| os.O_NONBLOCK)
132		else:
133		self._loop = loop_cls()
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
134		coroutine = self._loop.connect_read_pipe(self._fact, sys.stdin)
135		self._loop.run_until_complete(coroutine)
136		coroutine = self._loop.connect_write_pipe(self._fact, sys.stdout)
137		self._loop.run_until_complete(coroutine)
138
139		def _connect_child(self, argv):
140		self._loop = loop_cls()
		0 ignored issues – show Coding Style introduced 2018-03-05 18:43 UTC by Report Bug Copy Issue Report 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...
141		self._child_watcher = asyncio.get_child_watcher()
		0 ignored issues – show Coding Style introduced 2017-01-08 20:41 UTC by Report Bug Copy Issue Report 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...
142		self._child_watcher.attach_loop(self._loop)
143		coroutine = self._loop.subprocess_exec(self._fact, *argv)
144		self._loop.run_until_complete(coroutine)
145
146		def _start_reading(self):
147		pass
148
149		def _send(self, data):
150		if self._raw_stdio:
151		sys.stdout.buffer.write(data)
152		else:
153		self._transport.write(data)
154
155		def _run(self):
156		while self._queued_data:
157		self._on_data(self._queued_data.popleft())
158		self._loop.run_forever()
159
160		def _stop(self):
161		self._loop.stop()
162
163		def _close(self):
164		if self._raw_transport is not None:
165		self._raw_transport.close()
166		self._loop.close()
167
168		def _threadsafe_call(self, fn):
169		self._loop.call_soon_threadsafe(fn)
170
171		def _setup_signals(self, signals):
172		if os.name == 'nt':
173		# add_signal_handler is not supported in win32
174		self._signals = []
		0 ignored issues – show Coding Style introduced 2016-02-15 16:00 UTC by Report Bug Copy Issue Report 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...
175		return
176
177		self._signals = list(signals)
		0 ignored issues – show Coding Style introduced 2015-12-02 06:47 UTC by Report Bug Copy Issue Report 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...
178		for signum in self._signals:
179		self._loop.add_signal_handler(signum, self._on_signal, signum)
180
181		def _teardown_signals(self):
182		for signum in self._signals:
183		self._loop.remove_signal_handler(signum)
184

neovim / python-client

Pull Request — master (#307)

AsyncioEventLoop._setup_signals() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files