pywmdr 0.2.dev2__py3-none-any.whl → 0.2.dev3__py3-none-any.whl

pywmdr/bundle.py

@@ -19,6 +19,8 @@
 #
 ###############################################################################
 
+import csv
+import io
 import logging
 from pathlib import Path
 import shutil
@@ -38,6 +40,8 @@ TEMPDIR2 = Path(tempfile.TemporaryDirectory().name)
 
 WMDR2_FILES = get_userdir() / 'wmdr2'
 WMDR2_FILES_TEMP = TEMPDIR2 / 'wmdr2'
+WMDS_DIR = get_userdir() / 'wmds'
+WMDS_DIR_TEMP = TEMPDIR2 / 'wmds'
 
 
 @click.group()
@@ -61,6 +65,21 @@ def sync(ctx, verbosity):
     with json_schema.open('wb') as fh:
         fh.write(urlopen_(f'{WMDR2_SCHEMA}').read())
 
+    LOGGER.debug('Caching codelists')
+    LOGGER.debug(f'Downloading WMDS codelists to {WMDS_DIR_TEMP}')
+    WMDS_DIR_TEMP.mkdir(parents=True, exist_ok=True)
+    WMDS_CODELISTS_LIST = 'https://codes.wmo.int/wmdr?_format=csv&_view=with_metadata&status=valid'  # noqa
+    codelists = urlopen_(WMDS_CODELISTS_LIST).read().decode('utf-8')
+    codelists_fh = io.StringIO(codelists.strip())
+    reader = csv.reader(codelists_fh)
+    for row in reader:
+        codelist_url = f'https://codes.wmo.int/wmdr/{row[1]}?_format=csv&_view=with_metadata&status=valid'  # noqa
+        LOGGER.debug(f'Downloading {codelist_url}')
+        codelist_file = WMDS_DIR_TEMP / f'{row[1]}.csv'
+        LOGGER.debug(f'Writing codelist {codelist_file}')
+        with codelist_file.open('wb') as fh:
+            fh.write(urlopen_(codelist_url).read())
+
     LOGGER.debug(f'Removing {USERDIR}')
     if USERDIR.exists():
         shutil.rmtree(USERDIR)

pywmdr/codelists.py

@@ -0,0 +1,122 @@
+##############################################################################
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+###############################################################################
+
+import csv
+import logging
+
+from pywmdr.util import get_userdir
+
+LOGGER = logging.getLogger(__name__)
+
+CODELISTS_MAP = {
+    'facilityType': {
+        'codelists': ['FacilityType.csv']
+    },
+    'wmoRegion': {
+        'codelists': ['WMORegion.csv']
+    },
+    'territory': {
+        'codelists': ['TerritoryName.csv']
+    },
+    'observedGeometry': {
+        'codelists': ['Geometry.csv']
+    },
+    'observedProperty': {
+        'codelists': [
+            'ObservedVariableAtmosphere.csv',
+            'ObservedVariableEarth.csv',
+            'ObservedVariableOcean.csv',
+            'ObservedVariableOuterSpace.csv',
+            'ObservedVariableTerrestrial.csv'
+        ]
+    },
+    'programAffiliation': {
+        'codelists': ['ProgramAffiliation.csv']
+    },
+    'reportingStatus': {
+        'codelists': ['ReportingStatus.csv']
+    },
+    'observingMethod': {
+        'codelists': [
+            'ObservingMethodAtmosphere.csv',
+            'ObservingMethodTerrestrial.csv',
+            'ObservingMethodOcean.csv'
+        ]
+    },
+    'operatingStatus': {
+        'codelists': ['InstrumentOperatingStatus.csv']
+    },
+    'sourceOfObservation': {
+        'codelists': ['SourceOfObservation.csv']
+    },
+    'referenceSurface': {
+        'codelists': ['ReferenceSurfaceType.csv']
+    },
+    'unit': {
+        'codelists': ['unit.csv']
+    },
+}
+
+
+class WMDSCodelists:
+    def __init__(self):
+        """initializer"""
+
+        self.codelists = {}
+        for key, value in CODELISTS_MAP.items():
+            self.codelists[key] = []
+            for codelist in value['codelists']:
+                filename = get_userdir() / 'wmds' / codelist
+                with filename.open() as fh:
+                    reader = csv.DictReader(fh)
+                    for row in reader:
+                        self.codelists[key].append(row['@notation'])
+
+    def is_valid(self, pname: str, pvalue: dict | None) -> bool:
+        """
+        Helper function to determine whether a concept is valid
+        (WMDS codelist or null)
+
+        :param pname: name of property/object
+        :param value: value of property/object
+
+        :returns: `bool` of whether a concept is valid
+        """
+
+        if pname not in self.codelists:
+            msg = f'{pname} not found in codelists'
+            LOGGER.error(msg)
+            raise ValueError(msg)
+
+        if pvalue is None:
+            LOGGER.debug('Value is null')
+            return True
+
+        LOGGER.debug(f'Property name: {pname}')
+        LOGGER.debug(f'Property value: {pvalue}')
+        LOGGER.debug(f'Codelist: {self.codelists[pname]}')
+        if pvalue['id'] in self.codelists[pname]:
+            return True
+
+        return False
+
+    def __repr__(self):
+        return '<WMDSCodelists>'

