From 8596df2ad16cbdd961f37499c5405d5ee0faef36 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Wed, 7 Apr 2021 20:38:11 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20Add=20a=20last=5Fupdate=20field?=
 =?UTF-8?q?=20in=20the=20DataFlow=20model?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../0005_alter_dataflow_last_update.py        | 18 +++++++++
 sophon/core/models.py                         | 40 +++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 sophon/core/migrations/0005_alter_dataflow_last_update.py

diff --git a/sophon/core/migrations/0005_alter_dataflow_last_update.py b/sophon/core/migrations/0005_alter_dataflow_last_update.py
new file mode 100644
index 0000000..aaeccb0
--- /dev/null
+++ b/sophon/core/migrations/0005_alter_dataflow_last_update.py
@@ -0,0 +1,18 @@
+# Generated by Django 3.2 on 2021-04-07 17:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0004_dataflow'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='dataflow',
+            name='last_update',
+            field=models.DateTimeField(auto_now=True, help_text='The datetime at which the properties of this DataFlow were last updated.', verbose_name='Last updated'),
+        ),
+    ]
diff --git a/sophon/core/models.py b/sophon/core/models.py
index fb34110..eac84da 100644
--- a/sophon/core/models.py
+++ b/sophon/core/models.py
@@ -1,4 +1,7 @@
 from django.db import models
+import pandas
+import pandasdmx
+import pandasdmx.message
 
 
 class DataSource(models.Model):
@@ -31,6 +34,42 @@ class DataSource(models.Model):
         null=True
     )
 
+    def to_pandasdmx_source(self) -> pandasdmx.source.Source:
+        """
+        Convert the :class:`.DataSource` to a :class:`pandasdmx.source.Source`\\ .
+
+        :return: The :class:`pandasdmx.source.Source`\\ .
+
+        .. todo:: :func:`.to_pandasdmx` does not currently support non :attr:`.builtin` sources.
+        """
+        return pandasdmx.source.sources[self.pandasdmx_id]
+
+    def to_pandasdmx_request(self) -> pandasdmx.Request:
+        """
+        Convert the :class:`.DataSource` to a :class:`pandasdmx.Request` client.
+
+        :return: The :class:`pandasdmx.Request`\\ .
+        """
+        return pandasdmx.Request(source=self.to_pandasdmx_source().id)
+
+    def request_flows(self) -> tuple[pandas.Series, pandas.Series]:
+        """
+        Retrieve all available dataflows and datastructures as two :class:`pandas.Series`\\ .
+
+        :return: A :class:`tuple` containing all dataflows and all datastructures.
+
+        .. note:: This seems to be an expensive operation, as it may take a few minutes to execute.
+
+        .. todo:: This function assumes both ``dataflow`` and ``structure`` will always be available.
+                  Can something happen to make at least one of them :data:`None` ?
+        """
+        source = self.to_pandasdmx_request()
+        message: pandasdmx.message.Message = source.dataflow()
+        data: dict[str, pandas.Series] = message.to_pandas()
+        flows = data["dataflow"]
+        structs = data["structure"]
+        return flows, structs
+
     def __str__(self):
         return self.pandasdmx_id
 
@@ -55,6 +94,7 @@ class DataFlow(models.Model):
     last_update = models.DateTimeField(
         "Last updated",
         help_text="The datetime at which the properties of this DataFlow were last updated.",
+        auto_now=True,
     )
 
     description = models.CharField(