Changeset 6992

Timestamp:

01/03/08 13:02:18 (6 months ago)

Author:

jbronn

Message:

gis: LayerMapping: Improved the internals (i.e., checking every feature in OGR Layer is no longer needed, removed unnecessary class constants); added real support ForeignKey model fields; added field_types property to Layer; fixed county shapefile because of Harris County, Georgia.

Files:

• django/branches/gis/django/contrib/gis/gdal/layer.py (modified) (3 diffs)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.dbf (modified) (previous)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.shp (modified) (previous)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.shx (modified) (previous)
• django/branches/gis/django/contrib/gis/tests/layermap/models.py (modified) (2 diffs)
• django/branches/gis/django/contrib/gis/tests/layermap/tests.py (modified) (4 diffs)
• django/branches/gis/django/contrib/gis/utils/layermapping.py (modified) (20 diffs)

django/branches/gis/django/contrib/gis/gdal/layer.py

@@ -6 +6 @@
-from django.contrib.gis.gdal.error import OGRException, OGRIndexError, SRSException
-from django.contrib.gis.gdal.feature import Feature
+from django.contrib.gis.gdal.field import FIELD_CLASSES
-from django.contrib.gis.gdal.geometries import OGRGeomType
-from django.contrib.gis.gdal.srs import SpatialReference
@@ -13 +14 @@
-    get_extent, get_fd_geom_type, get_fd_name, get_feature, get_feature_count, \
-    get_field_count, get_field_defn, get_field_name, get_field_precision, \
-layer_defn, get_layer_srs, get_next_feature
-
+field_type, get_layer_defn, get_layer_srs
+get_next_feature, 
-from django.contrib.gis.gdal.prototypes.srs import clone_srs
-
@@ -108 +109 @@
-    @property
-    def fields(self):
-
+
+
+
+
-        return [get_field_name(get_field_defn(self._ldefn, i)) 
-                for i in xrange(self.num_fields) ]
-    
+    @property
+    def field_types(self):
+        """
+        Returns a list of the types of fields in this Layer.  For example,
+        the list [OFTInteger, OFTReal, OFTString] would be returned for
+        an OGR layer that had an integer, a floating-point, and string
+        fields.
+        """
+        return [FIELD_CLASSES[get_field_type(get_field_defn(self._ldefn, i))]
+                for i in xrange(self.num_fields)]
+
-    @property 
-    def field_widths(self):

django/branches/gis/django/contrib/gis/tests/layermap/models.py

@@ -1 +1 @@
-from django.contrib.gis.db import models
+
+class State(models.Model):
+    name = models.CharField(max_length=20)
+    objects = models.GeoManager()
-
-class County(models.Model):
-    name = models.CharField(max_length=25)
+    state = models.ForeignKey(State)
-    mpoly = models.MultiPolygonField(srid=4269) # Multipolygon in NAD83
-    objects = models.GeoManager()
@@ -27 +32 @@
-# Mapping dictionaries for the models above.
-co_mapping = {'name' : 'Name',
+              'state' : {'name' : 'State'}, # ForeignKey's use another mapping dictionary for the _related_ Model (State in this case).
-              'mpoly' : 'MULTIPOLYGON', # Will convert POLYGON features into MULTIPOLYGONS.
-              }

django/branches/gis/django/contrib/gis/tests/layermap/tests.py

