def load_book(file_name, **keywords):
"""Load content from physical file
:param str file_name: the file name
:param any keywords: additional parameters
"""
return get_book(file_name=file_name, **keywords)
def load_book(file_name, **keywords):
"""Load content from physical file
:param str file_name: the file name
:param any keywords: additional parameters
"""
return get_book(file_name=file_name, **keywords)
def load_book_from_memory(file_type, file_content, **keywords):
"""Load content from memory content
:param tuple the_tuple: first element should be file extension,
second element should be file content
:param any keywords: additional parameters
"""
return get_book(file_type=file_type, file_content=file_content, **keywords)
def load_book_from_memory(file_type, file_content, **keywords):
"""Load content from memory content
:param tuple the_tuple: first element should be file extension,
second element should be file content
:param any keywords: additional parameters
"""
return get_book(file_type=file_type, file_content=file_content, **keywords)
def merge_all_to_a_book(filelist, outfilename=DEFAULT_OUT_XLS_FILE):
"""merge a list of excel files into a excel book
:param list filelist: a list of accessible file path
:param str outfilename: save the sheet as
"""
merged = Book()
for file_name in filelist:
merged += get_book(file_name=file_name)
merged.save_as(outfilename)
def merge_all_to_a_book(filelist, outfilename=DEFAULT_OUT_XLS_FILE):
"""merge a list of excel files into a excel book
:param list filelist: a list of accessible file path
:param str outfilename: save the sheet as
"""
merged = Book()
for file_name in filelist:
merged += get_book(file_name=file_name)
merged.save_as(outfilename)
def split_a_book(file_name, outfilename=None):
"""Split a file into separate sheets
:param str file_name: an accessible file name
:param str outfilename: save the sheets with file suffix
"""
book = get_book(file_name=file_name)
if outfilename:
saveas = outfilename
else:
saveas = file_name
for sheet in book:
filename = "%s_%s" % (sheet.name, saveas)
sheet.save_as(filename)
def split_a_book(file_name, outfilename=None):
"""Split a file into separate sheets
:param str file_name: an accessible file name
:param str outfilename: save the sheets with file suffix
"""
book = get_book(file_name=file_name)
if outfilename:
saveas = outfilename
else:
saveas = file_name
for sheet in book:
filename = "%s_%s" % (sheet.name, saveas)
sheet.save_as(filename)
def extract_a_sheet_from_a_book(file_name, sheetname, outfilename=None):
"""Extract a sheet from a excel book
:param str file_name: an accessible file name
:param str sheetname: a valid sheet name
:param str outfilename: save the sheet as
"""
book = get_book(file_name=file_name)
if outfilename:
saveas = outfilename
else:
saveas = file_name
sheet = book[sheetname]
file_name = "%s_%s" % (sheetname, saveas)
sheet.save_as(file_name)
def extract_a_sheet_from_a_book(file_name, sheetname, outfilename=None):
"""Extract a sheet from a excel book
:param str file_name: an accessible file name
:param str sheetname: a valid sheet name
:param str outfilename: save the sheet as
"""
book = get_book(file_name=file_name)
if outfilename:
saveas = outfilename
else:
saveas = file_name
sheet = book[sheetname]
file_name = "%s_%s" % (sheetname, saveas)
sheet.save_as(file_name)
