demonstrator for source/record refactoring

pyramid_oereb/contrib/data_sources/interlis_2_3/sources/plr.py

@@ -105,9 +105,12 @@ def __init__(self, **kwargs):
         """
         config_parser = StandardThemeConfigParser(**kwargs)
         self.models = config_parser.get_models()
+        BaseDatabaseSource.__init__(self, **{**kwargs['source']['params'],
+                                             'model': self.models.PublicLawRestriction})
         bds_kwargs = {
             'model': self.models.Geometry,
-            'db_connection': kwargs.get('source').get('params').get('db_connection')
+            'db_connection': kwargs.get('source').get('params').get('db_connection'),
+            'record_class': self._geometry_record_class,
         }
 
         BaseDatabaseSource.__init__(self, **bds_kwargs)

pyramid_oereb/contrib/data_sources/standard/sources/address.py

@@ -1,48 +1,26 @@
 # -*- coding: utf-8 -*-
-from geoalchemy2.elements import _SpatialElement
-from geoalchemy2.shape import to_shape
-from sqlalchemy.orm.exc import NoResultFound
-
 from pyramid_oereb.core.sources import BaseDatabaseSource
-from pyramid_oereb.core.sources.address import AddressBaseSource
 
 
-class DatabaseSource(BaseDatabaseSource, AddressBaseSource):
+class DatabaseSource(BaseDatabaseSource):
 
-    def read(self, params, street_name, zip_code, street_number):
+    def filter(self, query, params, street_name, zip_code, street_number):
         """
-        The read method to access the standard database structure. It uses SQL-Alchemy for querying. It tries
-        to find the items via passed arguments. If there was no result found it goes on with assigning an
-        empty list as records instance attribute.
+        The filter method only selects some specific results from the standard database structure.
+        It uses SQL-Alchemy for querying via passed arguments.
 
         Args:
             params (pyramid_oereb.views.webservice.Parameter): The parameters of the extract request.
             street_name (unicode): The name of the street for the desired address.
             zip_code (int): The postal zipcode for the desired address.
             street_number (str): The house or so called street number of the desired address.
         """
-        session = self._adapter_.get_session(self._key_)
-        try:
-            query = session.query(self._model_)
-            results = [query.filter(
-                self._model_.street_name == street_name
-            ).filter(
-                self._model_.zip_code == zip_code
-            ).filter(
-                self._model_.street_number == street_number
-            ).one()]
-
-            self.records = []
-            for result in results:
-                self.records.append(self._record_class_(
-                    result.street_name,
-                    result.zip_code,
-                    result.street_number,
-                    to_shape(result.geom) if isinstance(result.geom, _SpatialElement) else None
-                ))
-
-        except NoResultFound:
-            self.records = []
-
-        finally:
-            session.close()
+        filtered_query = query.filter(
+            self._model_.street_name == street_name
+        ).filter(
+            self._model_.zip_code == zip_code
+        ).filter(
+            self._model_.street_number == street_number
+        ).limit(1)
+
+        return filtered_query

pyramid_oereb/contrib/data_sources/standard/sources/plr.py

@@ -102,9 +102,12 @@ def __init__(self, **kwargs):
         """
         config_parser = StandardThemeConfigParser(**kwargs)
         self.models = config_parser.get_models()
+        BaseDatabaseSource.__init__(self, **{**kwargs['source']['params'],
+                                             'model': self.models.PublicLawRestriction})
         bds_kwargs = {
             'model': self.models.Geometry,
-            'db_connection': kwargs.get('source').get('params').get('db_connection')
+            'db_connection': kwargs.get('source').get('params').get('db_connection'),
+            'record_class': self._geometry_record_class,
         }
 
         BaseDatabaseSource.__init__(self, **bds_kwargs)

pyramid_oereb/core/records/address.py

@@ -1,4 +1,7 @@
 # -*- coding: utf-8 -*-
+from geoalchemy2.elements import _SpatialElement
+from geoalchemy2.shape import to_shape
+from shapely import is_geometry
 
 
 class AddressRecord(object):
@@ -24,4 +27,8 @@ def __init__(self, street_name, zip_code, street_number, geom):
         self.street_name = street_name
         self.zip_code = zip_code
         self.street_number = street_number
-        self.geom = geom
+        self.geom = None
+        if is_geometry(geom) or isinstance(geom, str):
+            self.geom = geom
+        elif isinstance(geom, _SpatialElement):
+            self.geom = to_shape(geom)

pyramid_oereb/core/records/municipality.py

@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
+from dataclasses import dataclass
+from typing import Any
 
 
-class MunicipalityRecord(object):
+@dataclass
+class MunicipalityRecord:
     """
     The base document class.
 
@@ -11,15 +14,7 @@ class MunicipalityRecord(object):
         published (bool): Is this municipality ready for publishing via server.
         geom (str or None): The geometry which is representing this municipality as a WKT.
     """
