def save_book_as(**keywords):
"""Save a book from a data source to another one
:param dest_file_name: another file name. **out_file** is
deprecated though is still accepted.
:param dest_file_type: this is needed if you want to save to memory
:param dest_session: the target database session
:param dest_tables: the list of target destination tables
:param dest_models: the list of target destination django models
:param dest_mapdicts: a list of mapping dictionaries
:param dest_initializers: table initialization functions
:param dest_mapdicts: to nominate a model or table fields. Optional
:param dest_batch_size: batch creation size. Optional
:param keywords: additional keywords can be found at
:meth:`pyexcel.get_book`
:returns: IO stream if saving to memory. None otherwise
================ ============================================
Saving to source parameters
================ ============================================
file dest_file_name, dest_sheet_name,
keywords with prefix 'dest'
memory dest_file_type, dest_content,
dest_sheet_name, keywords with prefix 'dest'
sql dest_session, dest_tables,
dest_table_init_func, dest_mapdict
django model dest_models, dest_initializers,
dest_mapdict, dest_batch_size
================ ============================================
"""
dest_keywords, source_keywords = _split_keywords(**keywords)
book = sources.get_book_stream(**source_keywords)
return sources.save_book(book, **dest_keywords)
def get_book(**keywords):
"""Get an instance of :class:`Book` from an excel source
:param file_name: a file with supported file extension
:param file_content: the file content
:param file_stream: the file stream
:param file_type: the file type in *content*
:param session: database session
:param tables: a list of database table
:param models: a list of django models
:param bookdict: a dictionary of two dimensional arrays
:param url: a download http url for your excel file
see also :ref:`a-list-of-data-structures`
Here is a table of parameters:
========================== ===============================
source parameters
========================== ===============================
loading from file file_name, keywords
loading from memory file_type, content, keywords
loading from sql session, tables
loading from django models models
loading from dictionary bookdict
========================== ===============================
Where the dictionary should have text as keys and two dimensional
array as values.
"""
book_stream = sources.get_book_stream(**keywords)
book = Book(book_stream.to_dict(),
filename=book_stream.filename,
path=book_stream.path)
return book
def isave_book_as(**keywords):
"""Save a book from a data source to another one
It is simliar to :meth:`pyexcel.save_book_as` but it read
when it writes. This function provide some speedup but
the output data is made uniform.
"""
dest_keywords, source_keywords = _split_keywords(**keywords)
book = sources.get_book_stream(**source_keywords)
return sources.save_book(book, **dest_keywords)
def save_book_as(**keywords):
"""Save a book from a data source to another one
:param file_name: a file with supported file extension
:param file_content: the file content
:param file_stream: the file stream
:param file_type: the file type in *content*
:param session: database session
:param tables: a list of database table
:param models: a list of django models
:param bookdict: a dictionary of two dimensional arrays
:param url: a download http url for your excel file
:param dest_file_name: another file name. **out_file** is
deprecated though is still accepted.
:param dest_file_type: this is needed if you want to save to memory
:param dest_session: the target database session
:param dest_tables: the list of target destination tables
:param dest_models: the list of target destination django models
:param dest_mapdicts: a list of mapping dictionaries
:param dest_initializers: table initialization functions
:param dest_mapdicts: to nominate a model or table fields. Optional
:param dest_batch_size: batch creation size. Optional
:param keywords: additional keywords can be found at
:meth:`pyexcel.get_book`
:returns: IO stream if saving to memory. None otherwise
see also :ref:`a-list-of-data-structures`
Here is a table of parameters:
========================== ===============================
source parameters
========================== ===============================
loading from file file_name, keywords
loading from memory file_type, content, keywords
loading from sql session, tables
loading from django models models
loading from dictionary bookdict
loading from an url url
========================== ===============================
Where the dictionary should have text as keys and two dimensional
array as values.
================ ============================================
Saving to source parameters
================ ============================================
file dest_file_name, dest_sheet_name,
keywords with prefix 'dest'
memory dest_file_type, dest_content,
dest_sheet_name, keywords with prefix 'dest'
sql dest_session, dest_tables,
dest_table_init_func, dest_mapdict
django model dest_models, dest_initializers,
dest_mapdict, dest_batch_size
================ ============================================
"""
dest_keywords, source_keywords = _split_keywords(**keywords)
book = sources.get_book_stream(**source_keywords)
return sources.save_book(book, **dest_keywords)