ska-referee-test/ref-test/common/data_tools.py

import os
import pathlib
from json import dump, loads
from datetime import datetime

from flask.json import jsonify
from main import app
from random import shuffle

from werkzeug.utils import secure_filename

def check_data_folder_exists():
    if not os.path.exists(app.config['DATA_FILE_DIRECTORY']):
        pathlib.Path(app.config['DATA_FILE_DIRECTORY']).mkdir(parents='True', exist_ok='True')

def check_default_indicator():
    if not os.path.isfile(os.path.join(app.config['DATA_FILE_DIRECTORY'], '.default.txt')):
        open(os.path.join(app.config['DATA_FILE_DIRECTORY'], '.default.txt'),'w').close()

def get_default_dataset():
    check_default_indicator()
    default_file_path = os.path.join(app.config['DATA_FILE_DIRECTORY'], '.default.txt')
    with open(default_file_path, 'r') as default_file:
        default = default_file.read()
    return default

def check_json_format(file):
    if not '.' in file.filename:
        return False
    if not file.filename.rsplit('.', 1)[-1] == 'json':
        return False
    return True

def validate_json_contents(file):
    file.stream.seek(0)
    data = loads(file.read())
    if not type(data) is dict:
        return False
    elif not all( key in data for key in ['meta', 'questions']):
        return False
    elif not type(data['meta']) is dict:
        return False
    elif not type(data['questions']) is list:
        return False
    return True

def store_data_file(file, default:bool=None):
    from admin.views import get_id_from_cookie
    check_default_indicator()
    timestamp = datetime.utcnow()
    filename = '.'.join([timestamp.strftime('%Y%m%d%H%M%S'),'json'])
    filename = secure_filename(filename)
    file_path = os.path.join(app.config['DATA_FILE_DIRECTORY'], filename)
    file.stream.seek(0)
    data = loads(file.read())
    data['meta']['timestamp'] = timestamp.strftime('%Y-%m-%d %H%M%S')
    data['meta']['author'] = get_id_from_cookie()
    data['meta']['tests'] = []
    with open(file_path, 'w') as _file:
        dump(data, _file, indent=2)
    if default:
        with open(os.path.join(app.config['DATA_FILE_DIRECTORY'], '.default.txt'), 'w') as _file:
            _file.write(filename)
    return filename

def randomise_list(list:list):
    _list = list.copy()
    shuffle(_list)
    return(_list)

def generate_questions(dataset:dict):
    questions_list = dataset['questions']
    output = []
    for block in randomise_list(questions_list):
        if block['type'] == 'question':
            question = {
                'q_type': 'question',
                'q_no': block['q_no'],
                'question_header': '',
                'text': block['text'],
                'options': randomise_list(block['options'])
            }
            output.append(question)
        if block['type'] == 'block':
            for key, _question in enumerate(randomise_list(block['questions'])):
                question = {
                    'q_type': 'block',
                    'q_no': _question['q_no'],
                    'question_header': block['question_header'] if 'question_header' in block else '',
                    'block_length': len(block['questions']),
                    'block_q_no': key,
                    'text': _question['text'],
                    'options': randomise_list(_question['options'])
                }
                output.append(question)
    return output