-    def __init__(self, fosnr, name, published, geom=None):
-        """
-        Args:
-            fosnr (int): The unique id bfs of the municipality.
-            name (unicode): The zipcode for this address.
-            published (bool): Is this municipality ready for publishing via server.
-            geom (str or None): The geometry which is representing this municipality as a WKT.
-        """
-        self.fosnr = fosnr
-        self.name = name
-        self.published = published
-        self.geom = geom
+    fosnr: int
+    name: str
+    published: bool
+    geom: Any = None

pyramid_oereb/core/renderer/extract/json_.py

@@ -11,7 +11,7 @@
 from pyramid_oereb.core import get_multilingual_element
 from pyramid_oereb.core.records.documents import DocumentRecord
 from pyramid_oereb.core.records.theme import ThemeRecord
-from pyramid_oereb.core.sources.plr import PlrRecord
+from pyramid_oereb.core.records.plr import PlrRecord
 
 from pyramid_oereb.core.renderer import Base
 from pyramid_oereb.core.views.webservice import Parameter

pyramid_oereb/core/sources/__init__.py

@@ -7,6 +7,7 @@
 from pyramid.config import ConfigurationError
 from pyramid.path import DottedNameResolver
 from sqlalchemy import text
+from sqlalchemy.orm.exc import NoResultFound
 
 log = logging.getLogger(__name__)
 
@@ -55,6 +56,15 @@ def __init__(self, **kwargs):
             self._model_ = DottedNameResolver().maybe_resolve(kwargs.get('model'))
         else:
             raise ConfigurationError('"model" for source has to be defined in used yaml configuration file')
+        record_class = kwargs.get('record_class')
+        if record_class:
+            if isinstance(record_class, dict):
+                for key, current_class in record_class.items():
+                    self.__setattr__(f"_{key}_record_class", DottedNameResolver().maybe_resolve(current_class))
+            else:
+                self._record_class_ = DottedNameResolver().maybe_resolve(kwargs.get('record_class'))
+        else:
+            raise ConfigurationError('"record_class" for source has to be defined in used yaml configuration file')
         # check if database is available and wait until it might be or raise error
         timeout_target = time.time() + self.TIMEOUT
         db_healthy = False
@@ -88,3 +98,27 @@ def health_check(self):
             return True
         except Exception:
             return False
+
+    @staticmethod
+    def filter(self, query, *args, **kwargs):
+        """
+        abstract method to be overridden
+        """
+        return query
+
+    def read(self, *args, **kwargs):
+        session = self._adapter_.get_session(self._key_)
+        try:
+            query = session.query(self._model_)
+            results = self.filter(query, *args, **kwargs).all()
+
+            self.records = []
+            for result in results:
+                res_dict = {c.name: result.__getattribute__(c.name) for c in result.__table__.columns}
+                self.records.append(self._record_class_(**res_dict))
+
+        except NoResultFound:
+            self.records = []
+
+        finally:
+            session.close()

pyramid_oereb/core/sources/plr.py

@@ -1,15 +1,6 @@
 # -*- coding: utf-8 -*-
 import logging
 
-from pyramid_oereb.core.records.documents import DocumentRecord
-from pyramid_oereb.core.records.embeddable import DatasourceRecord
-from pyramid_oereb.core.records.disclaimer import DisclaimerRecord
-from pyramid_oereb.core.records.geometry import GeometryRecord
-from pyramid_oereb.core.records.glossary import GlossaryRecord
-from pyramid_oereb.core.records.law_status import LawStatusRecord
-from pyramid_oereb.core.records.office import OfficeRecord
-from pyramid_oereb.core.records.plr import PlrRecord
-from pyramid_oereb.core.records.view_service import ViewServiceRecord, LegendEntryRecord
 from pyramid_oereb.core.sources import Base
 
 log = logging.getLogger(__name__)
@@ -25,17 +16,6 @@ class PlrBaseSource(Base):
         datasource (list of pyramid_oereb.lib.records.embeddable.DatasourceRecord): List of data source
             records used for the additional data in flavour `embeddable`.
     """
-    _documents_record_class = DocumentRecord
-    _disclaimer_record_class = DisclaimerRecord
-    _geometry_record_class = GeometryRecord
-    _glossary_record_class = GlossaryRecord
-    _legend_entry_record_class = LegendEntryRecord
-    _office_record_class = OfficeRecord
-    _plr_record_class = PlrRecord
-    _view_service_record_class = ViewServiceRecord
-    _law_status_record_class = LawStatusRecord
-    _datasource_record_class = DatasourceRecord
-
     datasource = list()
 
     def __init__(self, **kwargs):
@@ -69,20 +49,3 @@ def info(self):
             dict: The info dictionary.
         """
         return self._plr_info
