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
|
"""Test support of the various forms of tabular data."""
from tabulate import tabulate
from common import assert_equal, assert_in, raises, skip
try:
from collections import UserDict
except ImportError:
# Python2
from UserDict import UserDict
def test_iterable_of_iterables():
"Input: an interable of iterables."
ii = iter(map(lambda x: iter(x), [range(5), range(5, 0, -1)]))
expected = "\n".join(
["- - - - -", "0 1 2 3 4", "5 4 3 2 1", "- - - - -"]
)
result = tabulate(ii)
assert_equal(expected, result)
def test_iterable_of_iterables_headers():
"Input: an interable of iterables with headers."
ii = iter(map(lambda x: iter(x), [range(5), range(5, 0, -1)]))
expected = "\n".join(
[
" a b c d e",
"--- --- --- --- ---",
" 0 1 2 3 4",
" 5 4 3 2 1",
]
)
result = tabulate(ii, "abcde")
assert_equal(expected, result)
def test_iterable_of_iterables_firstrow():
"Input: an interable of iterables with the first row as headers"
ii = iter(map(lambda x: iter(x), ["abcde", range(5), range(5, 0, -1)]))
expected = "\n".join(
[
" a b c d e",
"--- --- --- --- ---",
" 0 1 2 3 4",
" 5 4 3 2 1",
]
)
result = tabulate(ii, "firstrow")
assert_equal(expected, result)
def test_list_of_lists():
"Input: a list of lists with headers."
ll = [["a", "one", 1], ["b", "two", None]]
expected = "\n".join(
[
" string number",
"-- -------- --------",
"a one 1",
"b two",
]
)
result = tabulate(ll, headers=["string", "number"])
assert_equal(expected, result)
def test_list_of_lists_firstrow():
"Input: a list of lists with the first row as headers."
ll = [["string", "number"], ["a", "one", 1], ["b", "two", None]]
expected = "\n".join(
[
" string number",
"-- -------- --------",
"a one 1",
"b two",
]
)
result = tabulate(ll, headers="firstrow")
assert_equal(expected, result)
def test_list_of_lists_keys():
"Input: a list of lists with column indices as headers."
ll = [["a", "one", 1], ["b", "two", None]]
expected = "\n".join(
["0 1 2", "--- --- ---", "a one 1", "b two"]
)
result = tabulate(ll, headers="keys")
assert_equal(expected, result)
def test_dict_like():
"Input: a dict of iterables with keys as headers."
# columns should be padded with None, keys should be used as headers
dd = {"a": range(3), "b": range(101, 105)}
# keys' order (hence columns' order) is not deterministic in Python 3
# => we have to consider both possible results as valid
expected1 = "\n".join(
[" a b", "--- ---", " 0 101", " 1 102", " 2 103", " 104"]
)
expected2 = "\n".join(
[" b a", "--- ---", "101 0", "102 1", "103 2", "104"]
)
result = tabulate(dd, "keys")
print("Keys' order: %s" % dd.keys())
assert_in(result, [expected1, expected2])
def test_numpy_2d():
"Input: a 2D NumPy array with headers."
try:
import numpy
na = (numpy.arange(1, 10, dtype=numpy.float32).reshape((3, 3)) ** 3) * 0.5
expected = "\n".join(
[
" a b c",
"----- ----- -----",
" 0.5 4 13.5",
" 32 62.5 108",
"171.5 256 364.5",
]
)
result = tabulate(na, ["a", "b", "c"])
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d is skipped")
def test_numpy_2d_firstrow():
"Input: a 2D NumPy array with the first row as headers."
try:
import numpy
na = numpy.arange(1, 10, dtype=numpy.int32).reshape((3, 3)) ** 3
expected = "\n".join(
[" 1 8 27", "--- --- ----", " 64 125 216", "343 512 729"]
)
result = tabulate(na, headers="firstrow")
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d_firstrow is skipped")
def test_numpy_2d_keys():
"Input: a 2D NumPy array with column indices as headers."
try:
import numpy
na = (numpy.arange(1, 10, dtype=numpy.float32).reshape((3, 3)) ** 3) * 0.5
expected = "\n".join(
[
" 0 1 2",
"----- ----- -----",
" 0.5 4 13.5",
" 32 62.5 108",
"171.5 256 364.5",
]
)
result = tabulate(na, headers="keys")
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d_keys is skipped")
def test_numpy_record_array():
"Input: a 2D NumPy record array without header."
try:
import numpy
na = numpy.asarray(
[("Alice", 23, 169.5), ("Bob", 27, 175.0)],
dtype={
"names": ["name", "age", "height"],
"formats": ["a32", "uint8", "float32"],
},
)
expected = "\n".join(
[
"----- -- -----",
"Alice 23 169.5",
"Bob 27 175",
"----- -- -----",
]
)
result = tabulate(na)
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d_keys is skipped")
def test_numpy_record_array_keys():
"Input: a 2D NumPy record array with column names as headers."
try:
import numpy
na = numpy.asarray(
[("Alice", 23, 169.5), ("Bob", 27, 175.0)],
dtype={
"names": ["name", "age", "height"],
"formats": ["a32", "uint8", "float32"],
},
)
expected = "\n".join(
[
"name age height",
"------ ----- --------",
"Alice 23 169.5",
"Bob 27 175",
]
)
result = tabulate(na, headers="keys")
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d_keys is skipped")
def test_numpy_record_array_headers():
"Input: a 2D NumPy record array with user-supplied headers."
try:
import numpy
na = numpy.asarray(
[("Alice", 23, 169.5), ("Bob", 27, 175.0)],
dtype={
"names": ["name", "age", "height"],
"formats": ["a32", "uint8", "float32"],
},
)
expected = "\n".join(
[
"person years cm",
"-------- ------- -----",
"Alice 23 169.5",
"Bob 27 175",
]
)
result = tabulate(na, headers=["person", "years", "cm"])
assert_equal(expected, result)
except ImportError:
skip("test_numpy_2d_keys is skipped")
def test_pandas():
"Input: a Pandas DataFrame."
try:
import pandas
df = pandas.DataFrame([["one", 1], ["two", None]], index=["a", "b"])
expected = "\n".join(
[
" string number",
"-- -------- --------",
"a one 1",
"b two nan",
]
)
result = tabulate(df, headers=["string", "number"])
assert_equal(expected, result)
except ImportError:
skip("test_pandas is skipped")
def test_pandas_firstrow():
"Input: a Pandas DataFrame with the first row as headers."
try:
import pandas
df = pandas.DataFrame(
[["one", 1], ["two", None]], columns=["string", "number"], index=["a", "b"]
)
expected = "\n".join(
["a one 1.0", "--- ----- -----", "b two nan"]
)
result = tabulate(df, headers="firstrow")
assert_equal(expected, result)
except ImportError:
skip("test_pandas_firstrow is skipped")
def test_pandas_keys():
"Input: a Pandas DataFrame with keys as headers."
try:
import pandas
df = pandas.DataFrame(
[["one", 1], ["two", None]], columns=["string", "number"], index=["a", "b"]
)
expected = "\n".join(
[
" string number",
"-- -------- --------",
"a one 1",
"b two nan",
]
)
result = tabulate(df, headers="keys")
assert_equal(expected, result)
except ImportError:
skip("test_pandas_keys is skipped")
def test_sqlite3():
"Input: an sqlite3 cursor"
try:
import sqlite3
conn = sqlite3.connect(":memory:")
cursor = conn.cursor()
cursor.execute("CREATE TABLE people (name, age, height)")
for values in [("Alice", 23, 169.5), ("Bob", 27, 175.0)]:
cursor.execute("INSERT INTO people VALUES (?, ?, ?)", values)
cursor.execute("SELECT name, age, height FROM people ORDER BY name")
result = tabulate(cursor, headers=["whom", "how old", "how tall"])
expected = """\
whom how old how tall
------ --------- ----------
Alice 23 169.5
Bob 27 175"""
assert_equal(expected, result)
except ImportError:
skip("test_sqlite3 is skipped")
def test_sqlite3_keys():
"Input: an sqlite3 cursor with keys as headers"
try:
import sqlite3
conn = sqlite3.connect(":memory:")
cursor = conn.cursor()
cursor.execute("CREATE TABLE people (name, age, height)")
for values in [("Alice", 23, 169.5), ("Bob", 27, 175.0)]:
cursor.execute("INSERT INTO people VALUES (?, ?, ?)", values)
cursor.execute(
'SELECT name "whom", age "how old", height "how tall" FROM people ORDER BY name'
)
result = tabulate(cursor, headers="keys")
expected = """\
whom how old how tall
------ --------- ----------
Alice 23 169.5
Bob 27 175"""
assert_equal(expected, result)
except ImportError:
skip("test_sqlite3_keys is skipped")
def test_list_of_namedtuples():
"Input: a list of named tuples with field names as headers."
from collections import namedtuple
NT = namedtuple("NT", ["foo", "bar"])
lt = [NT(1, 2), NT(3, 4)]
expected = "\n".join(["- -", "1 2", "3 4", "- -"])
result = tabulate(lt)
assert_equal(expected, result)
def test_list_of_namedtuples_keys():
"Input: a list of named tuples with field names as headers."
from collections import namedtuple
NT = namedtuple("NT", ["foo", "bar"])
lt = [NT(1, 2), NT(3, 4)]
expected = "\n".join(
[" foo bar", "----- -----", " 1 2", " 3 4"]
)
result = tabulate(lt, headers="keys")
assert_equal(expected, result)
def test_list_of_dicts():
"Input: a list of dictionaries."
lod = [{"foo": 1, "bar": 2}, {"foo": 3, "bar": 4}]
expected1 = "\n".join(["- -", "1 2", "3 4", "- -"])
expected2 = "\n".join(["- -", "2 1", "4 3", "- -"])
result = tabulate(lod)
assert_in(result, [expected1, expected2])
def test_list_of_userdicts():
"Input: a list of UserDicts."
lod = [UserDict(foo=1, bar=2), UserDict(foo=3, bar=4)]
expected1 = "\n".join(["- -", "1 2", "3 4", "- -"])
expected2 = "\n".join(["- -", "2 1", "4 3", "- -"])
result = tabulate(lod)
assert_in(result, [expected1, expected2])
def test_list_of_dicts_keys():
"Input: a list of dictionaries, with keys as headers."
lod = [{"foo": 1, "bar": 2}, {"foo": 3, "bar": 4}]
expected1 = "\n".join(
[" foo bar", "----- -----", " 1 2", " 3 4"]
)
expected2 = "\n".join(
[" bar foo", "----- -----", " 2 1", " 4 3"]
)
result = tabulate(lod, headers="keys")
assert_in(result, [expected1, expected2])
def test_list_of_userdicts_keys():
"Input: a list of UserDicts."
lod = [UserDict(foo=1, bar=2), UserDict(foo=3, bar=4)]
expected1 = "\n".join(
[" foo bar", "----- -----", " 1 2", " 3 4"]
)
expected2 = "\n".join(
[" bar foo", "----- -----", " 2 1", " 4 3"]
)
result = tabulate(lod, headers="keys")
assert_in(result, [expected1, expected2])
def test_list_of_dicts_with_missing_keys():
"Input: a list of dictionaries, with missing keys."
lod = [{"foo": 1}, {"bar": 2}, {"foo": 4, "baz": 3}]
expected = "\n".join(
[
" foo bar baz",
"----- ----- -----",
" 1",
" 2",
" 4 3",
]
)
result = tabulate(lod, headers="keys")
assert_equal(expected, result)
def test_list_of_dicts_firstrow():
"Input: a list of dictionaries, with the first dict as headers."
lod = [{"foo": "FOO", "bar": "BAR"}, {"foo": 3, "bar": 4, "baz": 5}]
# if some key is missing in the first dict, use the key name instead
expected1 = "\n".join(
[" FOO BAR baz", "----- ----- -----", " 3 4 5"]
)
expected2 = "\n".join(
[" BAR FOO baz", "----- ----- -----", " 4 3 5"]
)
result = tabulate(lod, headers="firstrow")
assert_in(result, [expected1, expected2])
def test_list_of_dicts_with_dict_of_headers():
"Input: a dict of user headers for a list of dicts (issue #23)"
table = [{"letters": "ABCDE", "digits": 12345}]
headers = {"digits": "DIGITS", "letters": "LETTERS"}
expected1 = "\n".join(
[" DIGITS LETTERS", "-------- ---------", " 12345 ABCDE"]
)
expected2 = "\n".join(
["LETTERS DIGITS", "--------- --------", "ABCDE 12345"]
)
result = tabulate(table, headers=headers)
assert_in(result, [expected1, expected2])
def test_list_of_dicts_with_list_of_headers():
"Input: ValueError on a list of headers with a list of dicts (issue #23)"
table = [{"letters": "ABCDE", "digits": 12345}]
headers = ["DIGITS", "LETTERS"]
with raises(ValueError):
tabulate(table, headers=headers)
def test_list_of_ordereddicts():
"Input: a list of OrderedDicts."
from collections import OrderedDict
od = OrderedDict([("b", 1), ("a", 2)])
lod = [od, od]
expected = "\n".join([" b a", "--- ---", " 1 2", " 1 2"])
result = tabulate(lod, headers="keys")
assert_equal(expected, result)
def test_py37orlater_list_of_dataclasses_keys():
"Input: a list of dataclasses with first item's fields as keys and headers"
try:
from dataclasses import make_dataclass
Person = make_dataclass("Person", ["name", "age", "height"])
ld = [Person("Alice", 23, 169.5), Person("Bob", 27, 175.0)]
result = tabulate(ld, headers="keys")
expected = "\n".join(
[
"name age height",
"------ ----- --------",
"Alice 23 169.5",
"Bob 27 175",
]
)
assert_equal(expected, result)
except ImportError:
skip("test_py37orlater_list_of_dataclasses_keys is skipped")
def test_py37orlater_list_of_dataclasses_headers():
"Input: a list of dataclasses with user-supplied headers"
try:
from dataclasses import make_dataclass
Person = make_dataclass("Person", ["name", "age", "height"])
ld = [Person("Alice", 23, 169.5), Person("Bob", 27, 175.0)]
result = tabulate(ld, headers=["person", "years", "cm"])
expected = "\n".join(
[
"person years cm",
"-------- ------- -----",
"Alice 23 169.5",
"Bob 27 175",
]
)
assert_equal(expected, result)
except ImportError:
skip("test_py37orlater_list_of_dataclasses_headers is skipped")
def test_list_bytes():
"Input: a list of bytes. (issue #192)"
lb = [["你好".encode("utf-8")], ["你好"]]
expected = "\n".join(
["bytes", "---------------------------", r"b'\xe4\xbd\xa0\xe5\xa5\xbd'", "你好"]
)
result = tabulate(lb, headers=["bytes"])
assert_equal(expected, result)
|