Skip to content
Snippets Groups Projects
Commit 744e2551 authored by erichard's avatar erichard
Browse files

Add doctest

add doctype for
get_selected_elements
, get_discriminating_labels
and high_discriminating_labels.
parent e47d4593
No related branches found
No related tags found
2 merge requests!61Packager labelstower,!60WIP: Implement sqlalchemy
......@@ -10,10 +10,14 @@ def get_selected_elements(id_mandatory_labels: int, id_forbiden_labels: str, num
EXEMPLE
-------
>>> print(get_elements("","",0)) # si aucun labels n'est interdit ou obligatoire
>>> print(get_selected_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'}]
>>> print(get_selected_elements("1,2","5,9",2)) # si la voiture doit-être bleu
[{'id': 4, 'name': 'peugeot, 2000'}]
>>> print(get_selected_elements("5","",1))
[{'id': 3, 'name': 'renault, 2000'}, {'id': 2, 'name': 'renault, bleu, 2000'}, {'id': 1, 'name': 'renault, rouge, 2000'}]
>>> print(get_selected_elements("","5",0))
[{'id': 4, 'name': 'peugeot, 2000'}]
"""
#query slightly vary if number_of_mandatory_labels > 0 or not
if(number_of_mandatory_labels):
......@@ -86,6 +90,13 @@ def get_discriminating_labels(selected_elements: List[Dict[int, str]]) -> List[D
Return all labels associated to selected elements except non discrminating
:param elements: list[Dict[str, str]]
:return: list[Dict[int, str]]
EXEMPLE
-------
>>> get_discriminating_labels([{"id":2,"name":"renault, bleu, 2000"}, {"id":1,"name":"renault, rouge, 2000"}])
[{'id': 8, 'name': 'rouge'}, {'id': 9, 'name': 'bleu'}]
>>> get_discriminating_labels([])
[]
"""
id_selected_elements: str = get_ids(selected_elements)
number_of_selected_elements = len(selected_elements)
......@@ -117,6 +128,11 @@ def get_high_discriminating_labels(discriminating_labels: List[Dict[int, str]])
Return a set of new labels to continue your selection with it
:param elements: list[Dict[str, str]]
:return: list[Dict[int, str]]
EXEMPLE
-------
>>> get_high_discriminating_labels([{"id":7, "name":"couleur"}, {"id":8, "name":"rouge"}, {"id":9, "name":"bleu"}])
[{'id': 7, 'name': 'couleur'}]
"""
id_discriminating_labels = get_ids(discriminating_labels)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment