Skip to content

Commit 31c15c7

Browse files
committed
Fix and documentation
1 parent 8c3892e commit 31c15c7

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

CSVLibrary/__init__.py

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import csv
22
from robot.api import logger
3+
from version import VERSION
4+
5+
__version__ = VERSION
36

47

58
class CSVLibrary(object):
@@ -30,48 +33,64 @@ def _open_csv_file_for_write(filename, data, csv_writer=csv.writer, **kwargs):
3033
@staticmethod
3134
def empty_csv_file(filename):
3235
"""This keyword will empty the CSV file.
36+
37+
- ``filename``: name of csv file
3338
"""
3439
with open(filename, "w") as csv_handler:
3540
csv_handler.truncate()
3641

3742
def read_csv_file_to_list(self, filename, delimiter=','):
3843
"""Read CSV file and return its content as a Python list of tuples.
44+
45+
- ``filename``: name of csv file
46+
- ``delimiter``: Default: `,`
3947
"""
4048
csv_list = self._open_csv_file_for_read(
4149
filename,
4250
csv_reader=csv.reader,
43-
delimiter=delimiter
51+
delimiter=str(delimiter)
4452
)
4553
return [tuple(row) for row in csv_list]
4654

4755
def read_csv_file_to_associative(self, filename, delimiter=',', fieldnames=None):
4856
"""Read CSV file and return its content as a Python list of dictionaries.
57+
58+
- ``filename``: name of csv file
59+
- ``delimiter``: Default: `,`
60+
- ``fieldnames``: list of column names
4961
"""
5062
csv_dict = self._open_csv_file_for_read(
5163
filename,
5264
csv_reader=csv.DictReader,
53-
delimiter=delimiter,
65+
delimiter=str(delimiter),
5466
fieldnames=fieldnames
5567
)
56-
return csv_dict
68+
return [item for item in csv_dict]
5769

5870
def append_to_csv_file(self, filename, data):
5971
"""This keyword will append data to a new or existing CSV file.
60-
Data should be iterable (e.g. list or tuple)
72+
73+
- ``filename``: name of csv file
74+
- ``data``: iterable(e.g. list or tuple) data.
6175
"""
6276
if isinstance(data[0], dict):
6377
data = map(lambda row: row.items(), data)
6478
self._open_csv_file_for_write(filename, data=data, csv_writer=csv.writer)
6579

6680
def csv_file_from_associative(self, filename, data, fieldnames=None, delimiter=','):
6781
"""This keyword will create new file
82+
83+
- ``filename``: name of csv file
84+
- ``data``: iterable(e.g. list or tuple) data.
85+
- ``fieldnames``: list of column names
86+
- ``delimiter``: Default: `,`
6887
"""
6988
fieldnames = fieldnames or data[0].keys()
7089
logger.console("fieldnames: %s" % fieldnames)
7190
self._open_csv_file_for_write(
7291
filename,
7392
data=data,
7493
csv_writer=csv.DictWriter,
75-
delimiter=delimiter,
94+
delimiter=str(delimiter),
7695
fieldnames=fieldnames
7796
)

0 commit comments

Comments
 (0)