summaryrefslogtreecommitdiffstats
path: root/tools/scripts/list_fields.py
blob: 1e637e9c1b924e183f188272ee322ced8e6ee576 (plain)
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
__all__ = ['pretty_print_model_fields']


def _get_class_full_name(cls_):
    return cls_.__module__ + '.' + cls_.__name__


class _ModelFieldRow(object):

    def __init__(self, field):
        self.field = field
        self.name = field.name
        self.type_ = _get_class_full_name(type(field))
        if self.field.many_to_many\
                or self.field.many_to_one\
                or self.field.one_to_many\
                or self.field.one_to_one:
            self.related_model = _get_class_full_name(self.field.remote_field.model)
        else:
            self.related_model = 'N/A'

    def pretty_print(self, max_name_len, max_type_len, max_rel_model_len):
        row = []
        row.append(self.name)
        row.append(' ' * (max_name_len - len(self.name)))
        row.append('|')
        row.append(self.type_)
        row.append(' ' * (max_type_len - len(self.type_)))
        row.append('|')
        row.append(self.related_model)
        row.append(' ' * (max_rel_model_len - len(self.related_model)))
        print(''.join(row))


def pretty_print_model_fields(model):
    field_info_rows = []
    max_lens = [0, 0, 0]
    for field in model._meta.get_fields():
        field_info_rows.append(_ModelFieldRow(field))
        max_lens[0] = max(max_lens[0], len(field_info_rows[-1].name))
        max_lens[1] = max(max_lens[1], len(field_info_rows[-1].type_))
        max_lens[2] = max(max_lens[2], len(field_info_rows[-1].related_model))
    print('=' * (sum(max_lens) + len(max_lens) - 1))
    for row in field_info_rows:
        row.pretty_print(*max_lens)
        print('=' * (sum(max_lens) + len(max_lens) - 1))