pywmdr/pygeoapi_plugin.py

@@ -60,7 +60,7 @@ LOGGER = logging.getLogger(__name__)
 with (THISDIR / 'resources' / 'ets-report.json').open() as fh:
     ETS_REPORT_SCHEMA = json.load(fh)
 
-with (THISDIR / 'resources' / '20250504_0-20008-0-NRB.json').open() as fh:
+with (THISDIR / 'resources' / '0-20008-0-THE.json').open() as fh:
     EXAMPLE_WMDR2 = json.load(fh)
 
 

pywmdr/resources/0-20008-0-THE.json

@@ -0,0 +1,176 @@
+{
+    "type": "Feature",
+    "id": "0-20008-0-THE",
+    "geometry": {
+        "type": "Point",
+        "coordinates": [
+            22.956,
+            40.634,
+            60
+        ]
+    },
+    "time": {
+        "interval": [
+            "1982-03-13",
+            ".."
+        ]
+    },
+    "conformsTo": [
+        "http://wigos.wmo.int/spec/wmdr/2/conf/core"
+    ],
+    "properties": {
+        "type": "facility",
+        "facilityType": {
+            "id": "landFixed"
+        },
+        "title": "Thessaloniki",
+        "created": "2024-12-11T00:00:00Z",
+        "updated": "2024-12-11T00:00:00Z",
+        "description": "The Brewer spectrophotometers and all radiation instruments are located on the roof of the 4-storey building of the Physics Dept., of the Aristotle University of Thessaloniki. The Campus is located in the city center about 500 m east of the seashore. The highest elevation of about 1100 m is at a distance of about 15 km towards the east. Thessaloniki is the second largest city of Greece with about 1000000 inhabitants in the greater metropolitan area.",
+        "contacts": [
+            {
+                "identifier": "contact:aristotle-university-of-thessaloniki--ed7b7e4a",
+                "organization": "Aristotle University of Thessaloniki",
+                "roles": [
+                    "owner"
+                ],
+                "links": [
+                    {
+                        "rel": "about",
+                        "href": "https://lapweb.physics.auth.gr",
+                        "type": "text/html"
+                    }
+                ]
+            },
+            {
+                "identifier": "contact:clima@hnms.gr",
+                "name": "Mrs M. Michelaraki",
+                "organization": "Hellenic National Meteorological Service",
+                "roles": [
+                    "pointOfContact"
+                ],
+                "links": [
+                    {
+                        "rel": "about",
+                        "href": "https://www.emy.gr",
+                        "type": "text/html"
+                    }
+                ]
+            },
+            {
+                "identifier": "contact:abais@auth.gr",
+                "name": "Alkiviadis Bais",
+                "organization": "Aristotle University of Thessaloniki",
+                "roles": [
+                    "principalInvestigator"
+                ],
+                "links": [
+                    {
+                        "rel": "about",
+                        "href": "https://lapweb.physics.auth.gr",
+                        "type": "text/html"
+                    }
+                ]
+            },
+            {
+                "identifier": "contact:balis@auth.gr",
+                "name": "Dimitris Balis",
+                "organization": "Aristotle University of Thessaloniki",
+                "roles": [
+                    "principalInvestigator"
+                ],
+                "links": [
+                    {
+                        "rel": "about",
+                        "href": "https://lapweb.physics.auth.gr",
+                        "type": "text/html"
+                    }
+                ]
+            }
+        ],
+        "wmoRegion": {
+            "id": "europe"
+        },
+        "territories": [
+            {
+                "dates": [
+                    "2011-02-16",
+                    ".."
+                ],
+                "territory": {"id": "GRC"}
+            }
+        ],
+        "observations": [
+            {
+                "observedProperty": {
+                    "id": "12164"
+                },
+                "programAffiliations": [
+                    {
+                        "dates": [
+                            "1982-03-13",
+                            ".."
+                        ],
+                        "programAffiliation": {
+                            "id": "GAWregional"
+                        },
+                        "reportingStatus": {
+                            "id": "operational"
+                        }
+                    },
+                    {
+                        "dates": [
+                            "2008-01-01",
+                            "2024-12-11"
+                        ],
+                        "programAffiliation": {
+                            "id": "GALION"
+                        },
+                        "reportingStatus": {
+                            "id": "operational"
+                        }
+                    },
+                    {
+                        "dates": [
+                            "2003-06-01",
+                            "2024-12-11"
+                        ],
+                        "programAffiliation": {
+                            "id": "AERONET"
+                        },
+                        "reportingStatus": {
+                            "id": "operational"
+                        }
+                    }
+                ],
+                "configurations": [
+                    {
+                        "id": "configuration-456",
+                        "time": {
+                            "interval": [
+                                "1982-03-13",
+                                ".."
+                            ]
+                        },
+                        "observingMethod": {
+                            "id": "78"
+                        },
+                        "sourceOfObservation": {
+                            "id": "automaticReading"
+                        },
+                        "instrument": {
+                            "id": "instrument-789"
+                        }
+                    }
+                ]
+            }
+        ]
+    },
+    "links": [
+        {
+            "href": "https://lapweb.physics.auth.gr/en/infrastructure/#Infrastructure",
+            "rel": "about",
+            "type": "text/html"
+        }
+    ]
+}

