Skip to content

pam.report.summary

TEXT #

Bases: Enum

BOLD = '\x1b[1m' class-attribute instance-attribute #

END = '\x1b[0m' class-attribute instance-attribute #

FAIL = '\x1b[91m' class-attribute instance-attribute #

HEADER = '\x1b[95m' class-attribute instance-attribute #

OKBLUE = '\x1b[94m' class-attribute instance-attribute #

OKCYAN = '\x1b[96m' class-attribute instance-attribute #

OKGREEN = '\x1b[92m' class-attribute instance-attribute #

TITLE = '\n\x1b[95m\x1b[4m\x1b[1m' class-attribute instance-attribute #

UNDERLINE = '\x1b[4m' class-attribute instance-attribute #

WARNING = '\x1b[93m' class-attribute instance-attribute #

activities_summary(population, key='subpopulation') #

Source code in src/pam/report/summary.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def activities_summary(population: Population, key="subpopulation") -> PrettyTable:
    table = PrettyTable()
    summary = {}
    summary["total"] = count_activites(population)
    slices = []

    if key is not None:
        slices = population.attributes.get(key, [])
        for value in slices:
            summary[value] = count_activites(population, key, value)

    table.field_names = ["activities", "total"] + list(slices)

    for stat, total_value in summary["total"].items():
        row = [stat, total_value]
        for k in slices:
            row.append(summary[k].get(stat))
        table.add_row(row)

    table.align["activities"] = "r"
    return table

calc_stats(population, key=None, value=None) #

Source code in src/pam/report/summary.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def calc_stats(population: Population, key=None, value=None) -> dict:
    summary = {"hhs": 0, "persons": 0}
    hh_occupants = []
    for _, hh in population:
        if key is not None and value not in hh.get_attribute(key):
            continue
        summary["hhs"] += hh.freq
        occupants = 0
        for _, person in hh:
            if key is not None and not person.attributes.get(key) == value:
                continue
            occupants += 1
            summary["persons"] += person.freq
        hh_occupants.append(occupants)
    if hh_occupants:
        summary["av_occupancy"] = sum(hh_occupants) / len(hh_occupants)
    return summary

count_activites(population, key=None, value=None) #

Source code in src/pam/report/summary.py 
178
179
180
181
182
183
184
185
186
187
def count_activites(population: Population, key=None, value=None) -> dict:
    classes = population.activity_classes
    summary = {a: 0 for a in classes}
    for _, _, person in population.people():
        if key is not None and not person.attributes.get(key) == value:
            continue
        freq = person.freq
        for act in person.activities:
            summary[act.act] += freq
    return summary

count_modes(population, key=None, value=None) #

Source code in src/pam/report/summary.py 
217
218
219
220
221
222
223
224
225
226
def count_modes(population: Population, key=None, value=None) -> dict:
    modes = population.mode_classes
    summary = {m: 0 for m in modes}
    for _, _, person in population.people():
        if key is not None and not person.attributes.get(key) == value:
            continue
        freq = person.freq
        for leg in person.legs:
            summary[leg.mode] += freq
    return summary

get_attributes(population, show=10, key=None, value=None) #

Source code in src/pam/report/summary.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
def get_attributes(population, show: int = 10, key=None, value=None) -> dict:
    attributes = defaultdict(set)
    for _, _, person in population.people():
        if key is not None and not person.attributes.get(key) == value:
            continue
        for k, v in person.attributes.items():
            if k == key:
                continue
            attributes[k].add(str(v))
    for k, v in attributes.items():
        if len(v) > show:
            attributes[k] = "---"
    return dict(attributes)

header(head) #

Source code in src/pam/report/summary.py 
22
23
def header(head: str):
    print(f"{TEXT.HEADER.value}{head}{TEXT.END.value}")

header_and_text(head, text) #

Source code in src/pam/report/summary.py 
26
27
def header_and_text(head: str, text: str):
    print(f"{TEXT.HEADER.value}{head}{TEXT.END.value} {text}")

modes_summary(population, key='subpopulation') #

Source code in src/pam/report/summary.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
def modes_summary(population: Population, key="subpopulation") -> PrettyTable:
    table = PrettyTable()
    summary = {}
    summary["total"] = count_modes(population)
    slices = []

    if key is not None:
        slices = population.attributes.get(key, [])
        for value in slices:
            summary[value] = count_modes(population, key, value)

    table.field_names = ["modes", "total"] + list(slices)

    for stat, total_value in summary["total"].items():
        row = [stat, total_value]
        for k in slices:
            row.append(summary[k].get(stat))
        table.add_row(row)

    table.align["modes"] = "r"

    return table

pretty_print_summary(population, key='subpopulation') #

Source code in src/pam/report/summary.py 
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
def pretty_print_summary(population: Population, key="subpopulation"):
    # stats
    header("Population Stats:")
    print(stats_summary(population, key))
    print()

    # attributes
    header("Population Attributes:")
    for k, vs in get_attributes(population).items():
        subheader_and_text(f"{k}:", vs)
    print()

    if key is not None:
        for v in population.attributes.get(key, []):
            header(f"Attribute: \033[4m{v}\033[0m:")
            for k, vs in get_attributes(population, key=key, value=v).items():
                subheader_and_text(f"{k}:", vs)
            print()

    # activites
    header("Activities:")
    print(activities_summary(population, key))
    print()

    # modes
    header("Modes:")
    print(modes_summary(population, key))

print_summary(population, key='subpopulation') #

Source code in src/pam/report/summary.py 
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
def print_summary(population: Population, key="subpopulation"):
    # stats
    print("Population Stats:")
    print(stats_summary(population, key))
    print()

    # attributes
    print("Population Attributes:")
    for k, vs in get_attributes(population).items():
        print(f"{k}:", vs)
    print()

    if key is not None:
        for v in population.attributes.get(key, []):
            print(f"Attribute: {v}")
            for k, vs in get_attributes(population, key=key, value=v).items():
                print(f"{k}:", vs)
            print()

    # activites
    print("Activities:")
    print(activities_summary(population, key))
    print()

    # modes
    print("Modes:")
    print(modes_summary(population, key))

stats_summary(population, key='subpopulation') #

Source code in src/pam/report/summary.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
def stats_summary(population: Population, key="subpopulation") -> PrettyTable:
    table = PrettyTable()
    summary = {}
    summary["total"] = calc_stats(population)
    slices = []

    if key is not None:
        slices = population.attributes.get(key, [])
        for value in slices:
            summary[value] = calc_stats(population, key, value)

    table.field_names = ["stat", "total"] + list(slices)

    for stat, total_value in summary["total"].items():
        row = [stat, total_value]
        for k in slices:
            row.append(summary[k].get(stat))
        table.add_row(row)

    table.align["stat"] = "r"
    return table

subheader_and_text(head, text) #

Source code in src/pam/report/summary.py 
30
31
def subheader_and_text(head: str, text: str):
    print(f"{TEXT.OKBLUE.value}{head}{TEXT.END.value} {text}")