1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# Copyright 2022 Scott K Logan
# Licensed under the Apache License, Version 2.0
from asyncio.events import AbstractEventLoop
from asyncio.events import get_event_loop
from asyncio.futures import Future
from asyncio.protocols import Protocol
from asyncio.transports import BaseTransport
from typing import Any
from typing import Optional
import warnings
import xml.etree.ElementTree as Et
from aioraven.device import RAVEnWarning
from aioraven.device import UnknownRAVEnCommandWarning
from aioraven.reader import RAVEnReader
class RAVEnReaderProtocol(Protocol):
"""Deserialize data fragments from a RAVEn device."""
_closed: Future[None]
_reader: Optional[RAVEnReader]
_stash: bytes
def __init__(
self,
reader: RAVEnReader,
loop: Optional[AbstractEventLoop] = None,
) -> None:
"""
Construct a RAVEnRaderProtocol.
:param reader: The `RAVEnReader` instance to which deserialized
fragments are passed.
:param loop: The event loop instance to use.
"""
if loop is None:
self._loop = get_event_loop()
else:
self._loop = loop
self._reader = reader
self._closed = self._loop.create_future()
def _reset(self) -> None:
self._parser = Et.XMLPullParser(events=('end',))
self._parser.feed(b'<?xml version="1.0" encoding="ASCII"?><root>')
self._stash = b''
def _get_close_waiter(self, stream: Any) -> Future[None]:
return self._closed
def connection_made(self, transport: BaseTransport) -> None:
self._reset()
def connection_lost(self, exc: Optional[Exception]) -> None:
if self._reader is not None:
if exc is None:
self._reader.feed_eof()
else:
self._reader.set_exception(exc)
if not self._closed.done():
if exc is None:
self._closed.set_result(None)
else:
self._closed.set_exception(exc)
self._reader = None
def data_received(self, data: bytes) -> None:
if not self._reader:
return
self._stash += data
if b'>' not in data:
return
self._parser.feed(self._stash)
self._stash = b''
events = self._parser.read_events()
while True:
try:
_, element = next(events)
except StopIteration:
return
except Et.ParseError as err:
self._reader.set_exception(err)
self._reset()
else:
if element.tag == 'Warning':
try:
e = next(iter(element), None)
if e is not None and e.text is not None:
if e.text == UnknownRAVEnCommandWarning.MESSAGE:
warnings.warn(UnknownRAVEnCommandWarning())
else:
warnings.warn(RAVEnWarning(e.text))
else:
warnings.warn(RAVEnWarning('Unknown warning'))
except Warning as err:
self._reader.set_exception(err)
else:
self._reader.feed_element(element)
def eof_received(self) -> None:
if not self._reader:
return
self._parser.feed(b'</root>')
try:
self._parser.close()
except Et.ParseError as err:
self._reader.set_exception(err)
finally:
self._reader.feed_eof()
def __del__(self) -> None:
try:
closed = self._closed
except AttributeError:
pass
else:
if closed.done() and not closed.cancelled():
closed.exception()
|
