From a2067a74557ee96e1320a669a73b16608a3ff414 Mon Sep 17 00:00:00 2001
From: erichard <elliot.richard@lal.in2p3.fr>
Date: Wed, 27 Nov 2019 13:43:36 +0100
Subject: [PATCH] Add doctest for get_ids and get_elements.

---
 app/getter.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/app/getter.py b/app/getter.py
index 02c8b57..ad21eb7 100644
--- a/app/getter.py
+++ b/app/getter.py
@@ -7,6 +7,13 @@ def get_elements(id_mandatory_labels: int, id_forbiden_labels: str, number_of_ma
     :param id_forbiden_labels: str
     :param number_of_mandatory_labels: int
     :return: List[Dict[int, str]]
+
+    EXEMPLE
+    -------
+    >>> print(get_elements("","",0)) # si aucun labels n'est interdit ou obligatoire
+    [{'id': 4, 'name': 'peugeot, 2000'}, {'id': 3, 'name': 'renault, 2000'}, {'id': 2, 'name': 'renault, bleu, 2000'}, {'id': 1, 'name': 'renault, rouge, 2000'}]
+    >>> print(get_elements("9","",1)) # si la voiture doit-ĂȘtre bleu
+    [{'id': 2, 'name': 'renault, bleu, 2000'}]
     """
     #query slightly vary if number_of_mandatory_labels > 0 or not
     if(number_of_mandatory_labels):
@@ -145,6 +152,13 @@ def get_ids(objects: List[Dict[int, str]]) -> str :
     :param objects: list[Dict[str, str]]
     :param attribut: str
     :return: str
+
+    EXEMPLE
+    -------
+    >>> print(get_ids([{"id":1, "name":"a"},{"id":2, "name":"b"}]))
+    1,2
+    >>> print(get_ids([]))
+    <BLANKLINE>
     """
     objects_ids = ""
     for object in objects:
@@ -166,3 +180,7 @@ def send_query_to_db(query: str) -> List[Dict[int, str]] :
          for row in response:
              result.append({"id": row[0], "name": row[1]})
     return result
+
+if __name__ == "__main__":
+    import doctest
+    doctest.testmod(verbose=True)
\ No newline at end of file
-- 
GitLab