django-gisserver 1.2.7__py3-none-any.whl → 1.4.0__py3-none-any.whl

gisserver/output/__init__.py

@@ -1,4 +1,7 @@
 """All supported output formats"""
+
+from django.utils.functional import classproperty
+
 from gisserver import conf
 
 from .base import OutputRenderer
@@ -13,8 +16,6 @@ from .gml32 import (
 from .results import FeatureCollection, SimpleFeatureCollection
 from .xmlschema import XMLSchemaRenderer
 
-from django.utils.functional import classproperty
-
 __all__ = [
     "OutputRenderer",
     "FeatureCollection",
@@ -40,6 +41,10 @@ def select_renderer(native_renderer_class, db_renderer_class):
     """
 
     class SelectRenderer:
+        """A proxy to the actual rendering class.
+        Its structure still allows accessing class-properties of the actual class.
+        """
+
         @classproperty
         def real_class(self):
             if conf.GISSERVER_USE_DB_RENDERING:

gisserver/output/base.py

@@ -59,9 +59,7 @@ class OutputRenderer:
         self.app_xml_namespace = method.view.xml_namespace
 
     @classmethod
-    def decorate_collection(
-        cls, collection: FeatureCollection, output_crs: CRS, **params
-    ):
+    def decorate_collection(cls, collection: FeatureCollection, output_crs: CRS, **params):
         """Perform presentation-layer logic enhancements on the queryset."""
         for sub_collection in collection.results:
             # Validate the presentation-level parameters for this feature:
@@ -125,9 +123,7 @@ class OutputRenderer:
         return [
             models.Prefetch(
                 orm_relation.orm_path,
-                queryset=cls.get_prefetch_queryset(
-                    feature_type, orm_relation, output_crs
-                ),
+                queryset=cls.get_prefetch_queryset(feature_type, orm_relation, output_crs),
             )
             for orm_relation in feature_type.orm_relations
         ]
@@ -173,10 +169,7 @@ class OutputRenderer:
             # Offer a common quick content-disposition logic that works for all possible queries.
             sub_collection = self.collection.results[0]
             if sub_collection.stop == math.inf:
-                if sub_collection.start:
-                    page = f"{sub_collection.start}-end"
-                else:
-                    page = "all"
+                page = f"{sub_collection.start}-end" if sub_collection.start else "all"
             elif sub_collection.stop:
                 page = f"{sub_collection.start}-{sub_collection.stop - 1}"
             else:
@@ -184,9 +177,7 @@ class OutputRenderer:
 
             return {
                 "Content-Disposition": self.content_disposition.format(
-                    typenames="+".join(
-                        sub.feature_type.name for sub in self.collection.results
-                    ),
+                    typenames="+".join(sub.feature_type.name for sub in self.collection.results),
                     page=page,
                     date=self.collection.date.strftime("%Y-%m-%d %H.%M.%S%z"),
                     timestamp=self.collection.timestamp,

gisserver/output/csv.py

@@ -1,12 +1,13 @@
 """Output rendering logic for GeoJSON."""
+
 from __future__ import annotations
 
 import csv
-from datetime import datetime
+from datetime import datetime, timezone
+from io import StringIO
 
 from django.conf import settings
 from django.db import models
-from django.utils.timezone import utc
 
 from gisserver import conf
 from gisserver.db import (
@@ -20,7 +21,6 @@ from gisserver.geometries import CRS
 from gisserver.types import XsdComplexType, XsdElement
 
 from .base import OutputRenderer
-from .buffer import StringBuffer
 
 
 class CSVRenderer(OutputRenderer):
@@ -32,6 +32,7 @@ class CSVRenderer(OutputRenderer):
     content_type = "text/csv; charset=utf-8"
     content_disposition = 'attachment; filename="{typenames} {page} {date}.csv"'
     max_page_size = conf.GISSERVER_CSV_MAX_PAGE_SIZE
+    chunk_size = 40_000
 
     #: The outputted CSV dialect. This can be a csv.Dialect subclass
     #: or one of the registered names like: "unix", "excel", "excel-tab"
@@ -67,7 +68,7 @@ class CSVRenderer(OutputRenderer):
         return queryset
 
     def render_stream(self):
-        output = StringBuffer()
+        output = StringIO()
         writer = csv.writer(output, dialect=self.dialect)
 
         is_first_collection = True
@@ -79,11 +80,7 @@ class CSVRenderer(OutputRenderer):
                 output.write("\n\n")
 
             # Write the header
-            fields = [
-                f
-                for f in sub_collection.feature_type.xsd_type.elements
-                if not f.is_many
-            ]
+            fields = [f for f in sub_collection.feature_type.xsd_type.elements if not f.is_many]
             writer.writerow(self.get_header(fields))
 
             # By using .iterator(), the results are streamed with as little memory as
@@ -94,10 +91,13 @@ class CSVRenderer(OutputRenderer):
 
                 # Only perform a 'yield' every once in a while,
                 # as it goes back-and-forth for writing it to the client.
-                if output.is_full():
-                    yield output.flush()
+                if output.tell() > self.chunk_size:
+                    csv_chunk = output.getvalue()
+                    output.seek(0)
+                    output.truncate(0)
+                    yield csv_chunk
 
-        yield output.flush()
+        yield output.getvalue()
 
     def render_exception(self, exception: Exception):
         """Render the exception in a format that fits with the output."""
@@ -137,7 +137,7 @@ class CSVRenderer(OutputRenderer):
                 # Array field
                 append(",".join(map(str, value)))
             elif isinstance(value, datetime):
-                append(str(value.astimezone(utc)))
+                append(str(value.astimezone(timezone.utc)))
             else:
                 append(value)
         return values
@@ -160,15 +160,11 @@ class DBCSVRenderer(CSVRenderer):
         output_crs: CRS,
         **params,
     ) -> models.QuerySet:
-        queryset = super().decorate_queryset(
-            feature_type, queryset, output_crs, **params
-        )
+        queryset = super().decorate_queryset(feature_type, queryset, output_crs, **params)
 
         # Instead of reading the binary geometry data,
         # ask the database to generate EWKT data directly.
-        geo_selects = get_db_geometry_selects(
-            feature_type.xsd_type.geometry_elements, output_crs
-        )
+        geo_selects = get_db_geometry_selects(feature_type.xsd_type.geometry_elements, output_crs)
         if geo_selects:
             queryset = queryset.defer(*geo_selects.keys()).annotate(
                 **build_db_annotations(geo_selects, "_as_ewkt_{name}", AsEWKT)

gisserver/output/geojson.py

@@ -1,6 +1,8 @@
 """Output rendering logic for GeoJSON."""
-from datetime import datetime
+
+from datetime import datetime, timezone
 from decimal import Decimal
+from io import BytesIO
 from typing import cast
 
 import orjson
@@ -8,7 +10,6 @@ from django.conf import settings
 from django.contrib.gis.db.models.functions import AsGeoJSON
 from django.db import models
 from django.utils.functional import Promise
-from django.utils.timezone import utc
 
 from gisserver import conf
 from gisserver.db import get_db_geometry_target
@@ -17,7 +18,6 @@ from gisserver.geometries import CRS
 from gisserver.types import XsdComplexType
 
 from .base import OutputRenderer
-from .buffer import BytesBuffer
 
 
 def _json_default(obj):
@@ -41,6 +41,7 @@ class GeoJsonRenderer(OutputRenderer):
     content_type = "application/geo+json; charset=utf-8"
     content_disposition = 'inline; filename="{typenames} {page} {date}.geojson"'
     max_page_size = conf.GISSERVER_GEOJSON_MAX_PAGE_SIZE
+    chunk_size = 40_000
 
     @classmethod
     def decorate_queryset(
@@ -50,9 +51,7 @@ class GeoJsonRenderer(OutputRenderer):
         output_crs: CRS,
         **params,
     ):
-        queryset = super().decorate_queryset(
-            feature_type, queryset, output_crs, **params
-        )
+        queryset = super().decorate_queryset(feature_type, queryset, output_crs, **params)
 
         # Other geometries can be excluded as these are not rendered by 'properties'
         other_geometries = [
@@ -66,7 +65,7 @@ class GeoJsonRenderer(OutputRenderer):
         return queryset
 
     def render_stream(self):
-        output = BytesBuffer()
+        output = BytesIO()
 
         # Generate the header from a Python dict,
         # but replace the last "}" into a comma, to allow writing more
@@ -97,8 +96,11 @@ class GeoJsonRenderer(OutputRenderer):
 
                 # Only perform a 'yield' every once in a while,
                 # as it goes back-and-forth for writing it to the client.
-                if output.is_full():
-                    yield output.flush()
+                if output.tell() > self.chunk_size:
+                    json_chunk = output.getvalue()
+                    output.seek(0)
+                    output.truncate(0)
+                    yield json_chunk
 
         # Instead of performing an expensive .count() on the start of the page,
         # write this as a last field at the end of the response.
@@ -107,7 +109,7 @@ class GeoJsonRenderer(OutputRenderer):
         footer = self.get_footer()
         output.write(orjson.dumps(footer)[1:])
         output.write(b"\n")
-        yield output.flush()
+        yield output.getvalue()
 
     def render_exception(self, exception: Exception):
         """Render the exception in a format that fits with the output."""
@@ -116,9 +118,7 @@ class GeoJsonRenderer(OutputRenderer):
         else:
             return f"/* {exception.__class__.__name__} during rendering! */\n"
 
-    def render_feature(
-        self, feature_type: FeatureType, instance: models.Model
-    ) -> bytes:
+    def render_feature(self, feature_type: FeatureType, instance: models.Model) -> bytes:
         """Render the output of a single feature"""
 
         # Get all instance attributes:
@@ -147,7 +147,7 @@ class GeoJsonRenderer(OutputRenderer):
 
     def _format_geojson_value(self, value):
         if isinstance(value, datetime):
-            return value.astimezone(utc)
+            return value.astimezone(timezone.utc)
         elif isinstance(value, models.Model):
             # ForeignKey, not defined as complex type.
             return str(value)
@@ -267,16 +267,12 @@ class DBGeoJsonRenderer(GeoJsonRenderer):
     """
 
     @classmethod
-    def decorate_queryset(
-        self, feature_type: FeatureType, queryset, output_crs, **params
-    ):
+    def decorate_queryset(self, feature_type: FeatureType, queryset, output_crs, **params):
         """Update the queryset to let the database render the GML output.
         This is far more efficient then GeoDjango's logic, which performs a
         C-API call for every single coordinate of a geometry.
         """
-        queryset = super().decorate_queryset(
-            feature_type, queryset, output_crs, **params
-        )
+        queryset = super().decorate_queryset(feature_type, queryset, output_crs, **params)
         # If desired, the entire FeatureCollection could be rendered
         # in PostgreSQL as well: https://postgis.net/docs/ST_AsGeoJSON.html
         if feature_type.geometry_fields: