def test_column_alignment(): column_1 = Column("Col 1", width=10, header_horiz_align=HorizontalAlignment.LEFT, header_vert_align=VerticalAlignment.TOP, data_horiz_align=HorizontalAlignment.LEFT, data_vert_align=VerticalAlignment.TOP) column_2 = Column("Col 2", width=10, header_horiz_align=HorizontalAlignment.CENTER, header_vert_align=VerticalAlignment.MIDDLE, data_horiz_align=HorizontalAlignment.CENTER, data_vert_align=VerticalAlignment.MIDDLE) column_3 = Column("Col 3", width=10, header_horiz_align=HorizontalAlignment.RIGHT, header_vert_align=VerticalAlignment.BOTTOM, data_horiz_align=HorizontalAlignment.RIGHT, data_vert_align=VerticalAlignment.BOTTOM) column_4 = Column("Three\nline\nheader", width=10) columns = [column_1, column_2, column_3, column_4] tc = TableCreator(columns) # Check defaults assert column_4.header_horiz_align == HorizontalAlignment.LEFT assert column_4.header_vert_align == VerticalAlignment.BOTTOM assert column_4.data_horiz_align == HorizontalAlignment.LEFT assert column_4.data_vert_align == VerticalAlignment.TOP # Create a header row header = tc.generate_row() assert header == ('Col 1 Three \n' ' Col 2 line \n' ' Col 3 header ') # Create a data row row_data = ["Val 1", "Val 2", "Val 3", "Three\nline\ndata"] row = tc.generate_row(row_data=row_data) assert row == ('Val 1 Three \n' ' Val 2 line \n' ' Val 3 data ')
def test_wrap_long_word_max_data_lines(): column_1 = Column("Col 1", width=10, max_data_lines=2) column_2 = Column("Col 2", width=10, max_data_lines=2) column_3 = Column("Col 3", width=10, max_data_lines=2) column_4 = Column("Col 4", width=10, max_data_lines=1) columns = [column_1, column_2, column_3, column_4] tc = TableCreator(columns) row_data = list() # This long word will exactly fit the last line and it's the final word in the text. No ellipsis should appear. row_data.append("LongerThan10FitsLast") # This long word will exactly fit the last line but it's not the final word in the text. # Make sure ellipsis word's final character. row_data.append("LongerThan10FitsLast\nMore lines") # This long word will run over the last line. Make sure it is truncated. row_data.append("LongerThan10RunsOverLast") # This long word will start on the final line after another word. Therefore it won't wrap but will instead be truncated. row_data.append("A LongerThan10RunsOverLast") row = tc.generate_row(row_data=row_data) assert row == ('LongerThan LongerThan LongerThan A LongerT…\n' '10FitsLast 10FitsLas… 10RunsOve… ')
def test_wrap_long_word(): # Make sure words wider than column start on own line and wrap column_1 = Column("LongColumnName", width=10) column_2 = Column("Col 2", width=10) columns = [column_1, column_2] tc = TableCreator(columns) # Test header row header = tc.generate_row() assert header == ('LongColumn \n' 'Name Col 2 ') # Test data row row_data = list() # Long word should start on the first line (style should not affect width) row_data.append(ansi.style("LongerThan10", fg=ansi.fg.green)) # Long word should start on the second line row_data.append("Word LongerThan10") row = tc.generate_row(row_data=row_data) expected = (ansi.RESET_ALL + ansi.fg.green + "LongerThan" + ansi.RESET_ALL + " Word \n" + ansi.RESET_ALL + ansi.fg.green + "10" + ansi.fg.reset + ansi.RESET_ALL + ' ' + ansi.RESET_ALL + ' LongerThan\n' ' 10 ') assert row == expected
def test_tabs(): column_1 = Column("Col\t1", width=20) column_2 = Column("Col 2") tc = TableCreator([column_1, column_2], tab_width=2) row = tc.generate_row(fill_char='\t', pre_line='\t', inter_cell='\t', post_line='\t') assert row == ' Col 1 Col 2 '
def test_wrap_long_char_wider_than_max_width(): """ This tests case where a character is wider than max_width. This can happen if max_width is 1 and the text contains wide characters (e.g. East Asian). Replace it with an ellipsis. """ column_1 = Column("Col 1", width=1) tc = TableCreator([column_1]) row = tc.generate_row(row_data=['深']) assert row == '…'
def test_tabs(): column_1 = Column("Col\t1", width=20) column_2 = Column("Col 2") tc = TableCreator([column_1, column_2], tab_width=2) row = tc.generate_row(fill_char='\t', pre_line='\t', inter_cell='\t', post_line='\t') assert row == ' Col 1 Col 2 ' with pytest.raises(ValueError) as excinfo: TableCreator([column_1, column_2], tab_width=0) assert "Tab width cannot be less than 1" in str(excinfo.value)
def test_blank_last_line(): """This tests that an empty line is inserted when the last data line is blank""" column_1 = Column("Col 1", width=10) tc = TableCreator([column_1]) row_data = ['my line\n\n'] row = tc.generate_row(row_data=row_data) assert row == ('my line \n' ' ') row_data = ['\n'] row = tc.generate_row(row_data=row_data) assert row == ' ' row_data = [''] row = tc.generate_row(row_data=row_data) assert row == ' '
def test_wrap_text_max_lines(): column_1 = Column("Col 1", width=10, max_data_lines=2) tc = TableCreator([column_1]) # Test not needing to truncate the final line row_data = ['First line last line'] row = tc.generate_row(row_data=row_data) assert row == ('First line\n' 'last line ') # Test having to truncate the last word because it's too long for the final line row_data = ['First line last lineextratext'] row = tc.generate_row(row_data=row_data) assert row == ('First line\n' 'last line…') # Test having to truncate the last word because it fits the final line but there is more text not being included row_data = ['First line thistxtfit extra'] row = tc.generate_row(row_data=row_data) assert row == ('First line\n' 'thistxtfi…') # Test having to truncate the last word because it fits the final line but there are more lines not being included row_data = ['First line thistxtfit\nextra'] row = tc.generate_row(row_data=row_data) assert row == ('First line\n' 'thistxtfi…') # Test having space left on the final line and adding an ellipsis because there are more lines not being included row_data = ['First line last line\nextra line'] row = tc.generate_row(row_data=row_data) assert row == ('First line\n' 'last line…')
def test_column_creation(): # Width less than 1 with pytest.raises(ValueError) as excinfo: Column("Column 1", width=0) assert "Column width cannot be less than 1" in str(excinfo.value) # Width specified c = Column("header", width=20) assert c.width == 20 # max_data_lines less than 1 with pytest.raises(ValueError) as excinfo: Column("Column 1", max_data_lines=0) assert "Max data lines cannot be less than 1" in str(excinfo.value) # No width specified, blank label c = Column("") assert c.width < 0 tc = TableCreator([c]) assert tc.cols[0].width == 1 # No width specified, label isn't blank but has no width c = Column(ansi.style('', fg=ansi.fg.green)) assert c.width < 0 tc = TableCreator([c]) assert tc.cols[0].width == 1 # No width specified, label has width c = Column("a line") assert c.width < 0 tc = TableCreator([c]) assert tc.cols[0].width == ansi.style_aware_wcswidth("a line") # No width specified, label has width and multiple lines c = Column("short\nreally long") assert c.width < 0 tc = TableCreator([c]) assert tc.cols[0].width == ansi.style_aware_wcswidth("really long") # No width specified, label has tabs c = Column("line\twith\ttabs") assert c.width < 0 tc = TableCreator([c]) assert tc.cols[0].width == ansi.style_aware_wcswidth( "line with tabs")
def test_wrap_text(): column_1 = Column("Col 1", width=10) tc = TableCreator([column_1]) # Test normal wrapping row_data = ['Some text to wrap\nA new line that will wrap\nNot wrap\n 1 2 3'] row = tc.generate_row(row_data=row_data) assert row == ('Some text \n' 'to wrap \n' 'A new line\n' 'that will \n' 'wrap \n' 'Not wrap \n' ' 1 2 3 ') # Test preserving a multiple space sequence across a line break row_data = ['First last one'] row = tc.generate_row(row_data=row_data) assert row == ('First \n' ' last one ')
def test_generate_row_exceptions(): column_1 = Column("Col 1") tc = TableCreator([column_1]) row_data = ['fake'] # fill_char too long with pytest.raises(TypeError) as excinfo: tc.generate_row(row_data=row_data, fill_char='too long') assert "Fill character must be exactly one character long" in str(excinfo.value) # Unprintable characters for arg in ['fill_char', 'pre_line', 'inter_cell', 'post_line']: kwargs = {arg: '\n'} with pytest.raises(ValueError) as excinfo: tc.generate_row(row_data=row_data, **kwargs) assert "{} contains an unprintable character".format(arg) in str(excinfo.value) # data with too many columns row_data = ['Data 1', 'Extra Column'] with pytest.raises(ValueError) as excinfo: tc.generate_row(row_data=row_data) assert "Length of row_data must match length of cols" in str(excinfo.value)