|
11 | 11 | cmp_func = cmp_to_key |
12 | 12 |
|
13 | 13 |
|
14 | | -# .: msorted :. |
| 14 | +# .: multisort :. |
15 | 15 | # spec is a list one of the following |
16 | 16 | # <key> |
17 | 17 | # (<key>,) |
|
21 | 21 | # <opts> dict. Options: |
22 | 22 | # reverse: opt - reversed sort (defaults to False) |
23 | 23 | # clean: opt - callback to clean / alter data in 'field' |
24 | | -# none_first: opt - If True, None will be at top of sort. Default is False (bottom) |
25 | | -class Comparator: |
26 | | - @classmethod |
27 | | - def new(cls, *args): |
28 | | - if len(args) == 1 and isinstance(args[0], (int,str)): |
29 | | - _c = Comparator(spec=args[0]) |
| 24 | +def multisort(rows, spec, reverse:bool=False): |
| 25 | + key=clean=rows_sorted=default=None |
| 26 | + col_reverse=False |
| 27 | + required=True |
| 28 | + for s_c in reversed([spec] if isinstance(spec, (int, str)) else spec): |
| 29 | + if isinstance(s_c, (int, str)): |
| 30 | + key = s_c |
30 | 31 | else: |
31 | | - _c = Comparator(spec=args) |
32 | | - return cmp_to_key(_c._compare_a_b) |
| 32 | + if len(s_c) == 1: |
| 33 | + key = s_c[0] |
| 34 | + elif len(s_c) == 2: |
| 35 | + key = s_c[0] |
| 36 | + s_opts = s_c[1] |
| 37 | + assert not s_opts is None and isinstance(s_opts, dict), f"Invalid Spec. Second value must be a dict. Got {getClassName(s_opts)}" |
| 38 | + col_reverse = s_opts.get('reverse', False) |
| 39 | + clean = s_opts.get('clean', None) |
| 40 | + default = s_opts.get('default', None) |
| 41 | + required = s_opts.get('required', True) |
33 | 42 |
|
34 | | - def __init__(self, spec): |
35 | | - if isinstance(spec, (int, str)): |
36 | | - self.spec = ( (spec, False, None, False), ) |
37 | | - else: |
38 | | - a=[] |
39 | | - for s_c in spec: |
40 | | - if isinstance(s_c, (int, str)): |
41 | | - a.append((s_c, None, None, False)) |
42 | | - else: |
43 | | - assert isinstance(s_c, tuple) and len(s_c) in (1,2),\ |
44 | | - f"Invalid spec. Must have 1 or 2 params per record. Got: {s_c}" |
45 | | - if len(s_c) == 1: |
46 | | - a.append((s_c[0], None, None, False)) |
47 | | - elif len(s_c) == 2: |
48 | | - s_opts = s_c[1] |
49 | | - assert not s_opts is None and isinstance(s_opts, dict), f"Invalid Spec. Second value must be a dict. Got {getClassName(s_opts)}" |
50 | | - a.append((s_c[0], s_opts.get('reverse', False), s_opts.get('clean', None), s_opts.get('none_first', False))) |
51 | | - |
52 | | - self.spec = a |
53 | | - |
54 | | - def _compare_a_b(self, a, b): |
55 | | - if a is None: return 1 |
56 | | - if b is None: return -1 |
57 | | - for k, desc, clean, none_first in self.spec: |
| 43 | + def _sort_column(row): # Throws MSIndexError, MSKeyError |
| 44 | + ex1=None |
58 | 45 | try: |
59 | 46 | try: |
60 | | - va = a[k]; vb = b[k] |
| 47 | + v = row[key] |
61 | 48 | except Exception as ex: |
62 | | - va = getattr(a, k); vb = getattr(b, k) |
63 | | - |
64 | | - except Exception as ex: |
65 | | - raise KeyError(f"Key {k} is not available in object(s) given a: {a.__class__.__name__}, b: {a.__class__.__name__}") |
| 49 | + ex1 = ex |
| 50 | + v = getattr(row, key) |
| 51 | + except Exception as ex2: |
| 52 | + if isinstance(row, (list, tuple)): # failfast for tuple / list |
| 53 | + raise MSIndexError(ex1.args[0], row, ex1) |
66 | 54 |
|
67 | | - if clean: |
68 | | - va = clean(va) |
69 | | - vb = clean(vb) |
| 55 | + elif required: |
| 56 | + raise MSKeyError(ex2.args[0], row, ex2) |
70 | 57 |
|
71 | | - if va != vb: |
72 | | - if va is None: return -1 if none_first else 1 |
73 | | - if vb is None: return 1 if none_first else -1 |
74 | | - if desc: |
75 | | - return -1 if va > vb else 1 |
76 | 58 | else: |
77 | | - return 1 if va > vb else -1 |
| 59 | + if default is None: |
| 60 | + v = None |
| 61 | + else: |
| 62 | + v = default |
| 63 | + |
| 64 | + if default: |
| 65 | + if v is None: return default |
| 66 | + return clean(v) if clean else v |
| 67 | + else: |
| 68 | + if v is None: return True, None |
| 69 | + if clean: return False, clean(v) |
| 70 | + return False, v |
| 71 | + |
| 72 | + try: |
| 73 | + if rows_sorted is None: |
| 74 | + rows_sorted = sorted(rows, key=_sort_column, reverse=col_reverse) |
| 75 | + else: |
| 76 | + rows_sorted.sort(key=_sort_column, reverse=col_reverse) |
| 77 | + |
| 78 | + |
| 79 | + except Exception as ex: |
| 80 | + msg=None |
| 81 | + row=None |
| 82 | + key_is_int=isinstance(key, int) |
| 83 | + |
| 84 | + if isinstance(ex, MultiSortBaseExc): |
| 85 | + row = ex.row |
| 86 | + if isinstance(ex, MSIndexError): |
| 87 | + msg = f"Invalid index for {row.__class__.__name__} row of length {len(row)}. Row: {row}" |
| 88 | + else: # MSKeyError |
| 89 | + msg = f"Invalid key/property for row of type {row.__class__.__name__}. Row: {row}" |
| 90 | + else: |
| 91 | + msg = ex.args[0] |
| 92 | + |
| 93 | + raise MultiSortError(f"""Sort failed on key {"int" if key_is_int else "str '"}{key}{'' if key_is_int else "' "}. {msg}""", row, ex) |
| 94 | + |
| 95 | + |
| 96 | + return reversed(rows_sorted) if reverse else rows_sorted |
| 97 | + |
78 | 98 |
|
79 | | - return 0 |
| 99 | +class MultiSortBaseExc(Exception): |
| 100 | + def __init__(self, msg, row, cause): |
| 101 | + self.message = msg |
| 102 | + self.row = row |
| 103 | + self.cause = cause |
| 104 | + |
| 105 | +class MSIndexError(MultiSortBaseExc): |
| 106 | + def __init__(self, msg, row, cause): |
| 107 | + super(MSIndexError, self).__init__(msg, row, cause) |
80 | 108 |
|
| 109 | +class MSKeyError(MultiSortBaseExc): |
| 110 | + def __init__(self, msg, row, cause): |
| 111 | + super(MSKeyError, self).__init__(msg, row, cause) |
81 | 112 |
|
82 | | -def msorted(rows, spec, reverse:bool=False): |
83 | | - if isinstance(spec, (int, str)): |
84 | | - _c = Comparator.new(spec) |
85 | | - else: |
86 | | - _c = Comparator.new(*spec) |
87 | | - return sorted(rows, key=_c, reverse=reverse) |
| 113 | +class MultiSortError(MultiSortBaseExc): |
| 114 | + def __init__(self, msg, row, cause): |
| 115 | + super(MultiSortError, self).__init__(msg, row, cause) |
| 116 | + def __str__(self): |
| 117 | + return self.message |
| 118 | + def __repr__(self): |
| 119 | + return f"<MultiSortError> {self.__str__()}" |
88 | 120 |
|
89 | 121 | # For use in the multi column sorted syntax to sort by 'grade' and then 'attend' descending |
90 | 122 | # dict example: |
|
0 commit comments