pywmdr/wmdr2/ets.py

@@ -27,6 +27,7 @@ from jsonschema import FormatChecker
 from jsonschema.validators import Draft202012Validator
 
 from pywmdr.bundle import WMDR2_FILES
+from pywmdr.codelists import WMDSCodelists
 from pywmdr.errors import TestSuiteError
 from pywmdr.util import get_current_datetime_rfc3339, get_package_version
 
@@ -42,7 +43,7 @@ def gen_test_id(test_id: str) -> str:
     :returns: test identifier as URI
     """
 
-    return f'http://wis.wmo.int/spec/wmdr/2/conf/core/{test_id}'
+    return f'http://wigos.wmo.int/spec/wmdr/2/conf/core/{test_id}'
 
 
 class WMDR2TestSuite:
@@ -57,6 +58,7 @@ class WMDR2TestSuite:
 
         self.version = get_package_version()
         self.errors = []
+        self.codelists = WMDSCodelists()
         self.record = record
 
     def run_tests(self):
@@ -144,6 +146,73 @@ class WMDR2TestSuite:
 
         return status
 
+    def test_requirement_codelisted_values(self):
+        """
+        Test property values against required codelists
+        """
+
+        validation_errors = []
+
+        status = {
+            'id': gen_test_id('codelisted_values'),
+            'code': 'PASSED'
+        }
+
+        codelisted_values = []
+
+        LOGGER.debug('Validating against codelisted values')
+
+        codelisted_values.append(
+            ('facilityType', [self.record['properties']['facilityType']]))
+
+        codelisted_values.append(
+            ('wmoRegion', [self.record['properties']['wmoRegion']]))
+
+        for territory in self.record['properties'].get('territories', []):
+            codelisted_values.append(('territory', [territory['territory']]))
+
+        for observation in self.record['properties']['observations']:
+            codelisted_values.append(
+                ('observedGeometry', [observation.get('observedGeometry')]))
+            codelisted_values.append(
+                ('observedProperty', [observation['observedProperty']]))
+
+            for program_affiliation in observation.get('programAffiliations'):
+                codelisted_values.append(
+                    ('programAffiliation', [program_affiliation['programAffiliation']]))  # noqa
+                codelisted_values.append(
+                    ('reportingStatus', [program_affiliation.get('reportingStatus')]))  # noqa
+
+            for configuration in observation['configurations']:
+                codelisted_values.append(
+                    ('observingMethod', [configuration.get('observingMethod')]))  # noqa
+                codelisted_values.append(
+                    ('operatingStatus', [configuration.get('operatingStatus')]))  # noqa
+                codelisted_values.append(
+                    ('sourceOfObservation', [configuration.get('sourceOfObservation')]))  # noqa
+
+                vertical_distance = configuration.get('verticalDistance')
+
+                if vertical_distance is not None:
+                    codelisted_values.append(
+                        ('unit', [vertical_distance['unit']]))
+                    codelisted_values.append(
+                        ('referenceSurface', [vertical_distance['referenceSurface']]))  # noqa
+
+        for codelisted_value in codelisted_values:
+            LOGGER.debug(f'Testing {codelisted_value[0]} against {codelisted_value[1]}')  # noqa
+            for codelisted_value2 in codelisted_value[1]:
+                if not self.codelists.is_valid(codelisted_value[0], codelisted_value2):  # noqa
+                    msg = f'Invalid codelist value for {codelisted_value[0]}'
+                    validation_errors.append(msg)
+
+        if validation_errors:
+            status['code'] = 'FAILED'
+            status['message'] = f'{len(validation_errors)} error(s)'
+            status['errors'] = validation_errors
+
+        return status
+
     def raise_for_status(self):
         """
         Raise error if one or more failures were found during validation.

