Merge pull request #79 from oemof/feature/tabular-version-to-metadata

Write tabular version to metadata

src/oemof/tabular/config/config.py

@@ -17,3 +17,5 @@
 )
 with open(FOREIGN_KEY_DESCRIPTORS_FILE, "r") as fk_descriptors_file:
     FOREIGN_KEY_DESCRIPTORS = json.load(fk_descriptors_file)
+
+supported_oemof_tabular_versions = [None, "0.0.1", "0.0.2", "0.0.3"]

src/oemof/tabular/datapackage/building.py

@@ -15,6 +15,7 @@
 import toml
 from datapackage import Package, Resource
 
+from oemof.tabular import __version__ as oemof_tabular_version
 from oemof.tabular.config import config
 
 
@@ -94,6 +95,7 @@ def infer_metadata(
     p = Package()
     p.descriptor["name"] = package_name
     p.descriptor["profile"] = "tabular-data-package"
+    p.descriptor["oemof_tabular_version"] = oemof_tabular_version
     p.commit()
     if not os.path.exists("resources"):
         os.makedirs("resources")

src/oemof/tabular/datapackage/reading.py

@@ -13,13 +13,16 @@
 import collections.abc as cabc
 import json
 import re
+import warnings
 from decimal import Decimal
 from itertools import chain, groupby, repeat
 
 import datapackage as dp
 import pandas as pd
 from oemof.network.network import Bus, Component
 
+from oemof.tabular.config.config import supported_oemof_tabular_versions
+
 from ..tools import HSN, raisestatement, remap
 
 DEFAULT = object()
@@ -136,6 +139,16 @@ def deserialize_energy_system(cls, path, typemap={}, attributemap={}):
     empty.read = lambda *xs, **ks: ()
     empty.headers = ()
 
+    # check version that was used to create metadata
+    oemof_tabular_version = package.descriptor.get("oemof_tabular_version")
+
+    if oemof_tabular_version not in supported_oemof_tabular_versions:
+        warnings.warn(
+            f"Version of datapackage '{oemof_tabular_version}' is not "
+            f"supported. These versions are supported: "
+            f"{supported_oemof_tabular_versions}"
+        )
+
     def parse(s):
         return json.loads(s) if s else {}
 

src/oemof/tabular/examples/datapackages/dispatch/datapackage.json

@@ -1,6 +1,7 @@
 {
     "profile": "tabular-data-package",
     "name": "oemof-tabular-dispatch-example",
+    "oemof_tabular_version": "0.0.3",
     "resources": [
         {
             "path": "data/elements/bus.csv",

src/oemof/tabular/examples/datapackages/foreignkeys/datapackage.json

@@ -1,6 +1,7 @@
 {
     "profile": "tabular-data-package",
     "name": "oemof-tabular-foreignkeys-examples",
+    "oemof_tabular_version": "0.0.3",
     "resources": [
         {
             "path": "data/elements/bus.csv",

src/oemof/tabular/examples/datapackages/investment/datapackage.json

@@ -1,6 +1,7 @@
 {
     "profile": "tabular-data-package",
     "name": "renpass-invest-example",
+    "oemof_tabular_version": "0.0.3",
     "resources": [
         {
             "path": "data/elements/bus.csv",

tests/test_examples.py

@@ -33,7 +33,7 @@ def compare_json_files(file_1, file_2, ignored=None):
 
     if not lines_1 == lines_2:
         raise AssertionError(
-            "Failed matching lp_file_1 with lp_file_2:\n"
+            "Failed matching json_file_1 with json_file_2:\n"
             + "\n".join(
                 unified_diff(
                     lines_1,