diff options
Diffstat (limited to 'gn3/db')
| -rw-r--r-- | gn3/db/wiki.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/gn3/db/wiki.py b/gn3/db/wiki.py index a56f26c..c3cfee0 100644 --- a/gn3/db/wiki.py +++ b/gn3/db/wiki.py @@ -1,11 +1,14 @@ +"""Helper functions to access wiki entries""" + from typing import List class MissingDBDataException(Exception): - pass + """Error due to DB missing some data""" def get_species_id(cursor, species_name: str) -> int: + """Find species id given species `Name`""" cursor.execute("SELECT SpeciesID from Species WHERE Name = %s", (species_name,)) species_ids = cursor.fetchall() if len(species_ids) != 1: @@ -16,6 +19,7 @@ def get_species_id(cursor, species_name: str) -> int: def get_next_comment_version(cursor, comment_id: int) -> int: + """Find the version to add, usually latest_version + 1""" cursor.execute( "SELECT MAX(versionId) as version_id from GeneRIF WHERE Id = %s", (comment_id,) ) @@ -26,6 +30,7 @@ def get_next_comment_version(cursor, comment_id: int) -> int: def get_categories_ids(cursor, categories: List[str]) -> List[int]: + """Get the categories_ids from a list of category strings""" cursor.execute("SELECT Name, Id from GeneCategory") raw_categories = cursor.fetchall() dict_cats = dict(raw_categories) |