-
Notifications
You must be signed in to change notification settings - Fork 426
/
utils.py
626 lines (496 loc) · 19.5 KB
/
utils.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
import inspect
import warnings
from collections import OrderedDict
from functools import total_ordering
from itertools import chain
from django.core.exceptions import FieldDoesNotExist
from django.db import models
from django.utils.html import format_html_join
class Sequence(list):
"""
Represents a column sequence, e.g. ``('first_name', '...', 'last_name')``
This is used to represent `.Table.Meta.sequence` or the `.Table`
constructors's *sequence* keyword argument.
The sequence must be a list of column names and is used to specify the
order of the columns on a table. Optionally a '...' item can be inserted,
which is treated as a *catch-all* for column names that are not explicitly
specified.
"""
def expand(self, columns):
"""
Expands the ``'...'`` item in the sequence into the appropriate column
names that should be placed there.
arguments:
columns (list): list of column names.
returns:
The current instance.
raises:
`ValueError` if the sequence is invalid for the columns.
"""
ellipses = self.count("...")
if ellipses > 1:
raise ValueError("'...' must be used at most once in a sequence.")
elif ellipses == 0:
self.append("...")
# everything looks good, let's expand the "..." item
columns = list(columns) # take a copy and exhaust the generator
head = []
tail = []
target = head # start by adding things to the head
for name in self:
if name == "...":
# now we'll start adding elements to the tail
target = tail
continue
target.append(name)
if name in columns:
columns.pop(columns.index(name))
self[:] = chain(head, columns, tail)
return self
class OrderBy(str):
"""
A single item in an `.OrderByTuple` object.
This class is essentially just a `str` with some extra properties.
"""
QUERYSET_SEPARATOR = "__"
def __new__(cls, value):
instance = super().__new__(cls, value)
if Accessor.LEGACY_SEPARATOR in value:
message = (
f"Use '__' to separate path components, not '.' in accessor '{value}'"
" (fallback will be removed in django_tables2 version 3)."
)
warnings.warn(message, DeprecationWarning, stacklevel=3)
return instance
@property
def bare(self):
"""
Returns:
`.OrderBy`: the bare form.
The *bare form* is the non-prefixed form. Typically the bare form is
just the ascending form.
Example: ``age`` is the bare form of ``-age``
"""
return OrderBy(self[1:]) if self[:1] == "-" else self
@property
def opposite(self):
"""
Provides the opposite of the current sorting direction.
Returns:
`.OrderBy`: object with an opposite sort influence.
Example::
>>> order_by = OrderBy('name')
>>> order_by.opposite
'-name'
"""
return OrderBy(self[1:]) if self.is_descending else OrderBy("-" + self)
@property
def is_descending(self):
"""
Returns `True` if this object induces *descending* ordering.
"""
return self.startswith("-")
@property
def is_ascending(self):
"""
Returns `True` if this object induces *ascending* ordering.
"""
return not self.is_descending
def for_queryset(self):
"""
Returns the current instance usable in Django QuerySet's order_by
arguments.
"""
return self.replace(Accessor.LEGACY_SEPARATOR, OrderBy.QUERYSET_SEPARATOR)
class OrderByTuple(tuple):
"""
Stores ordering as (as `.OrderBy` objects).
The `~.Table.order_by` property is always converted to an `.OrderByTuple` object.
This class is essentially just a `tuple` with some useful extras.
Example::
>>> x = OrderByTuple(('name', '-age'))
>>> x['age']
'-age'
>>> x['age'].is_descending
True
>>> x['age'].opposite
'age'
"""
def __new__(cls, iterable):
transformed = []
for item in iterable:
if not isinstance(item, OrderBy):
item = OrderBy(item)
transformed.append(item)
return super().__new__(cls, transformed)
def __str__(self):
return ",".join(self)
def __contains__(self, name):
"""
Determine if a column has an influence on ordering.
Example::
>>> x = OrderByTuple(('name', ))
>>> 'name' in x
True
>>> '-name' in x
True
Arguments:
name (str): The name of a column. (optionally prefixed)
Returns:
bool: `True` if the column with `name` influences the ordering.
"""
name = OrderBy(name).bare
for order_by in self:
if order_by.bare == name:
return True
return False
def __getitem__(self, index):
"""
Allows an `.OrderBy` object to be extracted via named or integer
based indexing.
When using named based indexing, it's fine to used a prefixed named::
>>> x = OrderByTuple(('name', '-age'))
>>> x[0]
'name'
>>> x['age']
'-age'
>>> x['-age']
'-age'
Arguments:
index (int): Index to query the ordering for.
Returns:
`.OrderBy`: for the ordering at the index.
"""
if isinstance(index, str):
for order_by in self:
if order_by == index or order_by.bare == index:
return order_by
raise KeyError
return super().__getitem__(index)
@property
def key(self):
accessors = []
reversing = []
for order_by in self:
accessors.append(Accessor(order_by.bare))
reversing.append(order_by.is_descending)
@total_ordering
class Comparator:
def __init__(self, obj):
self.obj = obj
def __eq__(self, other):
for accessor in accessors:
a = accessor.resolve(self.obj, quiet=True)
b = accessor.resolve(other.obj, quiet=True)
if not a == b:
return False
return True
def __lt__(self, other):
for accessor, reverse in zip(accessors, reversing):
a = accessor.resolve(self.obj, quiet=True)
b = accessor.resolve(other.obj, quiet=True)
if a == b:
continue
if reverse:
a, b = b, a
# The rest of this should be refactored out into a util
# function 'compare' that handles different types.
try:
return a < b
except TypeError:
# If the truth values differ, it's a good way to
# determine ordering.
if bool(a) is not bool(b):
return bool(a) < bool(b)
# Handle comparing different types, by falling back to
# the string and id of the type. This at least groups
# different types together.
a_type = type(a)
b_type = type(b)
return (repr(a_type), id(a_type)) < (repr(b_type), id(b_type))
return False
return Comparator
def get(self, key, fallback):
"""
Identical to `__getitem__`, but supports fallback value.
"""
try:
return self[key]
except (KeyError, IndexError):
return fallback
@property
def opposite(self):
"""
Return version with each `.OrderBy` prefix toggled::
>>> order_by = OrderByTuple(('name', '-age'))
>>> order_by.opposite
('-name', 'age')
"""
return type(self)(o.opposite for o in self)
class Accessor(str):
"""
A string describing a path from one object to another via attribute/index
accesses. For convenience, the class has an alias `.A` to allow for more concise code.
Relations are separated by a ``__`` character.
To support list-of-dicts from ``QuerySet.values()``, if the context is a dictionary,
and the accessor is a key in the dictionary, it is returned right away.
"""
LEGACY_SEPARATOR = "."
SEPARATOR = "__"
ALTERS_DATA_ERROR_FMT = "Refusing to call {method}() because `.alters_data = True`"
LOOKUP_ERROR_FMT = (
"Failed lookup for key [{key}] in {context}, when resolving the accessor {accessor}"
)
def __init__(self, value, callable_args=None, callable_kwargs=None):
self.callable_args = callable_args or getattr(value, "callable_args", None) or []
self.callable_kwargs = callable_kwargs or getattr(value, "callable_kwargs", None) or {}
super().__init__()
def __new__(cls, value, callable_args=None, callable_kwargs=None):
instance = super().__new__(cls, value)
if cls.LEGACY_SEPARATOR in value:
instance.SEPARATOR = cls.LEGACY_SEPARATOR
message = (
f"Use '__' to separate path components, not '.' in accessor '{value}'"
" (fallback will be removed in django_tables2 version 3)."
)
warnings.warn(message, DeprecationWarning, stacklevel=3)
return instance
def resolve(self, context, safe=True, quiet=False):
"""
Return an object described by the accessor by traversing the attributes of *context*.
Lookups are attempted in the following order:
- dictionary (e.g. ``obj[related]``)
- attribute (e.g. ``obj.related``)
- list-index lookup (e.g. ``obj[int(related)]``)
Callable objects are called, and their result is used, before
proceeding with the resolving.
Example::
>>> x = Accessor("__len__")
>>> x.resolve("brad")
4
>>> x = Accessor("0__upper")
>>> x.resolve("brad")
"B"
If the context is a dictionary and the accessor-value is a key in it,
the value for that key is immediately returned::
>>> x = Accessor("user__first_name")
>>> x.resolve({"user__first_name": "brad"})
"brad"
Arguments:
context : The root/first object to traverse.
safe (bool): Don't call anything with `alters_data = True`
quiet (bool): Smother all exceptions and instead return `None`
Returns:
target object
Raises:
TypeError`, `AttributeError`, `KeyError`, `ValueError`
(unless `quiet` == `True`)
"""
# Short-circuit if the context contains a key with the exact name of the accessor,
# supporting list-of-dicts data returned from values_list("related_model__field")
if isinstance(context, dict) and self in context:
return context[self]
try:
current = context
for bit in self.bits:
try: # dictionary lookup
current = current[bit]
except (TypeError, AttributeError, KeyError):
try: # attribute lookup
current = getattr(current, bit)
except (TypeError, AttributeError):
try: # list-index lookup
current = current[int(bit)]
except (
IndexError, # list index out of range
ValueError, # invalid literal for int()
KeyError, # dict without `int(bit)` key
TypeError, # unsubscriptable object
):
current_context = (
type(current) if isinstance(current, models.Model) else current
)
raise ValueError(
self.LOOKUP_ERROR_FMT.format(
key=bit, context=current_context, accessor=self
)
)
if callable(current):
if safe and getattr(current, "alters_data", False):
raise ValueError(self.ALTERS_DATA_ERROR_FMT.format(method=current.__name__))
if not getattr(current, "do_not_call_in_templates", False):
current = current(*self.callable_args, **self.callable_kwargs)
# Important that we break in None case, or a relationship
# spanning across a null-key will raise an exception in the
# next iteration, instead of defaulting.
if current is None:
break
return current
except Exception:
if not quiet:
raise
@property
def bits(self):
if self == "":
return ()
return self.split(self.SEPARATOR)
def get_field(self, model):
"""
Return the django model field for model in context, following relations.
"""
if not hasattr(model, "_meta"):
return
field = None
for bit in self.bits:
try:
field = model._meta.get_field(bit)
except FieldDoesNotExist:
break
if hasattr(field, "remote_field"):
rel = getattr(field, "remote_field", None)
model = getattr(rel, "model", model)
return field
def penultimate(self, context, quiet=True):
"""
Split the accessor on the right-most separator ('__'), return a tuple with:
- the resolved left part.
- the remainder
Example::
>>> Accessor("a__b__c").penultimate({"a": {"a": 1, "b": {"c": 2, "d": 4}}})
({"c": 2, "d": 4}, "c")
"""
path, _, remainder = self.rpartition(self.SEPARATOR)
return A(path).resolve(context, quiet=quiet), remainder
A = Accessor # alias
class AttributeDict(OrderedDict):
"""
A wrapper around `collections.OrderedDict` that knows how to render itself
as HTML style tag attributes.
Any key with ``value is None`` will be skipped.
The returned string is marked safe, so it can be used safely in a template.
See `.as_html` for a usage example.
"""
blacklist = ("th", "td", "_ordering", "thead", "tbody", "tfoot")
def _iteritems(self):
for key, v in self.items():
value = v() if callable(v) else v
if key not in self.blacklist and value is not None:
yield (key, value)
def as_html(self):
"""
Render to HTML tag attributes.
Example:
.. code-block:: python
>>> from django_tables2.utils import AttributeDict
>>> attrs = AttributeDict({'class': 'mytable', 'id': 'someid'})
>>> attrs.as_html()
'class="mytable" id="someid"'
returns: `~django.utils.safestring.SafeUnicode` object
"""
return format_html_join(" ", '{}="{}"', self._iteritems())
def segment(sequence, aliases):
"""
Translates a flat sequence of items into a set of prefixed aliases.
This allows the value set by `.QuerySet.order_by` to be translated into
a list of columns that would have the same result. These are called
"order by aliases" which are optionally prefixed column names::
>>> list(segment(('a', '-b', 'c'),
... {'x': ('a'),
... 'y': ('b', '-c'),
... 'z': ('-b', 'c')}))
[('x', '-y'), ('x', 'z')]
"""
if not (sequence or aliases):
return
for alias, parts in aliases.items():
variants = {
# alias: order by tuple
alias: OrderByTuple(parts),
OrderBy(alias).opposite: OrderByTuple(parts).opposite,
}
for valias, vparts in variants.items():
if list(sequence[: len(vparts)]) == list(vparts):
tail_aliases = dict(aliases)
del tail_aliases[alias]
tail_sequence = sequence[len(vparts) :]
if tail_sequence:
for tail in segment(tail_sequence, tail_aliases):
yield tuple(chain([valias], tail))
else:
continue
else:
yield tuple([valias])
def signature(fn):
"""
Returns:
tuple: Returns a (arguments, kwarg_name)-tuple:
- the arguments (positional or keyword)
- the name of the ** kwarg catch all.
The self-argument for methods is always removed.
"""
signature = inspect.signature(fn)
args = []
keywords = None
for arg in signature.parameters.values():
if arg.kind == arg.VAR_KEYWORD:
keywords = arg.name
elif arg.kind == arg.VAR_POSITIONAL:
continue # skip *args catch-all
else:
args.append(arg.name)
return tuple(args), keywords
def call_with_appropriate(fn, kwargs):
"""
Calls the function ``fn`` with the keyword arguments from ``kwargs`` it expects
If the kwargs argument is defined, pass all arguments, else provide exactly
the arguments wanted.
If one of the arguments of ``fn`` are not contained in kwargs, ``fn`` will not
be called and ``None`` will be returned.
"""
args, kwargs_name = signature(fn)
# no catch-all defined, we need to exactly pass the arguments specified.
if not kwargs_name:
kwargs = {key: kwargs[key] for key in kwargs if key in args}
# if any argument of fn is not in kwargs, just return None
if any(arg not in kwargs for arg in args):
return None
return fn(**kwargs)
def computed_values(d, kwargs=None):
"""
Returns a new `dict` that has callable values replaced with the return values.
Example::
>>> compute_values({'foo': lambda: 'bar'})
{'foo': 'bar'}
Arbitrarily deep structures are supported. The logic is as follows:
1. If the value is callable, call it and make that the new value.
2. If the value is an instance of dict, use ComputableDict to compute its keys.
Example::
>>> def parents():
... return {
... 'father': lambda: 'Foo',
... 'mother': 'Bar'
... }
...
>>> a = {
... 'name': 'Brad',
... 'parents': parents
... }
...
>>> computed_values(a)
{'name': 'Brad', 'parents': {'father': 'Foo', 'mother': 'Bar'}}
Arguments:
d (dict): The original dictionary.
kwargs: any extra keyword arguments will be passed to the callables, if the callable
takes an argument with such a name.
Returns:
dict: with callable values replaced.
"""
kwargs = kwargs or {}
result = {}
for k, v in d.items():
if callable(v):
v = call_with_appropriate(v, kwargs=kwargs)
if isinstance(v, dict):
v = computed_values(v, kwargs=kwargs)
result[k] = v
return result