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
|
#!/usr/bin/env python
# coding=utf-8
"""A simple example demonstrating the following:
1) How to display tabular data
2) How to display output using a pager
NOTE: IF the table does not entirely fit within the screen of your terminal, then it will be displayed using a pager.
You can use the arrow keys (left, right, up, and down) to scroll around the table as well as the PageUp/PageDown keys.
You can quit out of the pager by typing "q". You can also search for text within the pager using "/".
WARNING: This example requires the tableformatter module: https://github.com/python-tableformatter/tableformatter
- pip install tableformatter
"""
import functools
import cmd2
import tableformatter as tf
try:
from colored import bg
BACK_PRI = bg(4)
BACK_ALT = bg(2)
except ImportError:
try:
from colorama import Back
BACK_PRI = Back.LIGHTBLUE_EX
BACK_ALT = Back.LIGHTYELLOW_EX
except ImportError:
BACK_PRI = ''
BACK_ALT = ''
# Format to use for the grid style when displaying tables with the tableformatter module
grid_style = tf.AlternatingRowGrid(BACK_PRI, BACK_ALT) # Use rows of alternating color to assist as a visual guide
# Create a function to format a fixed-width table for pretty-printing using the desired table format
table = functools.partial(tf.generate_table, grid_style=grid_style)
# Population data from Wikipedia: https://en.wikipedia.org/wiki/List_of_cities_proper_by_population
EXAMPLE_DATA = [['Shanghai', 'Shanghai', 'China', 'Asia', 24183300, 6340.5],
['Beijing', 'Hebei', 'China', 'Asia', 20794000, 1749.57],
['Karachi', 'Sindh', 'Pakistan', 'Asia', 14910352, 615.58],
['Shenzen', 'Guangdong', 'China', 'Asia', 13723000, 1493.32],
['Guangzho', 'Guangdong', 'China', 'Asia', 13081000, 1347.81],
['Mumbai', 'Maharashtra', 'India', 'Asia', 12442373, 465.78],
['Istanbul', 'Istanbul', 'Turkey', 'Eurasia', 12661000, 620.29],
]
# Calculate population density
for row in EXAMPLE_DATA:
row.append(row[-2]/row[-1])
# TODO: Color row text foreground based on population density
def no_dec(num: float) -> str:
"""Format a floating point number with no decimal places."""
return "{}".format(round(num))
def two_dec(num: float) -> str:
"""Format a floating point number with 2 decimal places."""
return "{0:.2f}".format(num)
# # Column headers plus optional formatting info for each column
columns = [tf.Column('City', header_halign=tf.ColumnAlignment.AlignCenter),
tf.Column('Province', header_halign=tf.ColumnAlignment.AlignCenter),
'Country', # NOTE: If you don't need any special effects, you can just pass a string
tf.Column('Continent', cell_halign=tf.ColumnAlignment.AlignCenter),
tf.Column('Population', cell_halign=tf.ColumnAlignment.AlignRight, formatter=tf.FormatCommas()),
tf.Column('Area (km^2)', cell_halign=tf.ColumnAlignment.AlignRight, formatter=two_dec),
tf.Column('Pop. Density (/km^2)', width=12, cell_halign=tf.ColumnAlignment.AlignRight, formatter=no_dec),
]
class TableDisplay(cmd2.Cmd):
"""Example cmd2 application showing how you can display tabular data."""
def __init__(self):
super().__init__()
def ptable(self, tabular_data, headers=()):
"""Format tabular data for pretty-printing as a fixed-width table and then display it using a pager.
:param tabular_data: required argument - can be a list-of-lists (or another iterable of iterables), a list of
named tuples, a dictionary of iterables, an iterable of dictionaries, a two-dimensional
NumPy array, NumPy record array, or a Pandas dataframe.
:param headers: (optional) - to print nice column headers, supply this argument:
- headers can be an explicit list of column headers
- if `headers="firstrow"`, then the first row of data is used
- if `headers="keys"`, then dictionary keys or column indices are used
- Otherwise, a headerless table is produced
"""
formatted_table = table(rows=tabular_data, columns=headers)
self.ppaged(formatted_table, chop=True)
def do_table(self, _):
"""Display data on the Earth's most populated cities in a table."""
self.ptable(EXAMPLE_DATA, columns)
if __name__ == '__main__':
app = TableDisplay()
app.debug = True
app.cmdloop()
|
