[1.8.x] Documented gdal DataSource encoding parameter

Thanks Max Demars for the suggestion and Tim Graham for the review.
Backport of a8991b9b9f from master.
This commit is contained in:
Claude Paroz 2015-03-12 18:12:11 +01:00
parent 6f555e54f7
commit f115694547
1 changed files with 8 additions and 3 deletions

View File

@ -55,10 +55,10 @@ points, polygons, etc.), as well as the names and types of any
additional fields (:class:`Field`) of data that may be associated with
each feature in that layer.
.. class:: DataSource(ds_input)
.. class:: DataSource(ds_input, [encoding='utf-8'])
The constructor for ``DataSource`` just a single parameter: the path of
the file you want to read. However, OGR
The constructor for ``DataSource`` only requires one parameter: the path of
the file you want to read. However, OGR
also supports a variety of more complex data sources, including
databases, that may be accessed by passing a special name string instead
of a path. For more information, see the `OGR Vector Formats`__
@ -66,6 +66,11 @@ each feature in that layer.
instance gives the OGR name of the underlying data source that it is
using.
The optional ``encoding`` parameter allows you to
specify a non-standard encoding of the strings in the source. This is
typically useful when you obtain ``DjangoUnicodeDecodeError`` exceptions
while reading field values.
Once you've created your ``DataSource``, you can find out how many
layers of data it contains by accessing the :attr:`layer_count` property,
or (equivalently) by using the ``len()`` function. For information on