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
|
"""Command-line interface.
"""
import os
import sys
import subprocess
import tempfile
from common import assert_equal
SAMPLE_SIMPLE_FORMAT = "\n".join(
[
"----- ------ -------------",
"Sun 696000 1.9891e+09",
"Earth 6371 5973.6",
"Moon 1737 73.5",
"Mars 3390 641.85",
"----- ------ -------------",
]
)
SAMPLE_SIMPLE_FORMAT_WITH_HEADERS = "\n".join(
[
"Planet Radius Mass",
"-------- -------- -------------",
"Sun 696000 1.9891e+09",
"Earth 6371 5973.6",
"Moon 1737 73.5",
"Mars 3390 641.85",
]
)
SAMPLE_GRID_FORMAT_WITH_HEADERS = "\n".join(
[
"+----------+----------+---------------+",
"| Planet | Radius | Mass |",
"+==========+==========+===============+",
"| Sun | 696000 | 1.9891e+09 |",
"+----------+----------+---------------+",
"| Earth | 6371 | 5973.6 |",
"+----------+----------+---------------+",
"| Moon | 1737 | 73.5 |",
"+----------+----------+---------------+",
"| Mars | 3390 | 641.85 |",
"+----------+----------+---------------+",
]
)
SAMPLE_GRID_FORMAT_WITH_DOT1E_FLOATS = "\n".join(
[
"+-------+--------+---------+",
"| Sun | 696000 | 2.0e+09 |",
"+-------+--------+---------+",
"| Earth | 6371 | 6.0e+03 |",
"+-------+--------+---------+",
"| Moon | 1737 | 7.4e+01 |",
"+-------+--------+---------+",
"| Mars | 3390 | 6.4e+02 |",
"+-------+--------+---------+",
]
)
def sample_input(sep=" ", with_headers=False):
headers = sep.join(["Planet", "Radius", "Mass"])
rows = [
sep.join(["Sun", "696000", "1.9891e9"]),
sep.join(["Earth", "6371", "5973.6"]),
sep.join(["Moon", "1737", "73.5"]),
sep.join(["Mars", "3390", "641.85"]),
]
all_rows = ([headers] + rows) if with_headers else rows
table = "\n".join(all_rows)
return table
def run_and_capture_stdout(cmd, input=None):
x = subprocess.Popen(
cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
input_buf = input.encode() if input else None
out, err = x.communicate(input=input_buf)
out = out.decode("utf-8")
if x.returncode != 0:
raise OSError(err)
return out
class TemporaryTextFile:
def __init__(self):
self.tmpfile = None
def __enter__(self):
self.tmpfile = tempfile.NamedTemporaryFile(
"w+", prefix="tabulate-test-tmp-", delete=False
)
return self.tmpfile
def __exit__(self, exc_type, exc_val, exc_tb):
if self.tmpfile:
self.tmpfile.close()
os.unlink(self.tmpfile.name)
def test_script_from_stdin_to_stdout():
"""Command line utility: read from stdin, print to stdout"""
cmd = [sys.executable, "tabulate/__init__.py"]
out = run_and_capture_stdout(cmd, input=sample_input())
expected = SAMPLE_SIMPLE_FORMAT
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_from_file_to_stdout():
"""Command line utility: read from file, print to stdout"""
with TemporaryTextFile() as tmpfile:
tmpfile.write(sample_input())
tmpfile.seek(0)
cmd = [sys.executable, "tabulate/__init__.py", tmpfile.name]
out = run_and_capture_stdout(cmd)
expected = SAMPLE_SIMPLE_FORMAT
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_from_file_to_file():
"""Command line utility: read from file, write to file"""
with TemporaryTextFile() as input_file:
with TemporaryTextFile() as output_file:
input_file.write(sample_input())
input_file.seek(0)
cmd = [
sys.executable,
"tabulate/__init__.py",
"-o",
output_file.name,
input_file.name,
]
out = run_and_capture_stdout(cmd)
# check that nothing is printed to stdout
expected = ""
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
# check that the output was written to file
output_file.seek(0)
out = output_file.file.read()
expected = SAMPLE_SIMPLE_FORMAT
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_header_option():
"""Command line utility: -1, --header option"""
for option in ["-1", "--header"]:
cmd = [sys.executable, "tabulate/__init__.py", option]
raw_table = sample_input(with_headers=True)
out = run_and_capture_stdout(cmd, input=raw_table)
expected = SAMPLE_SIMPLE_FORMAT_WITH_HEADERS
print(out)
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_sep_option():
"""Command line utility: -s, --sep option"""
for option in ["-s", "--sep"]:
cmd = [sys.executable, "tabulate/__init__.py", option, ","]
raw_table = sample_input(sep=",")
out = run_and_capture_stdout(cmd, input=raw_table)
expected = SAMPLE_SIMPLE_FORMAT
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_floatfmt_option():
"""Command line utility: -F, --float option"""
for option in ["-F", "--float"]:
cmd = [
sys.executable,
"tabulate/__init__.py",
option,
".1e",
"--format",
"grid",
]
raw_table = sample_input()
out = run_and_capture_stdout(cmd, input=raw_table)
expected = SAMPLE_GRID_FORMAT_WITH_DOT1E_FLOATS
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
def test_script_format_option():
"""Command line utility: -f, --format option"""
for option in ["-f", "--format"]:
cmd = [sys.executable, "tabulate/__init__.py", "-1", option, "grid"]
raw_table = sample_input(with_headers=True)
out = run_and_capture_stdout(cmd, input=raw_table)
expected = SAMPLE_GRID_FORMAT_WITH_HEADERS
print(out)
print("got: ", repr(out))
print("expected:", repr(expected))
assert_equal(out.splitlines(), expected.splitlines())
|