-
-    def read(self, params, real_estate, bbox):
-        """
-        Every public law restriction source has to implement a read method. This method must accept the two
-        key word parameters. If you want adapt to your own source for real estates, this is the point where
-        to hook in.
-
-        Args:
-            params (pyramid_oereb.views.webservice.Parameter): The parameters of the extract request.
-            real_estate (pyramid_oereb.lib.records.real_estate.RealEstateRecord): The real estate which is
-                used as filter to find all related public law restrictions.
-            bbox (shapely.geometry.base.BaseGeometry): The bounding box which is used as a pre-filter to find
-                all public law restrictions. This is related to the fact that we need to provide not only the
-                public law restrictions that are related to the real estate but also the ones which are in
-                the visible extent of the map.
-        """
-        self.records = list()

tests/contrib.data_sources.oereblex/sources/test_plr_oereblex.py

@@ -76,7 +76,19 @@ def plr_source_params(db_connection):
                 "db_connection": db_connection,
                 "model_factory": "pyramid_oereb.contrib.data_sources.standard."
                                  "models.theme.model_factory_string_pk",
-                "schema_name": "forest_perimeters"
+                "schema_name": "forest_perimeters",
+                "record_class": {
+                    "documents": "pyramid_oereb.core.records.documents.DocumentRecord",
+                    "disclaimer": "pyramid_oereb.core.records.disclaimer.DisclaimerRecord",
+                     "geometry": "pyramid_oereb.core.records.geometry.GeometryRecord",
+                    "glossary": "pyramid_oereb.core.records.glossary.GlossaryRecord",
+                    "legend_entry": "pyramid_oereb.core.records.view_service.LegendEntryRecord",
+                    "office": "pyramid_oereb.core.records.office.OfficeRecord",
+                    "plr": "pyramid_oereb.core.records.plr.PlrRecord",
+                    "view_service": "pyramid_oereb.core.records.view_service.ViewServiceRecord",
+                    "law_status": "pyramid_oereb.core.records.law_status.LawStatusRecord",
+                    "datasource": "pyramid_oereb.core.records.embeddable.DatasourceRecord",
+                }
             }
         },
         "hooks": {

tests/contrib.data_sources.standard/sources/test_adress.py

@@ -13,7 +13,8 @@
 def address_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Address"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Address",
+        "record_class": "pyramid_oereb.core.records.address.AddressRecord"
     }
 
 
@@ -28,13 +29,18 @@ def one_address_result_session(session, query, wkb_point):
 
     class Query(query):
 
-        def one(self):
-            return Address(**{
-                'street_name': 'teststreet',
-                'street_number': '99a',
-                'zip_code': 4050,
-                'geom': wkb_point
-            })
+        def limit(self, limit):
+            class LimitedQuery(Query):
+                def all(self):
+                    return [
+                        Address(**{
+                            'street_name': 'teststreet',
+                            'street_number': '99a',
+                            'zip_code': 4050,
+                            'geom': wkb_point
+                        })
+                    ]
+            return LimitedQuery()
 
     class Session(session):
 
@@ -49,8 +55,15 @@ def no_result_session(session, query, wkb_point):
 
     class Query(query):
 
-        def one(self):
-            raise NoResultFound
+        class LimitedQuery(query):
+            def all(self):
+                raise NoResultFound
+
+        def limit(self, limit):
+            return self.LimitedQuery()
+
+        def filter(self, term):
+            return self
 
     class Session(session):
 

tests/contrib.data_sources.standard/sources/test_disclaimer.py

@@ -9,7 +9,8 @@
 def disclaimer_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Disclaimer"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Disclaimer",
+        "record_class": "pyramid_oereb.core.records.disclaimer.DisclaimerRecord"
     }
 
 

tests/contrib.data_sources.standard/sources/test_document.py

@@ -17,7 +17,8 @@
 def document_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Document"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Document",
+        "record_class": "pyramid_oereb.core.records.documents.DocumentRecord"
     }
 
 

tests/contrib.data_sources.standard/sources/test_document_types.py

@@ -9,7 +9,8 @@
 def document_types_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.DocumentTypeText"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.DocumentTypeText",
+        "record_class": "pyramid_oereb.core.records.document_types.DocumentTypeRecord"
     }
 
 

tests/contrib.data_sources.standard/sources/test_general_information.py

@@ -9,7 +9,8 @@
 def general_information_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.GeneralInformation"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.GeneralInformation",
+        "record_class": "pyramid_oereb.core.records.general_information.GeneralInformationRecord"
     }
 
 

tests/contrib.data_sources.standard/sources/test_glossary.py

@@ -9,7 +9,8 @@
 def glossary_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Glossary"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.Glossary",
+        "record_class": "pyramid_oereb.core.records.glossary.GlossaryRecord"
     }
 
 

tests/contrib.data_sources.standard/sources/test_law_status.py

@@ -10,7 +10,8 @@
 def law_status_source_params(db_connection):
     yield {
         "db_connection": db_connection,
-        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.LawStatus"
+        "model": "pyramid_oereb.contrib.data_sources.standard.models.main.LawStatus",
+        "record_class": "pyramid_oereb.core.records.law_status.LawStatusRecord"
     }