Module ogrinspect

django.contrib.gis.utils.ogrinspect

This module is for inspecting OGR data sources and generating either models for GeoDjango and/or mapping dictionaries for use with the `LayerMapping` utility.

source link

Functions

▶ def mapping(data_source, geom_name='geom', layer_key=0, multi_geom=False)

Given a DataSource, generate a dictionary that may be used for invoking the LayerMapping utility.

source link

Keyword Arguments:
 `geom_name` => The name of the geometry field to use for the model.

 `layer_key` => The key for specifying which layer in the DataSource to use;
   defaults to 0 (the first layer).  May be an integer index or a string
   identifier for the layer.

 `multi_geom` => Boolean (default: False) - specify as multigeometry.

Reexports

Imported in django.contrib.gis.utils.

▶ def ogrinspect(*args, **kwargs)

Given a data source (either a string or a DataSource object) and a string model name this function will generate a GeoDjango model.

source link

Usage:

>>> from django.contrib.gis.utils import ogrinspect
>>> ogrinspect('/path/to/shapefile.shp','NewModel')

...will print model definition to stout

or put this in a Python script and use to redirect the output to a new
model like:

$ python generate_model.py > myapp/models.py

# generate_model.py
from django.contrib.gis.utils import ogrinspect
shp_file = 'data/mapping_hacks/world_borders.shp'
model_name = 'WorldBorders'

print(ogrinspect(shp_file, model_name, multi_geom=True, srid=4326,
                 geom_name='shapes', blank=True))

Required Arguments
 `datasource` => string or DataSource object to file pointer

 `model name` => string of name of new model class to create

Optional Keyword Arguments
 `geom_name` => For specifying the model name for the Geometry Field.
   Otherwise will default to `geom`

 `layer_key` => The key for specifying which layer in the DataSource to use;
   defaults to 0 (the first layer).  May be an integer index or a string
   identifier for the layer.

 `srid` => The SRID to use for the Geometry Field.  If it can be determined,
   the SRID of the datasource is used.

 `multi_geom` => Boolean (default: False) - specify as multigeometry.

 `name_field` => String - specifies a field name to return for the
   __str__() method (which will be generated if specified).

 `imports` => Boolean (default: True) - set to False to omit the
   `from django.contrib.gis.db import models` code from the
   autogenerated models thus avoiding duplicated imports when building
   more than one model by batching ogrinspect()

 `decimal` => Boolean or sequence (default: False).  When set to True
   all generated model fields corresponding to the `OFTReal` type will
   be `DecimalField` instead of `FloatField`.  A sequence of specific
   field names to generate as `DecimalField` may also be used.

 `blank` => Boolean or sequence (default: False).  When set to True all
   generated model fields will have `blank=True`.  If the user wants to
   give specific fields to have blank, then a list/tuple of OGR field
   names may be used.

 `null` => Boolean (default: False) - When set to True all generated
   model fields will have `null=True`.  If the user wants to specify
   give specific fields to have null, then a list/tuple of OGR field
   names may be used.

Note: Call the _ogrinspect() helper to do the heavy lifting.

Reexports

Imported in django.contrib.gis.utils.