-
Notifications
You must be signed in to change notification settings - Fork 62
/
__init__.py
1616 lines (1405 loc) · 56.7 KB
/
__init__.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
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
This package contains all refinery units. To write an executable refinery unit,
it is sufficient to write a class that inherits from `refinery.units.Unit` and
implements `refinery.units.Unit.process`. If the operation implemented by this
unit should be reversible, then a method called `reverse` with the same signature
has to be implemented. For example, the following would be a minimalistic
approach to implement `refinery.hex`:
from refinery import Unit
class hex(Unit):
def process(self, data): return bytes.fromhex(data.decode('ascii'))
def reverse(self, data): return data.hex().encode(self.codec)
The above script can be run from the command line. Since `hex` is not marked as
abstract, its inherited `refinery.units.Unit.run` method will be invoked when
the script is executed.
### Command Line Parameters
If you want your custom refinery unit to accept command line parameters, you can
write an initialization routine. For example, the following unit implements a very
simple XOR unit (albeit less versatile than the already existing `refinery.xor`):
from refinery import Unit, arg
import itertools
class myxor (Unit):
def __init__(self, key: arg(help='Encryption key')):
pass
def process(self, data: bytearray):
key = itertools.cycle(self.args.key)
for k, b in enumerate(data):
data[k] ^= next(key)
return data
The `refinery.arg` decorator is optional and only used here to provide a help
message on the command line. The example also shows that the `__init__` code can be
left empty: In this case, refinery automatically adds boilerplate code that copies
all `__init__` parameters to the `args` member variable of the unit. In this case,
the constructor will be completed to have the following code:
def __init__(self, key: arg(help='Encryption key')):
super().__init__(key=key)
The option of writing an empty `__init__` was added because it is rarely needed to
perform any processing of the input arguments. The command line help for this unit
will look as follows:
usage: myxor [-h] [-Q] [-0] [-v] key
positional arguments:
key Encryption key
generic options:
-h, --help Show this help message and exit.
-Q, --quiet Disables all log output.
-0, --devnull Do not produce any output.
-v, --verbose Specify up to two times to increase log level.
### Refinery Syntax in Code
Refinery units can be used in Python code (and a Python repl) in nearly the same way
as on the command line. As one example, consider the following unit that can decode
base64 with a custom alphabet using `refinery.map` and `refinery.b64`:
from refinery import Unit, b64, map
class b64custom(Unit):
_b64alphabet = (
B'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
B'abcdefghijklmnopqrstuvwxyz'
B'0123456789+/'
)
def __init__(self, alphabet=_b64alphabet):
if len(alphabet) != 64:
raise ValueError('Alphabet size must be 64')
super().__init__(alphabet=alphabet)
def process(self, data):
return data | map(self.args.alphabet, self._b64alphabet) | b64
def reverse(self, data):
return data | -b64 | map(self._b64alphabet, self.args.alphabet)
The syntax does not work exactly as on the command line, but it has been designed to
be as similar as possible:
- The binary or operator `|` can be used to combine units into pipelines.
- Combining a pipeline from the left with a byte string or io stream object will
invoke it, the result of the operation is the final output.
- Unary negation of a reversible unit is equivalent to using the `-R` switch for
reverse mode.
If you want to use frames in code, simply omit any pipe before a square bracked. For
example, the first example from the `refinery.lib.frame` documentation translates to
the following Python code:
In [1]: from refinery import *
In [2]: B'OOOOOOOO' | chop(2) [ ccp(B'F') | cca(B'.') ]
Out[2]: bytearray(b'FOO.FOO.FOO.FOO.')
"""
from __future__ import annotations
import abc
import copy
import inspect
import logging
import os
import sys
from abc import ABCMeta
from enum import IntEnum, Enum
from functools import wraps
from collections import OrderedDict
from typing import (
Dict,
Iterable,
BinaryIO,
Type,
TypeVar,
Union,
List,
Optional,
Callable,
Tuple,
Any,
ByteString,
no_type_check,
get_type_hints
)
from argparse import (
ArgumentTypeError, Namespace,
ONE_OR_MORE,
OPTIONAL,
REMAINDER,
SUPPRESS,
ZERO_OR_MORE
)
from ..lib.argformats import pending, manifest, multibin, number, sliceobj, VariableMissing
from ..lib.argparser import ArgumentParserWithKeywordHooks, ArgparseError
from ..lib.tools import documentation, isstream, lookahead, autoinvoke, skipfirst, isbuffer
from ..lib.frame import Framed, Chunk
from ..lib.structures import MemoryFile
class RefineryPartialResult(ValueError):
"""
This exception indicates that a partial result is available.
"""
def __init__(self, message: str, partial: ByteString, rest: Optional[ByteString] = None):
super().__init__(message)
self.message = message
self.partial = partial
self.rest = rest
def __str__(self):
return self.message
class RefineryCriticalException(RuntimeError):
"""
If this exception is thrown, processing of the entire input stream
is aborted instead of just aborting the processing of the current
chunk.
"""
pass
class Entry:
"""
An empty class marker. Any entry point unit (i.e. any unit that can be executed
via the command line) is an instance of this class.
"""
pass
class Argument:
"""
This class implements an abstract argument to a Python function, including positional
and keyword arguments. Passing an `Argument` to a Python function can be done via the
matrix multiplication operator: The syntax `function @ Argument(a, b, kwd=c)` is
equivalent to the call `function(a, b, kwd=c)`.
"""
__slots__ = 'args', 'kwargs'
def __init__(self, *args, **kwargs):
self.args = list(args)
self.kwargs = kwargs
def __rmatmul__(self, method):
return method(*self.args, **self.kwargs)
def __repr__(self):
def rep(v):
r = repr(v)
if r.startswith('<'):
try:
return v.__name__
except AttributeError:
pass
try:
return v.__class__.__name__
except AttributeError:
pass
return r
arglist = [repr(a) for a in self.args]
arglist.extend(F'{key!s}={rep(value)}' for key, value in self.kwargs.items())
return ', '.join(arglist)
class arg(Argument):
"""
This child class of `refinery.units.Argument` is specifically an argument for the
`add_argument` method of an `ArgumentParser` from the `argparse` module. It can also
be used as a decorator for the constructor of a refinery unit to better control
the argument parser of that unit's command line interface. Example:
```
class prefixer(Unit):
@arg('prefix', help='this data will be prepended to the input.')
def __init__(self, prefix): pass
def process(self, data):
return self.args.prefix + data
```
Note that when the init of a unit has a return annotation that is a base class of
itself, then all its parameters will automatically be forwarded to that base class.
"""
class delete: pass
class omit: pass
def __init__(
self, *args: str,
action : Union[omit, str] = omit, # noqa
choices : Union[omit, Iterable[Any]] = omit, # noqa
const : Union[omit, Any] = omit, # noqa
default : Union[omit, Any] = omit, # noqa
dest : Union[omit, str] = omit, # noqa
help : Union[omit, str] = omit, # noqa
metavar : Union[omit, str] = omit, # noqa
nargs : Union[omit, int, str] = omit, # noqa
required : Union[omit, bool] = omit, # noqa
type : Union[omit, type] = omit, # noqa
group : Optional[str] = None, # noqa
guess : bool = False # noqa
) -> None:
kwargs = dict(action=action, choices=choices, const=const, default=default, dest=dest,
help=help, metavar=metavar, nargs=nargs, required=required, type=type)
kwargs = {key: value for key, value in kwargs.items() if value is not arg.omit}
self.group = group
self.guess = guess
super().__init__(*args, **kwargs)
def update_help(self):
if 'help' not in self.kwargs:
return
class formatting(dict):
arg = self
def __missing__(self, key):
if key == 'choices':
return ', '.join(self.arg.kwargs['choices'])
if key == 'default':
default = self.arg.kwargs['default']
if not isbuffer(default):
return str(default)
if default.isalnum():
return default.decode('latin-1')
return F'H:{default.hex()}'
if key == 'varname':
return self.arg.kwargs.get('metavar', self.arg.destination)
try:
self.kwargs.update(
help=self.kwargs['help'].format_map(formatting()))
except Exception:
pass
def __rmatmul__(self, method):
self.update_help()
return super().__rmatmul__(method)
@staticmethod
def as_option(value: Optional[Any], cls: Enum) -> Enum:
if value is None or isinstance(value, cls):
return value
if isinstance(value, str):
try: return cls[value]
except KeyError: pass
needle = value.upper()
for item in cls:
if item.name.upper() == needle:
return item
try:
return cls(value)
except Exception as E:
raise ValueError(F'Could not transform {value} into a {cls.__name__}.') from E
@staticmethod
def switch(
*args: str, off=False,
help : Union[omit, str] = omit,
dest : Union[omit, str] = omit,
group: Optional[str] = None,
) -> Argument:
"""
A convenience method to add argparse arguments that change a boolean value from True to False or
vice versa. By default, a switch will have a False default and change it to True when specified.
"""
return arg(*args, group=group, help=help, dest=dest, action='store_false' if off else 'store_true')
@staticmethod
def binary(
*args: str,
help : Union[omit, str] = omit,
dest : Union[omit, str] = omit,
metavar : Optional[str] = None,
group: Optional[str] = None,
) -> Argument:
"""
Used to add argparse arguments that contain binary data.
"""
return arg(*args, group=group, help=help, dest=dest, type=multibin, metavar=metavar or 'B')
@staticmethod
def number(
*args: str,
bound: Union[omit, Tuple[int, int]] = omit,
help : Union[omit, str] = omit,
dest : Union[omit, str] = omit,
metavar : Optional[str] = None,
group: Optional[str] = None,
) -> Argument:
"""
Used to add argparse arguments that contain a number.
"""
nt = number
if bound is not arg.omit:
lower, upper = bound
nt = nt[lower:upper]
return arg(*args, group=group, help=help, dest=dest, type=nt, metavar=metavar or 'N')
@staticmethod
def option(
*args: str, choices: Enum,
help : Union[omit, str] = omit,
dest : Union[omit, str] = omit,
metavar: Optional[str] = None,
group: Optional[str] = None,
) -> Argument:
"""
Used to add argparse arguments with a fixed set of options, based on an enumeration.
"""
cnames = [c.name for c in choices]
metavar = metavar or choices.__name__
return arg(*args, group=group, help=help, metavar=metavar, dest=dest, choices=cnames, type=str)
@staticmethod
def choice(
*args: str, choices : List[str],
help : Union[omit, str] = omit,
metavar : Union[omit, str] = omit,
dest : Union[omit, str] = omit,
nargs : Union[omit, int, str] = omit,
group : Optional[str] = None,
):
"""
Used to add argparse arguments with a fixed set of options, based on a list of strings.
"""
return arg(*args, group=group, type=str, metavar=metavar, nargs=nargs,
dest=dest, help=help, choices=choices)
@property
def positional(self) -> bool:
return any(a[0] != '-' for a in self.args)
@property
def destination(self) -> str:
"""
The name of the variable where the contents of this parsed argument will be stored.
"""
for a in self.args:
if a[0] != '-':
return a
try:
return self.kwargs['dest']
except KeyError:
for a in self.args:
if a.startswith('--'):
dest = a.lstrip('-').replace('-', '_')
if dest.isidentifier():
return dest
raise AttributeError(F'The argument with these values has no destination: {self!r}')
@classmethod
def infer(cls, pt: inspect.Parameter) -> Argument:
"""
This class method can be used to infer the argparse argument for a Python function
parameter. This guess is based on the annotation, name, and default value.
"""
def needs_type(item):
return item.get('action', 'store') == 'store'
def get_argp_type(annotation_type):
if issubclass(annotation_type, (bytes, bytearray, memoryview)):
return multibin
if issubclass(annotation_type, int):
return number
if issubclass(annotation_type, slice):
return sliceobj
return annotation_type
name = pt.name.replace('_', '-')
default = pt.default
guessed_pos_args = []
guessed_kwd_args = dict(dest=pt.name, guess=True)
annotation = pt.annotation
if isinstance(annotation, str):
try: annotation = eval(annotation)
except Exception: pass
if annotation is not pt.empty:
if isinstance(annotation, Argument):
if annotation.kwargs.get('dest', pt.name) != pt.name:
raise ValueError(
F'Incompatible argument destination specified; parameter {pt.name} '
F'was annotated with {annotation!r}.')
guessed_pos_args = annotation.args
guessed_kwd_args.update(annotation.kwargs)
guessed_kwd_args['guess'] = False
guessed_kwd_args['group'] = annotation.group
elif isinstance(annotation, type):
if not issubclass(annotation, bool) and needs_type(guessed_kwd_args):
guessed_kwd_args.update(type=get_argp_type(annotation))
elif not isinstance(default, bool):
raise ValueError('Default value for boolean arguments must be provided.')
if not guessed_pos_args:
guessed_pos_args = guessed_pos_args or [F'--{name}' if pt.kind is pt.KEYWORD_ONLY else name]
if pt.kind is pt.VAR_POSITIONAL:
oldnargs = guessed_kwd_args.setdefault('nargs', ZERO_OR_MORE)
if oldnargs not in (ONE_OR_MORE, ZERO_OR_MORE, REMAINDER):
raise ValueError(F'Variadic positional arguments has nargs set to {oldnargs!r}')
return cls(*guessed_pos_args, **guessed_kwd_args)
if default is not pt.empty:
if isinstance(default, Enum):
default = default.name
if isinstance(default, (list, tuple)):
guessed_kwd_args.setdefault('nargs', ZERO_OR_MORE)
if not pt.default:
default = pt.empty
else:
guessed_kwd_args.setdefault('default', pt.default)
default = default[0]
else:
guessed_kwd_args.setdefault('default', default)
if pt.kind is pt.POSITIONAL_ONLY:
guessed_kwd_args.setdefault('nargs', OPTIONAL)
if default is not pt.empty:
if isinstance(default, bool):
guessed_kwd_args['action'] = 'store_false' if default else 'store_true'
elif needs_type(guessed_kwd_args) and 'type' not in guessed_kwd_args:
guessed_kwd_args['type'] = get_argp_type(type(default))
return cls(*guessed_pos_args, **guessed_kwd_args)
def merge_args(self, them: Argument) -> None:
def iterboth():
yield from them.args
yield from self.args
if not self.args:
self.args = list(them.args)
return
sflag = None
lflag = None
for a in iterboth():
if a[:2] == '--': lflag = lflag or a
elif a[0] == '-': sflag = sflag or a
self.args = []
if sflag: self.args.append(sflag)
if lflag: self.args.append(lflag)
if not self.args:
self.args = list(them.args)
def merge_all(self, them: Argument) -> None:
for key, value in them.kwargs.items():
if value is arg.delete:
self.kwargs.pop(key, None)
continue
self.kwargs[key] = value
self.merge_args(them)
self.guess = self.guess and them.guess
self.group = self.group or them.group
def __copy__(self) -> Argument:
cls = self.__class__
clone = cls.__new__(cls)
clone.kwargs = dict(self.kwargs)
clone.args = list(self.args)
clone.group = self.group
clone.guess = self.guess
return clone
def __repr__(self) -> str:
return F'arg({super().__repr__()})'
def __call__(self, init: Callable) -> Callable:
parameters = inspect.signature(init).parameters
try:
inferred = arg.infer(parameters[self.destination])
inferred.merge_all(self)
init.__annotations__[self.destination] = inferred
except KeyError:
raise ValueError(F'Unable to decorate because no parameter with name {self.destination} exists.')
return init
class ArgumentSpecification(OrderedDict):
"""
A container object that stores `refinery.units.arg` specifications.
"""
def merge(self, argument: arg):
"""
Insert or update the specification with the given argument.
"""
dest = argument.destination
if dest in self:
self[dest].merge_all(argument)
return
self[dest] = argument
DataType = TypeVar('DataType', bound=ByteString)
ProcType = Callable[['Unit', ByteString], Optional[Union[DataType, Iterable[DataType]]]]
def UnitProcessorBoilerplate(operation: ProcType[ByteString]) -> ProcType[Chunk]:
@wraps(operation)
def wrapped(self, data: ByteString) -> Optional[Union[Chunk, Iterable[Chunk]]]:
ChunkType = Chunk
if data is None:
data = B''
typespec = get_type_hints(operation)
typespec.pop('return', None)
if typespec and len(typespec) == 1:
SpecType = next(iter(typespec.values()))
if isinstance(SpecType, str):
try: SpecType = eval(SpecType)
except Exception: pass
if isinstance(SpecType, type):
ChunkType = SpecType
if not isinstance(data, ChunkType):
data = ChunkType(data)
result = operation(self, data)
if not inspect.isgenerator(result):
return self.labelled(result)
return (self.labelled(r) for r in result)
return wrapped
def UnitFilterBoilerplate(
operation : Callable[[Any, Iterable[Chunk]], Iterable[Chunk]]
) -> Callable[[Any, Iterable[Chunk]], Iterable[Chunk]]:
@wraps(operation)
def peekfilter(self, chunks: Iterable[Chunk]) -> Iterable[Chunk]:
def rewind(*head):
yield from head
yield from it
it = iter(chunks)
for head in it:
yield from operation(self, rewind(self.args @ head))
break
return peekfilter
def _singleton(cls): return cls()
@_singleton # noqa
class _NoReverseImplemented:
def __call__(*_): raise NotImplementedError
class Executable(ABCMeta):
"""
This is the metaclass for refinery units. A class which is of this type is
required to implement a method `run()`. If the class is created in the
currently executing module, then an instance of the class is automatically
created after it is defined and its `run()` method is invoked.
"""
Entry = None
"""
This variable stores the executable entry point. If more than one entry point
are present, only the first one is executed and an error message is generated
for the other ones.
"""
def _infer_argspec(cls, parameters, args: Optional[ArgumentSpecification] = None):
args = ArgumentSpecification() if args is None else args
temp = ArgumentSpecification()
exposed = [pt.name for pt in skipfirst(parameters.values()) if pt.kind != pt.VAR_KEYWORD]
# The arguments are added in reverse order to the argument parser later.
# This is done to have a more intuitive use of decorator based argument configuration.
exposed.reverse()
for name in exposed:
try:
argument = arg.infer(parameters[name])
except KeyError:
continue
if argument.guess:
temp.merge(argument)
else:
args.merge(argument)
for guess in temp.values():
known = args.get(guess.destination, None)
if known is None:
args.merge(guess)
continue
if not known.positional:
known.merge_args(guess)
for k, v in guess.kwargs.items():
if k == 'default':
known.kwargs[k] = v
else:
known.kwargs.setdefault(k, v)
for name in exposed:
args.move_to_end(name)
for known in args.values():
if known.positional:
known.kwargs.pop('dest', None)
if 'default' in known.kwargs:
known.kwargs.setdefault('nargs', OPTIONAL)
elif not any(a.startswith('--') for a in known.args):
flagname = known.destination.replace('_', '-')
known.args.append(F'--{flagname}')
action = known.kwargs.get('action', 'store')
if action.startswith('store_'):
known.kwargs.pop('default', None)
continue
if action == 'store':
known.kwargs.setdefault('type', multibin)
return args
def __new__(mcs, name, bases, nmspc, abstract=False):
def decorate(**decorations):
for method, decorator in decorations.items():
try:
old = nmspc[method]
except KeyError:
continue
if getattr(old, '__isabstractmethod__', False):
continue
nmspc[method] = decorator(old)
decorate(
filter=UnitFilterBoilerplate,
process=UnitProcessorBoilerplate,
reverse=UnitProcessorBoilerplate,
__init__=no_type_check,
)
if not abstract and Entry not in bases:
bases = bases + (Entry,)
if not bases[0].is_reversible:
nmspc.setdefault('reverse', _NoReverseImplemented)
nmspc.setdefault('__doc__', '')
return super(Executable, mcs).__new__(mcs, name, bases, nmspc)
def __init__(cls, name, bases, nmspc, abstract=False):
super(Executable, cls).__init__(name, bases, nmspc)
cls._argspec_ = ArgumentSpecification()
cls_init = cls.__init__
sig_init = inspect.signature(cls_init)
parameters = sig_init.parameters
for base in bases:
for key, value in base._argspec_.items():
if not value.guess and key in parameters:
cls._argspec_[key] = value.__copy__()
cls._infer_argspec(parameters, cls._argspec_)
if not abstract and any(p.kind == p.VAR_KEYWORD for p in parameters.values()):
@wraps(cls.__init__)
def init(self, *args, **kwargs): super(cls, self).__init__(*args, **kwargs)
init.__signature__ = sig_init.replace(parameters=tuple(
p for p in parameters.values() if p.kind != p.VAR_KEYWORD))
cls.__init__ = init
try:
initcode = cls.__init__.__code__.co_code
except AttributeError:
initcode = None
if initcode == (lambda: None).__code__.co_code:
base = bases[0]
head = []
defs = {}
tail = None
for p in skipfirst(parameters.values()):
if p.kind in (p.POSITIONAL_ONLY, p.POSITIONAL_OR_KEYWORD):
head.append(p.name)
if p.kind in (p.KEYWORD_ONLY, p.POSITIONAL_OR_KEYWORD) and p.default is not p.empty:
defs[p.name] = p.default
if p.kind is p.VAR_POSITIONAL:
tail = p.name
@wraps(cls.__init__)
def cls__init__(self, *args, **kw):
for name, arg in zip(head, args):
kw[name] = arg
if tail:
k = min(len(args), len(head))
kw[tail] = args[k:]
for key in defs:
if key not in kw:
kw[key] = defs[key]
base.__init__(self, **kw)
cls.__init__ = cls__init__
if not abstract and sys.modules[cls.__module__].__name__ == '__main__':
if Executable.Entry:
cls.logger.warning(cls._output(
F'not executing this unit because the following unit was '
F'already executed: {Executable.Entry}'
))
else:
Executable.Entry = cls.name
cls.run()
def __getitem__(cls, other):
return cls().__getitem__(other)
def __or__(cls, other):
return cls().__or__(other)
def __neg__(cls):
unit = cls()
unit.args.reverse = True
return unit
def __ror__(cls, other):
return cls().__ror__(other)
@property
def is_multiplex(cls) -> bool:
"""
This proprety is `True` if and only if the unit's `process` or `reverse` method is a generator, i.e.
when the unit can generate multiple outputs.
"""
if inspect.isgeneratorfunction(inspect.unwrap(cls.process)):
return True
if not cls.is_reversible:
return False
return inspect.isgeneratorfunction(inspect.unwrap(cls.reverse))
@property
def is_reversible(cls) -> bool:
"""
This property is `True` if and only if the unit has a member function named `reverse`. By convention,
this member function implements the inverse of `refinery.units.Unit.process`.
"""
if cls.reverse is _NoReverseImplemented:
return False
try:
return not cls.reverse.__isabstractmethod__
except AttributeError:
return True
@property
def codec(cls) -> str:
"""
The default codec for encoding textual information between units. The value of this property is
hardcoded to `UTF8`.
"""
return 'UTF8'
@property
def name(cls) -> str:
return cls.__name__.replace('_', '-')
@property
def logger(cls) -> logging.Logger:
try:
return cls._logger
except AttributeError:
pass
cls._logger = logger = logging.getLogger(cls.name)
if not logger.hasHandlers():
stream = logging.StreamHandler()
stream.setFormatter(logging.Formatter(
'[{asctime!s:.5s}][{levelname:.1s}] {name}: {message}',
style='{',
datefmt='%I:%M:%S'
))
logger.addHandler(stream)
logger.propagate = False
return logger
class LogLevel(IntEnum):
"""
An enumeration representing the current log level:
"""
DETACHED = logging.CRITICAL + 100
"""
This unit is not attached to a terminal but has been instantiated in
code. This means that the only way to communicate problems is to throw
an exception.
"""
NONE = logging.CRITICAL + 50
@classmethod
def FromVerbosity(cls, verbosity: int):
if verbosity < 0:
return cls.DETACHED
return {
0: cls.WARNING,
1: cls.INFO,
2: cls.DEBUG
}.get(verbosity, cls.DEBUG)
NOTSET = logging.NOTSET # noqa
CRITICAL = logging.CRITICAL # noqa
FATAL = logging.FATAL # noqa
ERROR = logging.ERROR # noqa
WARNING = logging.WARNING # noqa
WARN = logging.WARN # noqa
INFO = logging.INFO # noqa
DEBUG = logging.DEBUG # noqa
class DelayedArgumentProxy:
"""
This class implements a proxy for the `args` member variable of `refinery.units.Unit`.
Its primary purpose is to proxy `refinery.lib.argformats.DelayedArgument` values which
can be computed only as soon as input data becomes available and which also have to be
recomputed for each input.
"""
class PendingUpdate:
pass
_argv: Namespace
_argo: List[str]
_args: Dict[str, Any]
_done: bool
_guid: int
def __copy__(self):
cls = self.__class__
clone = cls.__new__(cls)
clone._store(
_argv=self._argv,
_argo=list(self._argo),
_args=dict(self._args),
_done=self._done,
_guid=self._guid,
)
return clone
def __iter__(self):
yield from self._args
def __getitem__(self, key):
return self._args[key]
def __init__(self, argv: Namespace, argo: Iterable[str]):
args = {}
done = True
for name, value in vars(argv).items():
if not pending(value):
args[name] = value
else:
done = False
self._store(
_argv=argv,
_argo=list(argo),
_args=args,
_done=done,
_guid=None,
)
def __call__(self, data: bytearray):
"""
Update the current arguments for the input `data`, regardless of whether or not this chunk
has already been used. In most cases, the matrix-multiplication syntax should be used instead
of this direct call: If a multibin argument modifies the meta dictionary by being applied, a
second interpretation of this argument with the same chunk might cause an error. For example,
if an argument specifies to pop a meta variable from the meta dictionary, this variable will
not be available for a second interpretation call.
"""
for name in self._argo:
value = getattr(self._argv, name, None)
if value is self.PendingUpdate:
raise RuntimeError(F'Attempting to resolve {name} while an update for this argument is in flight')
if value and pending(value):
self._args[name] = self.PendingUpdate
self._args[name] = manifest(value, data)
self._store(_guid=id(data))
return data
def __matmul__(self, data: bytearray):
"""
Interpret the current arguments for the given input `data`.
"""
if self._done:
return data
if not isinstance(data, bytearray):
data = bytearray(data)
if id(data) == self._guid:
return data
return self(data)
def _store(self, **kwargs):
self.__dict__.update(kwargs)
def __getattr__(self, name):
try:
return super().__getattr__(name)
except AttributeError:
pass
try:
return self._args[name]
except KeyError:
pass
try:
value = getattr(self._argv, name)
except AttributeError as E:
raise AttributeError(F'Argument {name} not set.') from E
if not value or not pending(value):
return value
raise AttributeError(F'the value {name} cannot be accessed until data is available.')
def __setattr__(self, name, value):
if not hasattr(self._argv, name):
self._argo.append(name)
if pending(value):
self._store(_done=False)
else:
self._args[name] = value
return setattr(self._argv, name, value)
class UnitBase(metaclass=Executable, abstract=True):
"""
This base class is an abstract interface specifying the abstract methods that have
to be present on any unit. All actual units should inherit from its only child class
`refinery.units.Unit`.
"""
@abc.abstractmethod
def process(self, data: ByteString) -> Union[Optional[ByteString], Iterable[ByteString]]:
"""
This routine is overridden by children of `refinery.units.Unit` to define how
the unit processes a given chunk of binary data.
"""
@abc.abstractmethod
def reverse(self, data: ByteString) -> Union[Optional[ByteString], Iterable[ByteString]]:
"""
If this routine is overridden by children of `refinery.units.Unit`, then it must
implement an operation that reverses the `refinery.units.Unit.process` operation.
The absence of an overload for this function is ignored for non-abstract children of
`refinery.units.UnitBase`.
"""
@abc.abstractmethod
def filter(self, inputs: Iterable[Chunk]) -> Iterable[Chunk]:
"""
Receives an iterable of `refinery.lib.frame.Chunk`s and yields only those that
should be processed. The default implementation returns the iterator without
change; this member function is designed to be overloaded by child classes of
`refinery.units.Unit` to allow inspection of an entire frame layer and altering
it before `refinery.units.Unit.process` is called on the individual chunks.
"""
@abc.abstractmethod
def finish(self) -> Iterable[Chunk]:
"""