From fcda6f68545ab9b912ab00f33b297f7865fb5c16 Mon Sep 17 00:00:00 2001
From: Josef Olsson <josol381@student.liu.se>
Date: Mon, 19 Apr 2021 17:47:42 +0200
Subject: [PATCH] Add documentation for dbc.utils
---
server/app/database/controller/utils.py | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/server/app/database/controller/utils.py b/server/app/database/controller/utils.py
index 61be34ca..441a5b24 100644
--- a/server/app/database/controller/utils.py
+++ b/server/app/database/controller/utils.py
@@ -1,9 +1,15 @@
+"""
+This file contains some miscellaneous functionality.
+"""
+
from app.core import db
from app.core.codes import generate_code_string
from app.database.models import Code
def generate_unique_code():
+ """ Generates a unique competition code. """
+
code = generate_code_string()
while db.session.query(Code).filter(Code.code == code).count():
code = generate_code_string()
@@ -11,13 +17,19 @@ def generate_unique_code():
def commit_and_refresh(item):
+ """ Commits and refreshes the provided item. """
+
db.session.commit()
db.session.refresh(item)
def refresh(item):
+ """ Refreshes the provided item. """
+
db.session.refresh(item)
def commit(item):
+ """ Commits. """
+
db.session.commit()
--
GitLab