{pywmdr-0.2.dev2.dist-info → pywmdr-0.2.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywmdr
-Version: 0.2.dev2
+Version: 0.2.dev3
 Summary: A Python implementation of the test suite for WIGOS Metadata Record
 Author-email: Tom Kralidis <tomkralidis@gmail.com>
 Maintainer-email: Tom Kralidis <tomkralidis@gmail.com>

pywmdr-0.2.dev3.dist-info/RECORD

@@ -0,0 +1,18 @@
+pywmdr/__init__.py,sha256=nmM2-nevDwLyTfthzuef-AJ8kMnWxX7Nb_gMXJ3ZL00,1318
+pywmdr/bundle.py,sha256=VgkDwwsftqbpBXKJORwjzl6oqST5LVB-6K0vCKOZRqo,3190
+pywmdr/cli_options.py,sha256=N70OlGeonJvkVNdDoh-X606J1JCUWnKwpa5gduoJ_aM,1533
+pywmdr/codelists.py,sha256=UMYqy4Tk8GLulqMjE3xouZMWCUpnW1qHbuwZ1CiACpA,3694
+pywmdr/errors.py,sha256=Uu2J6vmTjaWuNJaW-mtdZ_KCztc9x4wjaLRVDZP6Lk0,1176
+pywmdr/ets.py,sha256=I1JeheXMCsPtRXjf5ay8I3MZFrrsDtj5k0XT68XCOOY,2076
+pywmdr/pygeoapi_plugin.py,sha256=WJek0RGL18RjnPY4kemrSNSQtQo7CVQOBPM7Xb6kqh0,4440
+pywmdr/util.py,sha256=LE_Ds6OuG7vNQxjFQcogWiPD5CNQyHhqIXeW6TNXJZE,2639
+pywmdr/resources/0-20008-0-THE.json,sha256=luAjCrxbnwq4x0nwqm2vyx8d5rXmkMeGwVCQ2w-gaXg,5873
+pywmdr/resources/ets-report.json,sha256=VwZohaD_EloSlwhYXxnj08Z3ckfbFYudLc2dWwxvlus,2243
+pywmdr/wmdr2/__init__.py,sha256=VK88WG3wpt5RqksGgutMnr02OhUlksWcoAnoeSRRWic,1035
+pywmdr/wmdr2/ets.py,sha256=QzXUVcGROmYcSsO7QbPcsEibz3gmaWK2FJfHbDoUUa0,7817
+pywmdr-0.2.dev3.dist-info/licenses/LICENSE.md,sha256=Q8E0TXZpH75ydPcip7DXr21Y3uwJNgQUFv3ipMXwPkw,839
+pywmdr-0.2.dev3.dist-info/METADATA,sha256=0KrWF4dlxa-nW0PsMwU_gazhJDYyA-FwRZhINUlt2uA,5104
+pywmdr-0.2.dev3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+pywmdr-0.2.dev3.dist-info/entry_points.txt,sha256=Ga7GlkDlThWwprQDc5OawyWtV_RT9FXilgXjwKacynU,38
+pywmdr-0.2.dev3.dist-info/top_level.txt,sha256=_Zdw0CS7tVYk-CJZmu9xEqIzOuY98RsI6CUMh8Kh818,7
+pywmdr-0.2.dev3.dist-info/RECORD,,

pywmdr/resources/20250504_0-20008-0-NRB.json

@@ -1,94 +0,0 @@
-{
-    "id": "urn:wmo:md:ke-meteo:0-20008-0-NRB",
-    "type": "Feature",
-    "conformsTo": [
-        "http://wis.wmo.int/spec/wmdr/2/conf/core"
-    ],
-    "geometry": {
-        "type": "Point",
-        "coordinates": [
-            36.75919,
-            -1.30169,
-            1795.0
-        ]
-    },
-    "properties": {
-        "created": "1996-01-01T00:00:00Z",
-        "wmo:dataPolicy": "core",
-        "contacts": [
-            {
-                "name": "World Meteorological Organization WMO and Federal Office for Meteorology and Climatology MeteoSwiss",
-                "organization": "World Meteorological Organization WMO and Federal Office for Meteorology and Climatology MeteoSwiss",
-                "emails": [
-                    {
-                        "value": "oscar@wmo.int"
-                    }
-                ],
-                "addresses": [
-                    {
-                        "deliveryPoint": [
-                            "7bis, avenue de la Paix"
-                        ],
-                        "city": "Geneva",
-                        "postalCode": "CH-1211",
-                        "country": "Switzerland"
-                    }
-                ],
-                "contactInstructions": "email",
-                "links": [
-                    {
-                        "rel": "canonical",
-                        "type": "text/html",
-                        "href": "https://oscar.wmo.int/surface"
-                    }
-                ],
-                "roles": [
-                    "host"
-                ]
-            },
-            {
-                "name": "Waweru,Amos,Mr",
-                "organization": "Kenyan Meteorological Department",
-                "phones": [
-                    {
-                        "value": "+254723521586"
-                    }
-                ],
-                "emails": [
-                    {
-                        "value": "waweru_k@yahoo.com"
-                    },
-                    {
-                        "value": "amoskamau1969@gmail.com"
-                    }
-                ],
-                "addresses": [
-                    {
-                        "deliveryPoint": [
-                            "Kenya Meteorological Department 30259\nNairobi \nKenya"
-                        ],
-                        "city": "Nairobi",
-                        "administrativeArea": "NB",
-                        "postalCode": "00100",
-                        "country": "Kenya"
-                    }
-                ],
-                "contactInstructions": "africa",
-                "roles": [
-                    "processor",
-                    "producer"
-                ]
-            }
-        ]
-    },
-    "links": [
-        {
-            "rel": "license",
-            "href": "https://creativecommons.org/licenses/by/4.0/"
-        },
-        {
-            "rel": "stations",
-            "href": "http://www.meteo.go.ke/obsv/ozone.html"
-        }
-    ]
-}

pywmdr-0.2.dev2.dist-info/RECORD

@@ -1,17 +0,0 @@
-pywmdr/__init__.py,sha256=nmM2-nevDwLyTfthzuef-AJ8kMnWxX7Nb_gMXJ3ZL00,1318
-pywmdr/bundle.py,sha256=bwqO-pVVeF2shVBKMj2lwgKuVeXbmHPEsU4o-jutCfk,2276
-pywmdr/cli_options.py,sha256=N70OlGeonJvkVNdDoh-X606J1JCUWnKwpa5gduoJ_aM,1533
-pywmdr/errors.py,sha256=Uu2J6vmTjaWuNJaW-mtdZ_KCztc9x4wjaLRVDZP6Lk0,1176
-pywmdr/ets.py,sha256=I1JeheXMCsPtRXjf5ay8I3MZFrrsDtj5k0XT68XCOOY,2076
-pywmdr/pygeoapi_plugin.py,sha256=Ib8RH3fh62p4ajAOhk1f73etqXkBsnDtYUqVgjzvh_k,4449
-pywmdr/util.py,sha256=LE_Ds6OuG7vNQxjFQcogWiPD5CNQyHhqIXeW6TNXJZE,2639
-pywmdr/resources/20250504_0-20008-0-NRB.json,sha256=gvSgRDp4U_Oh5Wyu54a3IhcOvaxg-cpjrNNALyOGhR4,2958
-pywmdr/resources/ets-report.json,sha256=VwZohaD_EloSlwhYXxnj08Z3ckfbFYudLc2dWwxvlus,2243
-pywmdr/wmdr2/__init__.py,sha256=VK88WG3wpt5RqksGgutMnr02OhUlksWcoAnoeSRRWic,1035
-pywmdr/wmdr2/ets.py,sha256=QI89slTlQabmcTXjSmPmaZzQ7Bi0A9YwDCvkNQNj7qs,4859
-pywmdr-0.2.dev2.dist-info/licenses/LICENSE.md,sha256=Q8E0TXZpH75ydPcip7DXr21Y3uwJNgQUFv3ipMXwPkw,839
-pywmdr-0.2.dev2.dist-info/METADATA,sha256=bHCu19864TYcyGh6HiGCoDnY87_fEw5WMOlkBvoZI-4,5104
-pywmdr-0.2.dev2.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-pywmdr-0.2.dev2.dist-info/entry_points.txt,sha256=Ga7GlkDlThWwprQDc5OawyWtV_RT9FXilgXjwKacynU,38
-pywmdr-0.2.dev2.dist-info/top_level.txt,sha256=_Zdw0CS7tVYk-CJZmu9xEqIzOuY98RsI6CUMh8Kh818,7
-pywmdr-0.2.dev2.dist-info/RECORD,,