@@ -3 +3 @@
-from datetime import date
-from decimal import Decimal
-
-
+State, 
+, MissingForeignKey
-from django.contrib.gis.gdal import DataSource
-
@@ -112 +112 @@
-                self.assertAlmostEqual(p1[1], p2[1], 6)
-
-
- keywords and geometry collection conversion
+_fk
+, geometry collection conversion, and ForeignKey mappings
-        # All the following should work.
-        try:
@@ -136 +136 @@
-        self.assertRaises(LayerMapError, LayerMapping, County, co_shp, co_mapping)
-
+        # Passing in invalid ForeignKey mapping parameters -- must be a dictionary
+        # mapping for the model the ForeignKey points to.
+        bad_fk_map1 = copy(co_mapping); bad_fk_map1['state'] = 'name'
+        bad_fk_map2 = copy(co_mapping); bad_fk_map2['state'] = {'nombre' : 'State'}
+        self.assertRaises(TypeError, LayerMapping, County, co_shp, bad_fk_map1, transform=False)
+        self.assertRaises(LayerMapError, LayerMapping, County, co_shp, bad_fk_map2, transform=False)
+
+        # There exist no State models for the ForeignKey mapping to work -- should raise
+        # a MissingForeignKey exception (this error would be ignored if the `strict`
+        # keyword is not set).
+        lm = LayerMapping(County, co_shp, co_mapping, transform=False, unique='name', silent=True, strict=True)
+        self.assertRaises(MissingForeignKey, lm.save)
+
+        # Now creating the state models so the ForeignKey mapping may work.
+        co, hi, tx = State(name='Colorado'), State(name='Hawaii'), State(name='Texas')
+        co.save(), hi.save(), tx.save()
+
-        # If a mapping is specified as a collection, all OGR fields that
-        # are not collections will be converted into them.  For example,
@@ -149 +166 @@
-        #    all of the various islands in Honolulu county will be in in one
-        #    database record with a MULTIPOLYGON type.
-
+, strict=True
-        lm.save()
-
-        # A reference that doesn't use the unique keyword; a new database record will
-        # created for each polygon.
-
+, strict=True
-        lm.save()
-
-        # Dictionary to hold what's expected in the shapefile.
-
-
-
-
-
+
+
+
+
+
+
+
-            self.assertEqual(n, len(c.mpoly))
+            self.assertEqual(st, c.state.name) # Checking ForeignKey mapping.
+
+            # Multiple records because `unique` was not set.
-            qs = CountyFeat.objects.filter(name=name)
-            self.assertEqual(n, qs.count())

django/branches/gis/django/contrib/gis/utils/layermapping.py

@@ -46 +46 @@
-
-  check:
-
-
-
-
+
+
+
+
+
+
+
-
-  silent:
@@ -57 +60 @@
-  strict:
-   Setting this keyword to True will instruct the save() method to
-
+
+
-
-  transaction_mode:
@@ -122 +126 @@
- specify one.
-"""
+import sys
-from datetime import date, datetime
-from decimal import Decimal
-from django.core.exceptions import ObjectDoesNotExist
-
-
+
-from django.contrib.gis.db.backend import SPATIAL_BACKEND
-from django.contrib.gis.gdal import CoordTransform, DataSource, \
-    OGRException, OGRGeometry, OGRGeomType, SpatialReference
-
+
+
-from django.contrib.gis.models import GeometryColumns, SpatialRefSys
+from django.db import models, transaction
-
-# LayerMapping exceptions.
@@ -137 +143 @@
-class InvalidString(LayerMapError): pass
-class InvalidDecimal(LayerMapError): pass
+class MissingForeignKey(LayerMapError): pass
-
-class LayerMapping(object):
-    "A class that maps OGR Layers to GeoDjango Models."
-    
-    # A mapping of given geometry types to their OGR integer type.
-    OGC_TYPES = {'POINT' : OGRGeomType('Point'),
-                 'LINESTRING' : OGRGeomType('LineString'),
-                 'POLYGON' : OGRGeomType('Polygon'),
-                 'MULTIPOINT' : OGRGeomType('MultiPoint'),
-                 'MULTILINESTRING' : OGRGeomType('MultiLineString'),
-                 'MULTIPOLYGON' : OGRGeomType('MultiPolygon'),
-                 'GEOMETRYCOLLECTION' : OGRGeomType('GeometryCollection'),
-                 }
-
-    # The django.contrib.gis model types.
-    GIS_FIELDS = {'PointField' : 'POINT',
-                  'LineStringField': 'LINESTRING',
-                  'PolygonField': 'POLYGON',
-                  'MultiPointField' : 'MULTIPOINT',
-                  'MultiLineStringField' : 'MULTILINESTRING',
-                  'MultiPolygonField' : 'MULTIPOLYGON',
-                  'GeometryCollectionField' : 'GEOMETRYCOLLECTION',
-                  }
-
-    # Acceptable 'base' types for a multi-geometry type.
-'POINT'
-'LINESTRING'
-'POLYGON'
+1
+2
+3
-                   }
-
-
+
+
-    FIELD_TYPES = {
-'AutoField'
-'IntegerField' : OFTInteger
-'FloatField' : OFTReal
-'DateField'
-'DateTimeField'
-'TimeField'
-'DecimalField' : OFTReal
-'CharField'
-'TextField'
-'SmallIntegerField' : OFTInteger
-'PositiveSmallIntegerField' : OFTInteger
+models.AutoField
+models.IntegerField : (OFTInteger, OFTReal)
+models.FloatField : (OFTInteger, OFTReal)
+models.DateField
+models.DateTimeField
+models.TimeField
+models.DecimalField : (OFTInteger, OFTReal)
+models.CharField
+models.TextField
+models.SmallIntegerField : (OFTInteger, OFTReal)
+models.PositiveSmallIntegerField : (OFTInteger, OFTReal)
-        }
-
@@ -188 +176 @@
-
-    def __init__(self, model, data, mapping, layer=0, 
-
+pipe=sys.stdout,
-                 progress=False, interval=1000, strict=False, silent=False,
-                 transaction_mode='commit_on_success', transform=True,
-                 unique=False):
-Takes the Django model, the data source, and the mapping (dictionary)
-
-# Getting the field names and types from the model
-self.fields = dict((f.name, self.map_foreign_key(f)) for f in model._meta.fields)
-self.field_classes = dict((f.name, f) for f in model._meta.fields)
-
-its Layer
+"
+
+a DataSource (or string path to an OGR-supported data file), and a mapping
+dictionary.  See the module level docstring for more details and keyword
+argument usage.
+
+the associated Layer.
-        if isinstance(data, basestring):
-            self.ds = DataSource(data)
@@ -224 +212 @@
-
-        # Checking the layer -- intitialization of the object will fail if
-
-
-
-
-
+
+
+
+
+
+
+
-        self.silent = silent
-        self.strict = strict
-        self.progress = progress
+        self.pipe = pipe
-        self.interval = interval
-
@@ -258 +248 @@
-        else:
-            raise LayerMapError('Unrecognized transaction mode: %s' % transaction_mode)
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            else:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def check_srs(self, source_srs):
@@ -322 +341 @@
-        elif isinstance(source_srs, SpatialRefSys):
-            sr = source_srs.srs
-str
+basestring
-            sr = SpatialReference(source_srs)
-        else:
-            # Otherwise just pulling the SpatialReference from the layer
-            sr = self.layer.srs
-    
+
-        if not sr:
-            raise LayerMapError('No source reference system defined.')
@@ -335 +354 @@
-    def check_unique(self, unique):
-        "Checks the `unique` keyword parameter -- may be a sequence or string."
-        # Getting the geometry field; only the first encountered GeometryField
-        # will be used.
-        self.geom_field = False
-        for model_field, ogr_fld in self.mapping.items():
-            if ogr_fld in self.OGC_TYPES:
-                self.geom_field = model_field
-                break
-
-        if isinstance(unique, (list, tuple)):
-            # List of fields to determine uniqueness with
@@ -353 +364 @@
-            raise TypeError('Unique keyword argument must be set with a tuple, list, or string.')
-
-
-
-
-
-
-
-
-
-
-
-
+
-    def feature_kwargs(self, feat):
-
-
+
+
+
+
+
+
-        # The keyword arguments for model construction.
-        kwargs = {}
@@ -376 +381 @@
-        # Incrementing through each model field and OGR field in the
-        # dictionary mapping.
-
-
-
-
-
-
-
-
+
+
-            
-ogr_field in self.OGC_TYPES
+isinstance(model_field, GeometryField)
-                # Verify OGR geometry.
-
+
+
+
+
+
+
-            else:
-                # Otherwise, verify OGR Field type.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-            
-        return kwargs, all_prepped
@@ -421 +413 @@
-            return dict((fld, kwargs[fld]) for fld in self.unique)
-
-
+
+
-        """
-        Verifies if the OGR Field contents are acceptable to the Django
@@ -427 +420 @@
-        otherwise the proper exception is raised.
-        """
-
-
+
-            if self.encoding:
-                # The encoding for OGR data sources may be specified here
-                # (e.g., 'cp437' for Census Bureau boundary files).
-f
+ogr_fie
-            else:
-f
-field_class
+ogr_fie
+model_field
-                    raise InvalidString('%s model field maximum string length is %s, given %s characters.' %
-, field_class
-f
+.name, model_field
+ogr_fie
-            try:
-                # Creating an instance of the Decimal value to use.
-f
+ogr_fie
-            except:
-f
+ogr_fie
-
-            # Getting the decimal value as a tuple.
@@ -451 +443 @@
-
-            # Maximum amount of precision, or digits to the left of the decimal.
-field_class.max_digits - field_class
+model_field.max_digits - model_field
-
-            # Getting the digits to the left of the decimal place for the 
@@ -464 +456 @@
-            if n_prec > max_prec:
-                raise InvalidDecimal('A DecimalField with max_digits %d, decimal_places %d must round to an absolute value less than 10^%d.' %
-field_class.max_digits, field_class
+model_field.max_digits, model_field
-            val = d
-        else:
-f
+ogr_fie
-        return val
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            # Constructing a multi-geometry type to contain the single geometry
-name
+type.num
-            g = OGRGeometry(multi_type)
-            g.add(geom)
@@ -487 +505 @@
-        # Returning the WKT of the geometry.
-        return g.wkt
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-    def geometry_column(self):
-        "Returns the GeometryColumn model associated with the geographic column."
@@ -499 +529 @@
-            raise LayerMapError('Geometry column does not exist for model. (did you run syncdb?):\n %s' % msg)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-    def save(self, verbose=False):
-
-
+
+
+
+
+
+
+
+
-        @self.transaction_decorator
-        def _save():
@@ -531 +560 @@
-                    if self.strict: raise
-                    elif not self.silent: 
-print 'Ignoring Feature ID %s because: %s' % (feat.fid, msg
+self.pipe.write('Ignoring Feature ID %s because: %s\n' % (feat.fid, msg)
-                else:
-                    # Constructing the model using the keyword args
@@ -562 +591 @@
-                            m.save()
-                            num_saved += 1
-print 'Saved: %s' % m
+self.pipe.write('Saved: %s\n' % m)
-                        except SystemExit:
-                            raise
@@ -573 +602 @@
-                                # Bailing out if the `strict` keyword is set.
-                                if not self.silent:
-print 'Failed to save the feature (id: %s) into the model with the keyword arguments:' % feat.fid
-print kwargs
+self.pipe.write('Failed to save the feature (id: %s) into the model with the keyword arguments:\n' % feat.fid)
+self.pipe.write('%s\n' % kwargs)
-                                raise
-                            elif not self.silent:
-print 'Failed to save %s:\n %s\nContinuing' % (kwargs, msg
+self.pipe.write('Failed to save %s:\n %s\nContinuing\n' % (kwargs, msg)
-                    else:
-
+
+
-
-                # Printing progress information, if requested.
-                if self.progress and num_feat % self.interval == 0:
-print 'Processed %d features, saved %d ...' % (num_feat, num_saved
+self.pipe.write('Processed %d features, saved %d ...\n' % (num_feat, num_saved)
-               
-        # Calling our defined function, which will use the specified