Ticket #15277: 15277.4.patch

deleted file django/contrib/gis/management/base.py

@@ -1 @@
-from django.core.management.base import BaseCommand, CommandError
-
-class ArgsCommand(BaseCommand):
-    """
-    Command class for commands that take multiple arguments.
-    """
-    args = '<arg arg ...>'
-
-    def handle(self, *args, **options):
-        if not args:
-            raise CommandError('Must provide the following arguments: %s' % self.args)
-        return self.handle_args(*args, **options)
-
-    def handle_args(self, *args, **options):
-        raise NotImplementedError()

django/contrib/gis/management/commands/ogrinspect.py

@@ -1 +1 @@
 import os
 from optparse import make_option
 from django.contrib.gis import gdal
-from django.contrib.gis.management.base import ArgsCommand, CommandError
+from django.core.management.base import LabelCommand, CommandError
 
 def layer_option(option, opt, value, parser):
     """
@@ -26 +26 @@
         dest = [s for s in value.split(',')]
     setattr(parser.values, option.dest, dest)
     
-class Command(ArgsCommand):
+class Command(LabelCommand):
     help = ('Inspects the given OGR-compatible data source (e.g., a shapefile) and outputs\n'
             'a GeoDjango model with the given model name. For example:\n'
             ' ./manage.py ogrinspect zipcode.shp Zipcode')
     args = '[data_source] [model_name]'
 
-    option_list = ArgsCommand.option_list + (
+    option_list = LabelCommand.option_list + (
         make_option('--blank', dest='blank', type='string', action='callback',  
                     callback=list_option, default=False,
                     help='Use a comma separated list of OGR field names to add '
@@ -72 +72 @@
 
     requires_model_validation = False
 
-    def handle_args(self, *args, **options):
+    def handle(self, *args, **options):
         try:
             data_source, model_name = args
         except ValueError:
@@ -81 +81 @@
         if not gdal.HAS_GDAL:
             raise CommandError('GDAL is required to inspect geospatial data sources.')
 
-        # TODO: Support non file-based OGR datasources.
-        if not os.path.isfile(data_source):
-            raise CommandError('The given data source cannot be found: "%s"' % data_source)
-        
         # Removing options with `None` values.
         options = dict([(k, v) for k, v in options.items() if not v is None])
 
@@ -97 +93 @@
         # Whether the user wants to generate the LayerMapping dictionary as well.
         show_mapping = options.pop('mapping', False)
 
-        # Popping the verbosity global option, as it's not accepted by `_ogrinspect`.
+        # Getting rid of settings that `_ogrinspect` doesn't like.
         verbosity = options.pop('verbosity', False)
+        settings = options.pop('settings', False)
 
         # Returning the output of ogrinspect with the given arguments
         # and options.
@@ -119 +116 @@
                            '%s_mapping = {' % model_name.lower()])
             output.extend(["    '%s' : '%s'," % (rev_mapping[ogr_fld], ogr_fld) for ogr_fld in ds[options['layer_key']].fields])
             output.extend(["    '%s' : '%s'," % (options['geom_name'], mapping_dict[options['geom_name']]), '}'])
-        return '\n'.join(output)
+        return '\n'.join(output) + '\n'

django/contrib/gis/tests/__init__.py

@@ -17 +17 @@
     from django.contrib.gis.geos import GEOS_PREPARE
     from django.contrib.gis.gdal import HAS_GDAL
 
-    apps = ['geoapp', 'relatedapp']
+    apps = ['geoapp', 'relatedapp', 'inspectapp']
 
     # No distance queries on MySQL.
     if not connection.ops.mysql:

new file django/contrib/gis/tests/inspectapp/models.py

@@ +1 @@
+from django.contrib.gis.db import models
+
+class AllOGRFields(models.Model):
+    f_decimal = models.FloatField()
+    f_float = models.FloatField()
+    f_int = models.IntegerField()
+    f_char = models.CharField(max_length=10)
+    f_date = models.DateField()
+    f_datetime = models.DateTimeField()
+    f_time = models.TimeField()
+    geom = models.PolygonField()
+
+    objects = models.GeoManager()

new file django/contrib/gis/tests/inspectapp/tests.py

@@ +1 @@
+import os
+from django.contrib.gis.geometry.test_data import TEST_DATA
+from django.contrib.gis.tests.utils import no_spatialite
+from django.contrib.gis.utils.ogrinspect import ogrinspect
+from django.db import connections
+from django.utils import unittest
+from django.contrib.gis.tests.utils import (
+    no_mysql, no_oracle, no_spatialite,
+    mysql, oracle, postgis, spatialite)
+from models import AllOGRFields
+
+
+class OGRInspectTest(unittest.TestCase):
+    def test_poly(self):
+        shp_file = os.path.join(TEST_DATA, 'test_poly', 'test_poly.shp')
+        model_def = ogrinspect(shp_file, 'MyModel')
+
+        expected = [
+            '# This is an auto-generated Django model module created by ogrinspect.',
+            'from django.contrib.gis.db import models',
+            '',
+            'class MyModel(models.Model):',
+            '    float = models.FloatField()',
+            '    int = models.FloatField()',
+            '    str = models.CharField(max_length=80)',
+            '    geom = models.PolygonField(srid=-1)',
+            '    objects = models.GeoManager()',
+        ]
+
+        self.assertEqual(model_def, '\n'.join(expected))
+
+    def test_date_field(self):
+        shp_file = os.path.join(TEST_DATA, 'cities', 'cities.shp')
+        model_def = ogrinspect(shp_file, 'City')
+
+        expected = [
+            '# This is an auto-generated Django model module created by ogrinspect.',
+            'from django.contrib.gis.db import models',
+            '',
+            'class City(models.Model):',
+            '    name = models.CharField(max_length=80)',
+            '    population = models.FloatField()',
+            '    density = models.FloatField()',
+            '    created = models.DateField()',
+            '    geom = models.PointField(srid=-1)',
+            '    objects = models.GeoManager()',
+        ]
+
+        self.assertEqual(model_def, '\n'.join(expected))
+
+    @no_spatialite
+    def test_time_field(self):
+        # writing shapefules via GDAL currently does not support writing OGRTime
+        # fields, so we need to actually use a database
+
+        model_def = ogrinspect(get_ogr_db_string(None), 'Measurement',
+                               layer_key=AllOGRFields._meta.db_table,
+                               decimal=['f_decimal'])
+
+        expected = [
+            '# This is an auto-generated Django model module created by ogrinspect.',
+            'from django.contrib.gis.db import models',
+            '',
+            'class Measurement(models.Model):',
+            '    f_decimal = models.DecimalField(max_digits=0, decimal_places=0)',
+            '    f_int = models.IntegerField()',
+            '    f_datetime = models.DateTimeField()',
+            '    f_time = models.TimeField()',
+            '    f_float = models.FloatField()',
+            '    f_char = models.CharField(max_length=10)',
+            '    f_date = models.DateField()',
+            '    geom = models.PolygonField()',
+            '    objects = models.GeoManager()',
+        ]
+
+        self.assertEqual(model_def, '\n'.join(expected))
+
+def get_ogr_db_string(model):
+    # construct the DB string that GDAL will use to inspect the database.
+    # GDAL will create its own connection to the database, so we re-use the
+    # connection settings from the Django test.  This approach is a bit fragile
+    # and can not work on sqlite test databases (since they are in memory)
+
+    db = connections.databases['default']
+
+    # map from the django backend into the GDAL database identifier
+    # http://www.gdal.org/ogr/ogr_formats.html
+    driver = {
+        'django.contrib.gis.db.backends.postgis': 'PG',
+        'django.contrib.gis.db.backends.mysql': 'MYSQL',
+        'django.contrib.gis.db.backends.oracle': 'OCI',
+    }[db['ENGINE']]
+
+    # build the params of the connection string
+    params = ["dbname='{0}'".format(db['NAME'])]
+    def add(key, template):
+        value = db.get(key, None)
+        # don't add the parameter if it is not in django's settings
+        if value is not None:
+            params.append(template.format(value))
+    add('HOST', "host='{0}'")
+    add('PORT', "port='{0}'")
+    add('USER', "user='{0}'")
+    add('PASSWORD', "password='{0}'")
+
+    return '%s:%s' % (driver, ' '.join(params))
+

django/contrib/gis/utils/ogrinspect.py

@@ -8 +8 @@
 from itertools import izip
 # Requires GDAL to use.
 from django.contrib.gis.gdal import DataSource
-from django.contrib.gis.gdal.field import OFTDate, OFTDateTime, OFTInteger, OFTReal, OFTString
+from django.contrib.gis.gdal.field import OFTDate, OFTDateTime, OFTInteger, OFTReal, OFTString, OFTTime
 
 def mapping(data_source, geom_name='geom', layer_key=0, multi_geom=False):
     """
@@ -189 +189 @@
             yield '    %s = models.DateField(%s)' % (mfield, kwargs_str[2:])
         elif field_type is OFTDateTime:
             yield '    %s = models.DateTimeField(%s)' % (mfield, kwargs_str[2:])
-        elif field_type is OFTDate:
+        elif field_type is OFTTime:
             yield '    %s = models.TimeField(%s)' % (mfield, kwargs_str[2:])
         else:
             raise TypeError('Unknown field type %s in %s' % (field_type, mfield))