File: index.rst

package info (click to toggle)
liborcus 0.20.1-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 16,644 kB
  • sloc: xml: 78,349; cpp: 74,365; sh: 4,626; makefile: 2,787; python: 2,614
file content (19 lines) | stat: -rw-r--r-- 476 bytes parent folder | download | duplicates (3) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 

orcus.csv
=========

.. py:function:: orcus.csv.read

   Read an CSV file from a specified file path and create a :py:class:`orcus.Document`
   instance object.

   :param stream: either string value, or file object containing a string stream.
   :rtype: :py:class:`orcus.Document`
   :return: document instance object that stores the content of the file.

   Example::

      from orcus import csv

      with open("path/to/file.csv", "r") as f:
          doc = csv.read(f)