Signature functions¶
Import data into Python¶
This library provides one application programming interface to read data from one of the following data sources:
- physical file
- memory file
- SQLAlchemy table
- Django Model
- Python data structures: dictionary, records and array
and to transform them into one of the following data structures:
Four data access functions¶
Python data can be handled well using lists, dictionaries and various mixture of both. This library provides four module level functions to help you obtain excel data in these data structures. Please refer to “A list of module level functions”, the first three functions operates on any one sheet from an excel book and the fourth one returns all data in all sheets in an excel book.
Functions | Name | Python name |
---|---|---|
get_array() |
two dimensional array | a list of lists |
get_dict() |
a dictionary of one dimensional arrays | an ordered dictionary of lists |
get_records() |
a list of dictionaries | a list of dictionaries |
get_book_dict() |
a dictionary of two dimensional arrays | a dictionary of lists of lists |
See also:
- get_an_array_from_an_excel_sheet
- How to get a dictionary from an excel sheet
- How to obtain records from an excel sheet
- How to obtain a dictionary from a multiple sheet book
The following two variants of the data access function use generator and should work well with big data files
Functions | Name | Python name |
---|---|---|
iget_array() |
|
a generator of a list of lists |
iget_records() |
a memory efficient list list of dictionaries | a generator of a list of dictionaries |
However, you will need to call free_resource()
to make sure file
handles are closed.
Two pyexcel functions¶
In cases where the excel data needs custom manipulations, a pyexcel user got a
few choices: one is to use Sheet
and Book
,
the other is to look for more sophisticated ones:
- Pandas, for numerical analysis
- Do-it-yourself
Functions | Returns |
---|---|
get_sheet() |
Sheet |
get_book() |
Book |
For all six functions, you can pass on the same command parameters while the return value is what the function says.
Export data from Python¶
This library provides one application programming interface to transform them into one of the data structures:
and write to one of the following data sources:
- physical file
- memory file
- SQLAlchemy table
- Django Model
- Python data structures: dictionary, records and array
Here are the two functions:
Functions | Description |
---|---|
save_as() |
Works well with single sheet file |
isave_as() |
Works well with big data files |
save_book_as() |
|
isave_book_as() |
|
If you would only use these two functions to do format transcoding, you may enjoy a
speed boost using isave_as()
and isave_book_as()
,
because they use yield keyword and minimize memory footprint. However, you will
need to call free_resource()
to make sure file handles are closed.
And save_as()
and save_book_as()
reads all data into
memory and will make all rows the same width.
See also:
Data transportation/transcoding¶
This library is capable of transporting your data between any of the following data sources:
- physical file
- memory file
- SQLAlchemy table
- Django Model
- Python data structures: dictionary, records and array
See also: