Skip to content

Latest commit

 

History

History
305 lines (208 loc) · 4.72 KB

api.rst

File metadata and controls

305 lines (208 loc) · 4.72 KB

API Reference

pyexcel

This is intended for users of pyexcel.

Signature functions

Obtaining data from excel file

get_array get_dict get_records get_book_dict get_book get_sheet iget_book iget_array iget_records free_resources

Saving data to excel file

save_as isave_as save_book_as isave_book_as

These flags can be passed on all signature functions:

auto_detect_int

Automatically convert float values to integers if the float number has no decimal values(e.g. 1.00). By default, it does the detection. Setting it to False will turn on this behavior

It has no effect on pyexcel-xlsx because it does that by default.

auto_detect_float

Automatically convert text to float values if possible. This applies only pyexcel-io where csv, tsv, csvz and tsvz formats are supported. By default, it does the detection. Setting it to False will turn on this behavior

auto_detect_datetime

Automatically convert text to python datetime if possible. This applies only pyexcel-io where csv, tsv, csvz and tsvz formats are supported. By default, it does the detection. Setting it to False will turn on this behavior

library

Name a pyexcel plugin to handle a file format. In the situation where multiple plugins were pip installed, it is confusing for pyexcel on which plugin to handle the file format. For example, both pyexcel-xlsx and pyexcel-xls reads xlsx format. Now since version 0.2.2, you can pass on library="pyexcel-xls" to handle xlsx in a specific function call.

It is better to uninstall the unwanted pyexcel plugin using pip if two plugins for the same file type are not absolutely necessary.

Cookbook

merge_csv_to_a_book merge_all_to_a_book split_a_book extract_a_sheet_from_a_book

Book

Here's the entity relationship between Book, Sheet, Row and Column

image

Constructor

Book

Attribute

Book.number_of_sheets Book.sheet_names

Conversions

Book.bookdict Book.url Book.csv Book.tsv Book.csvz Book.tsvz Book.xls Book.xlsm Book.xlsx Book.ods Book.stream

Save changes

Book.save_as Book.save_to_memory Book.save_to_database Book.save_to_django_models

Sheet

Constructor

Sheet

Attributes

Sheet.content Sheet.number_of_rows Sheet.number_of_columns Sheet.row_range Sheet.column_range

Cell access

Sheet.cell_value Sheet.__getitem__

Row access

Sheet.row_at Sheet.set_row_at Sheet.delete_rows Sheet.extend_rows

Column access

Sheet.column_at Sheet.set_column_at Sheet.delete_columns Sheet.extend_columns

Data series

Any column as row name

Sheet.name_columns_by_row Sheet.rownames Sheet.named_column_at Sheet.set_named_column_at Sheet.delete_named_column_at

Any row as column name

Sheet.name_rows_by_column Sheet.colnames Sheet.named_row_at Sheet.set_named_row_at Sheet.delete_named_row_at

Conversion

Sheet.array Sheet.records Sheet.dict Sheet.url Sheet.csv Sheet.tsv Sheet.csvz Sheet.tsvz Sheet.xls Sheet.xlsm Sheet.xlsx Sheet.ods Sheet.stream

Formatting

Sheet.format

Filtering

Sheet.filter

Transformation

Sheet.project Sheet.transpose Sheet.map Sheet.region Sheet.cut Sheet.paste

Save changes

Sheet.save_as Sheet.save_to_memory Sheet.save_to_database Sheet.save_to_django_model