-
Notifications
You must be signed in to change notification settings - Fork 118
/
base.py
905 lines (772 loc) · 29.9 KB
/
base.py
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
# python-mpd2: Python MPD client library
#
# Copyright (C) 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
# Copyright (C) 2012 J. Thalheim <jthalheim@gmail.com>
# Copyright (C) 2016 Robert Niederreiter <rnix@squarewave.at>
#
# python-mpd2 is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# python-mpd2 is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with python-mpd2. If not, see <http://www.gnu.org/licenses/>.
import logging
import re
import socket
import sys
import warnings
from enum import Enum
from typing import (IO, Any, Callable, Dict, Iterator, List, Optional, Tuple, Iterable,
Type, Union)
VERSION = (3, 1, 1)
HELLO_PREFIX = "OK MPD "
ERROR_PREFIX = "ACK "
ERROR_PATTERN = re.compile(
r"\[(?P<errno>\d+)@(?P<offset>\d+)\]\s+{(?P<command>\w+)}\s+(?P<msg>.*)"
)
SUCCESS = "OK"
NEXT = "list_OK"
def escape(text: str) -> str:
return text.replace("\\", "\\\\").replace('"', '\\"')
from logging import NullHandler
logger = logging.getLogger(__name__)
logger.addHandler(NullHandler())
# MPD Protocol errors as found in CommandError exceptions
# https://github.com/MusicPlayerDaemon/MPD/blob/master/src/protocol/Ack.hxx
class FailureResponseCode(Enum):
NOT_LIST = 1
ARG = 2
PASSWORD = 3
PERMISSION = 4
UNKNOWN = 5
NO_EXIST = 50
PLAYLIST_MAX = 51
SYSTEM = 52
PLAYLIST_LOAD = 53
UPDATE_ALREADY = 54
PLAYER_SYNC = 55
EXIST = 56
class MPDError(Exception):
pass
class ConnectionError(MPDError):
pass
class ProtocolError(MPDError):
pass
class CommandError(MPDError):
def __init__(self, error: str) -> None:
self.errno = None
self.offset = None
self.command = None
self.msg = None
match = ERROR_PATTERN.match(error)
if match:
self.errno = FailureResponseCode(int(match.group("errno")))
self.offset = int(match.group("offset"))
self.command = match.group("command")
self.msg = match.group("msg")
class CommandListError(MPDError):
pass
class PendingCommandError(MPDError):
pass
class IteratingError(MPDError):
pass
class CallableWithCommands:
mpd_commands: Tuple[str, ...] = ()
mpd_commands_direct: bool = False
mpd_commands_binary: bool = False
def __call__(self, *args: Any) -> Any:
pass
class mpd_commands:
"""Decorator for registering MPD commands with it's corresponding result
callback.
"""
def __init__(self, *commands: str, **kwargs: bool) -> None:
self.commands = commands
self.is_direct = kwargs.pop("is_direct", False)
self.is_binary = kwargs.pop("is_binary", False)
if kwargs:
raise AttributeError(
"mpd_commands() got unexpected keyword"
" arguments %s" % ",".join(kwargs)
)
def __call__(self, ob: Any) -> CallableWithCommands:
ob.mpd_commands = self.commands
ob.mpd_commands_direct = self.is_direct
ob.mpd_commands_binary = self.is_binary
return ob
class Noop(object):
"""An instance of this class represents a MPD command callback which
does nothing.
"""
mpd_commands = None
class MPDClientBase:
"""Abstract MPD client.
This class defines a general client contract, provides MPD protocol parsers
and defines all available MPD commands and it's corresponding result
parsing callbacks. There might be the need of overriding some callbacks on
subclasses.
"""
def __init__(self, use_unicode: Optional[bool] = None) -> None:
self.iterate = False
if use_unicode is not None:
warnings.warn(
"use_unicode parameter to ``MPDClientBase`` constructor is "
"deprecated",
DeprecationWarning,
stacklevel=2,
)
self._reset()
@property
def use_unicode(self) -> bool:
warnings.warn(
"``use_unicode`` is deprecated: python-mpd 2.x always uses " "Unicode",
DeprecationWarning,
stacklevel=2,
)
return True
@classmethod
def add_command(cls, name: str, callback: Any) -> None:
raise NotImplementedError(
"Abstract ``MPDClientBase`` does not implement ``add_command``"
)
def noidle(self) -> None:
raise NotImplementedError(
"Abstract ``MPDClientBase`` does not implement ``noidle``"
)
def command_list_ok_begin(self) -> None:
raise NotImplementedError(
"Abstract ``MPDClientBase`` does not implement " "``command_list_ok_begin``"
)
def command_list_end(self) -> None:
raise NotImplementedError(
"Abstract ``MPDClientBase`` does not implement " "``command_list_end``"
)
def _reset(self) -> None:
self.mpd_version: Optional[str] = None
self._command_list: Optional[list[Any]] = None
def _parse_pair(self, line: str, separator: str = ": ") -> List[str]:
pair = line.split(separator, 1)
if len(pair) < 2:
raise ProtocolError("Could not parse pair: '{}'".format(line))
return pair
def _parse_pairs(
self, lines: Iterable[str], separator: str = ": "
) -> Iterator[List[str]]:
for line in lines:
yield self._parse_pair(line, separator)
def _parse_objects(
self,
lines: Iterable[str],
delimiters: List[str] = [],
lookup_delimiter: bool = False,
) -> Iterator[Dict[str, str]]:
obj: Dict[str, Any] = {}
for key, value in self._parse_pairs(lines):
key = key.lower()
if lookup_delimiter and key not in delimiters:
delimiters = delimiters + [key]
if obj:
if key in delimiters:
if lookup_delimiter:
if key in obj:
yield obj
obj = obj.copy()
while delimiters[-1] != key:
obj.pop(delimiters[-1], None)
delimiters.pop()
else:
yield obj
obj = {}
elif key in obj:
if not isinstance(obj[key], list):
obj[key] = [obj[key], value]
else:
obj[key].append(value)
continue
obj[key] = value
if obj:
yield obj
# Use this instead of _parse_objects whenever the result is returned
# immediately in a command implementation
_parse_objects_direct = _parse_objects
def _parse_raw_stickers(self, lines: Iterable[str]) -> Iterator[Tuple[str, str]]:
for _, sticker in self._parse_pairs(lines):
value = sticker.split("=", 1)
if len(value) != 2:
raise ProtocolError("Could not parse sticker: {}".format(repr(sticker)))
yield value[0], value[1]
NOOP = mpd_commands("close", "kill")(Noop())
@mpd_commands("plchangesposid", is_direct=True)
def _parse_changes(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["cpos"])
@mpd_commands("listall", "listallinfo", "listfiles", "lsinfo", is_direct=True)
def _parse_database(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["file", "directory", "playlist"])
@mpd_commands("idle")
def _parse_idle(self, lines: List[str]) -> Iterator[str]:
return self._parse_list(lines)
@mpd_commands("addid", "config", "replay_gain_status", "rescan", "update")
def _parse_item(self, lines: List[str]) -> Optional[str]:
pairs = list(self._parse_pairs(lines))
if len(pairs) != 1:
return None
return pairs[0][1]
@mpd_commands(
"channels", "commands", "listplaylist", "notcommands", "tagtypes", "urlhandlers"
)
def _parse_list(self, lines: List[str]) -> Iterator[str]:
seen = None
for key, value in self._parse_pairs(lines):
if key != seen:
if seen is not None:
raise ProtocolError("Expected key '{}', got '{}'".format(seen, key))
seen = key
yield value
@mpd_commands("list", is_direct=True)
def _parse_list_groups(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, lookup_delimiter=True)
@mpd_commands("readmessages", is_direct=True)
def _parse_messages(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["channel"])
@mpd_commands("listmounts", is_direct=True)
def _parse_mounts(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["mount"])
@mpd_commands("listneighbors", is_direct=True)
def _parse_neighbors(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["neighbor"])
@mpd_commands("listpartitions", is_direct=True)
def _parse_partitions(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["partition"])
@mpd_commands(
"add",
"addtagid",
"binarylimit",
"clear",
"clearerror",
"cleartagid",
"consume",
"crossfade",
"delete",
"deleteid",
"delpartition",
"disableoutput",
"enableoutput",
"findadd",
"load",
"mixrampdb",
"mixrampdelay",
"mount",
"move",
"moveid",
"moveoutput",
"newpartition",
"next",
"outputvolume",
"partition",
"password",
"pause",
"ping",
"play",
"playid",
"playlistadd",
"playlistclear",
"playlistdelete",
"playlistmove",
"previous",
"prio",
"prioid",
"random",
"rangeid",
"rename",
"repeat",
"replay_gain_mode",
"rm",
"save",
"searchadd",
"searchaddpl",
"seek",
"seekcur",
"seekid",
"sendmessage",
"setvol",
"shuffle",
"single",
"sticker delete",
"sticker set",
"stop",
"subscribe",
"swap",
"swapid",
"toggleoutput",
"unmount",
"unsubscribe",
"volume",
)
def _parse_nothing(self, lines: List[str]) -> None:
for line in lines:
raise ProtocolError(
"Got unexpected return value: '{}'".format(", ".join(lines))
)
@mpd_commands("count", "currentsong", "readcomments", "stats", "status")
def _parse_object(self, lines: List[str]) -> Dict[str, str]:
try:
return next(self._parse_objects(lines))
except StopIteration:
return {}
@mpd_commands("outputs", is_direct=True)
def _parse_outputs(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["outputid"])
@mpd_commands("playlist")
def _parse_playlist(self, lines: List[str]) -> Iterator[str]:
for key, value in self._parse_pairs(lines, ":"):
yield value
@mpd_commands("listplaylists", is_direct=True)
def _parse_playlists(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["playlist"])
@mpd_commands("decoders", is_direct=True)
def _parse_plugins(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["plugin"])
@mpd_commands(
"find",
"listplaylistinfo",
"playlistfind",
"playlistid",
"playlistinfo",
"playlistsearch",
"plchanges",
"search",
"sticker find",
is_direct=True,
)
def _parse_songs(self, lines: List[str]) -> Iterator[Dict[str, str]]:
return self._parse_objects_direct(lines, ["file"])
@mpd_commands("sticker get")
def _parse_sticker(self, lines: List[str]) -> str:
key, value = list(self._parse_raw_stickers(lines))[0]
return value
@mpd_commands("sticker list")
def _parse_stickers(self, lines: List[str]) -> Dict[str, str]:
return dict(self._parse_raw_stickers(lines))
@mpd_commands("albumart", "readpicture", is_binary=True)
def _parse_plain_binary(self, structure: Any) -> Any:
return structure
def mpd_command_provider(cls: Type[MPDClientBase]) -> Type[MPDClientBase]:
"""Decorator hooking up registered MPD commands to concrete client
implementation.
A class using this decorator must inherit from ``MPDClientBase`` and
implement it's ``add_command`` function.
"""
def collect(
cls: Any, callbacks: Dict[str, Tuple[Any, Any]] = {}
) -> Dict[str, Tuple[Any, Any]]:
"""Collect MPD command callbacks from given class.
Searches class __dict__ on given class and all it's bases for functions
which have been decorated with @mpd_commands and returns a dict
containing callback name as keys and
(callback, callback implementing class) tuples as values.
"""
for name, ob in cls.__dict__.items():
if hasattr(ob, "mpd_commands") and name not in callbacks:
callbacks[name] = (ob, cls)
for base in cls.__bases__:
callbacks = collect(base, callbacks)
return callbacks
for name, value in collect(cls).items():
callback, from_ = value
for command in callback.mpd_commands:
cls.add_command(command, callback)
return cls
def _create_callback(
self: Any, function: Callable[[Any, Any], Any], wrap_result: bool
) -> Optional[Callable[[], Any]]:
"""Create MPD command related response callback."""
if not callable(function):
return None
def command_callback() -> Any:
# command result callback expects response from MPD as iterable lines,
# thus read available lines from socket
res = function(self, self._read_lines())
# wrap result in iterator helper if desired
if wrap_result:
res = self._wrap_iterator(res)
return res
return command_callback
def _create_command(
wrapper: Callable, name: str, return_value: Any, wrap_result: bool
) -> Callable:
"""Create MPD command related function."""
def mpd_command(self: Any, *args: Any) -> Any:
callback = _create_callback(self, return_value, wrap_result)
return wrapper(self, name, args, callback)
return mpd_command
class _NotConnected:
def __getattr__(self, attr: str) -> Callable:
return self._dummy
def _dummy(*args: Any) -> None:
raise ConnectionError("Not connected")
@mpd_command_provider
class MPDClient(MPDClientBase):
idletimeout = None
_timeout = None
_wrap_iterator_parsers = [
MPDClientBase._parse_list,
MPDClientBase._parse_list_groups,
MPDClientBase._parse_playlist,
MPDClientBase._parse_changes,
MPDClientBase._parse_songs,
MPDClientBase._parse_mounts,
MPDClientBase._parse_neighbors,
MPDClientBase._parse_partitions,
MPDClientBase._parse_playlists,
MPDClientBase._parse_database,
MPDClientBase._parse_messages,
MPDClientBase._parse_outputs,
MPDClientBase._parse_plugins,
]
def __init__(self, use_unicode: Optional[bool] = None) -> None:
if use_unicode is not None:
warnings.warn(
"use_unicode parameter to ``MPDClient`` constructor is " "deprecated",
DeprecationWarning,
stacklevel=2,
)
super().__init__()
def _reset(self) -> None:
super()._reset()
self._iterating = False
self._sock: Optional[socket.socket] = None
self._rbfile: Union[IO[bytes], _NotConnected] = _NotConnected()
self._wfile: Union[IO[str], _NotConnected] = _NotConnected()
def _execute(self, command: str, args: List[Any], retval: Any) -> Any:
if self._iterating:
raise IteratingError("Cannot execute '{}' while iterating".format(command))
if self._command_list is not None:
if not callable(retval):
raise CommandListError(
"'{}' not allowed in command list".format(command)
)
self._write_command(command, args)
self._command_list.append(retval)
else:
self._write_command(command, args)
if callable(retval):
return retval()
return retval
def _write_line(self, line: str) -> None:
try:
if self._wfile is _NotConnected:
raise ConnectionError("Not connected")
self._wfile.write("{}\n".format(line))
self._wfile.flush()
except socket.error:
error_message = "Connection to server was reset"
logger.info(error_message)
self._reset()
e = ConnectionError(error_message)
raise e.with_traceback(sys.exc_info()[2])
def _write_command(self, command: str, args: List[Any] = []) -> None:
parts = [command]
for arg in args:
if type(arg) is tuple:
if len(arg) == 0:
parts.append('":"')
elif len(arg) == 1:
parts.append('"{}:"'.format(int(arg[0])))
else:
parts.append('"{}:{}"'.format(int(arg[0]), int(arg[1])))
else:
parts.append('"{}"'.format(escape(str(arg))))
# Minimize logging cost if the logging is not activated.
if logger.isEnabledFor(logging.DEBUG):
if command == "password":
logger.debug("Calling MPD password(******)")
else:
logger.debug("Calling MPD %s%r", command, args)
cmd = " ".join(parts)
self._write_line(cmd)
def _read_line(self) -> Optional[str]:
line = self._rbfile.readline().decode("utf-8")
if not line.endswith("\n"):
self.disconnect()
raise ConnectionError("Connection lost while reading line")
line = line.rstrip("\n")
if line.startswith(ERROR_PREFIX):
error = line[len(ERROR_PREFIX) :].strip()
raise CommandError(error)
if self._command_list is not None:
if line == NEXT:
return None
if line == SUCCESS:
raise ProtocolError("Got unexpected '{}'".format(SUCCESS))
elif line == SUCCESS:
return None
return line
def _read_lines(self) -> Iterator[str]:
line = self._read_line()
while line is not None:
yield line
line = self._read_line()
def _read_chunk(self, amount: int) -> bytes:
chunk = bytearray()
while amount > 0:
result = self._rbfile.read(amount)
if len(result) == 0:
break
chunk.extend(result)
amount -= len(result)
return bytes(chunk)
def _read_binary(self) -> Dict[str, Union[str, bytes]]:
"""From the data stream, read Unicode lines until one says "binary:
<number>\\n"; at that point, read binary data of the given length.
This behaves like _parse_objects (with empty set of delimiters; even
returning only a single result), but rather than feeding from a lines
iterable (which would be preprocessed too far), it reads directly off
the stream."""
obj = {}
while True:
line = self._read_line()
if line is None:
break
value: Union[str, bytes]
key, value = self._parse_pair(line, ": ")
if key == "binary":
chunk_size = int(value)
value = self._read_chunk(chunk_size)
if len(value) != chunk_size:
self.disconnect()
raise ConnectionError(
"Connection lost while reading binary data: "
"expected %d bytes, got %d" % (chunk_size, len(value))
)
if self._rbfile.read(1) != b"\n":
# newline after binary content
self.disconnect()
raise ConnectionError("Connection lost while reading line")
obj[key] = value
return obj
def _execute_binary(
self, command: str, args: List[Any]
) -> Dict[str, Union[str, bytes]]:
"""Execute a command repeatedly with an additional offset argument,
keeping all the identical returned dictionary items and concatenating
the binary chunks following the binary item into one of exactly size.
This differs from _execute in that rather than passing the lines to the
callback which'd then call on something like _parse_objects, it builds
a parsed object on its own (as a prerequisite to the chunk driving
process) and then joins together the chunks into a single big response."""
if self._iterating or self._command_list is not None:
raise IteratingError(
"Cannot execute '{}' with command lists".format(command)
)
data = None
args = list(args)
assert len(args) == 1
args.append(0)
final_metadata = None
while True:
self._write_command(command, args)
metadata = self._read_binary()
chunk = metadata.pop("binary", None)
if final_metadata is None:
data = chunk
final_metadata = metadata
if not data:
break
try:
size = int(final_metadata["size"])
except KeyError:
if chunk is None:
raise CommandError(
"Binary field vanished changed during transfer"
)
size = len(chunk)
except ValueError:
raise CommandError("Size data unsuitable for binary transfer")
else:
if metadata != final_metadata:
raise CommandError(
"Metadata of binary data changed during transfer"
)
if chunk is None:
raise CommandError("Binary field vanished changed during transfer")
data += chunk
args[-1] = len(data)
if len(data) > size:
raise CommandListError("Binary data announced size exceeded")
elif len(data) == size:
break
if data is not None:
final_metadata["binary"] = data
final_metadata.pop("size", None)
return final_metadata
def _read_command_list(self) -> Iterator[Dict[str, str]]:
try:
if self._command_list is None:
raise CommandListError("Not in command list")
for retval in self._command_list:
yield retval()
finally:
self._command_list = None
self._parse_nothing(self._read_lines())
def _iterator_wrapper(
self, iterator: Iterator[Dict[str, str]]
) -> Iterator[Dict[str, str]]:
try:
for item in iterator:
yield item
finally:
self._iterating = False
def _wrap_iterator(
self, iterator: Iterator[Dict[str, str]]
) -> Iterator[Union[Dict[str, str], List[Dict[str, str]]]]:
if not self.iterate:
return list(iterator)
self._iterating = True
return self._iterator_wrapper(iterator)
def _hello(self, line: str) -> None:
if not line.endswith("\n"):
self.disconnect()
raise ConnectionError("Connection lost while reading MPD hello")
line = line.rstrip("\n")
if not line.startswith(HELLO_PREFIX):
raise ProtocolError("Got invalid MPD hello: '{}'".format(line))
self.mpd_version = line[len(HELLO_PREFIX) :].strip()
def _connect_unix(self, path: str) -> socket.socket:
if not hasattr(socket, "AF_UNIX"):
raise ConnectionError("Unix domain sockets not supported on this platform")
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
sock.settimeout(self.timeout)
sock.connect(path)
return sock
def _connect_tcp(self, host: str, port: int) -> socket.socket:
err = None
for res in socket.getaddrinfo(
host,
port,
socket.AF_UNSPEC,
socket.SOCK_STREAM,
socket.IPPROTO_TCP,
socket.AI_ADDRCONFIG,
):
af, socktype, proto, canonname, sa = res
sock = None
try:
sock = socket.socket(af, socktype, proto)
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
sock.settimeout(self.timeout)
sock.connect(sa)
return sock
except socket.error as e:
err = e
if sock is not None:
sock.close()
if err is not None:
raise err
else:
raise ConnectionError("getaddrinfo returns an empty list")
@mpd_commands("idle")
def _parse_idle(
self, lines: List[str]
) -> Iterator[Union[Dict[str, str], List[Dict[str, str]]]]:
if self._sock is not None:
self._sock.settimeout(self.idletimeout)
ret = self._wrap_iterator(self._parse_list(lines))
if self._sock is not None:
self._sock.settimeout(self._timeout)
return ret
@property
def timeout(self) -> Optional[float]:
return self._timeout
@timeout.setter
def timeout(self, timeout: Optional[float]) -> None:
self._timeout = timeout
if self._sock is not None:
self._sock.settimeout(timeout)
def connect(
self, host: str, port: Optional[int] = None, timeout: Optional[float] = None
) -> None:
logger.info("Calling MPD connect(%r, %r, timeout=%r)", host, port, timeout)
if self._sock is not None:
raise ConnectionError("Already connected")
if timeout is not None:
warnings.warn(
"The timeout parameter in connect() is deprecated! "
"Use MPDClient.timeout = yourtimeout instead.",
DeprecationWarning,
)
self.timeout = timeout
if host.startswith("@"):
host = "\0" + host[1:]
if host.startswith(("/", "\0")):
self._sock = self._connect_unix(host)
else:
if port is None:
raise ValueError(
"port argument must be specified when connecting via tcp"
)
self._sock = self._connect_tcp(host, port)
# - Force UTF-8 encoding, since this is dependant from the LC_CTYPE
# locale.
# - by setting newline explicit, we force to send '\n' also on
# windows
self._rbfile = self._sock.makefile("rb", newline="\n")
self._wfile = self._sock.makefile("w", encoding="utf-8", newline="\n")
try:
helloline = self._rbfile.readline().decode("utf-8")
self._hello(helloline)
except Exception:
self.disconnect()
raise
def disconnect(self) -> None:
logger.info("Calling MPD disconnect()")
if self._rbfile is not None and not isinstance(self._rbfile, _NotConnected):
self._rbfile.close()
if self._wfile is not None and not isinstance(self._wfile, _NotConnected):
self._wfile.close()
if self._sock is not None:
self._sock.close()
self._reset()
def fileno(self) -> int:
if self._sock is None:
raise ConnectionError("Not connected")
return self._sock.fileno()
def command_list_ok_begin(self) -> None:
if self._command_list is not None:
raise CommandListError("Already in command list")
if self._iterating:
raise IteratingError("Cannot begin command list while iterating")
self._write_command("command_list_ok_begin")
self._command_list = []
def command_list_end(self) -> Any:
if self._command_list is None:
raise CommandListError("Not in command list")
if self._iterating:
raise IteratingError("Already iterating over a command list")
self._write_command("command_list_end")
return self._wrap_iterator(self._read_command_list())
@classmethod
def add_command(cls, name: str, callback: Any) -> None:
wrap_result = callback in cls._wrap_iterator_parsers
if callback.mpd_commands_binary:
method = lambda self, *args: callback(
self, cls._execute_binary(self, name, args)
)
else:
method = _create_command(cls._execute, name, callback, wrap_result)
# create new mpd commands as function:
escaped_name = name.replace(" ", "_")
setattr(cls, escaped_name, method)
@classmethod
def remove_command(cls, name: str) -> None:
if not hasattr(cls, name):
raise ValueError("Can't remove not existent '{}' command".format(name))
name = name.replace(" ", "_")
delattr(cls, str(name))
# vim: set expandtab shiftwidth=4 softtabstop=4 textwidth=79: