Program do quizów historycznych w Pythonie

Question

Ten program pozwala użytkownikom zarządzać pytaniami i użytkownikami quizów z lat wydarzeń historycznych. Szukam sugestii, jak lepiej zorganizować mój kod, może zastosować OOP dla funkcji i uniknąć używania zmiennej globalnej data_filename.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

from enum import Enum
import os
import pickle
import random


data_filename = 'program.obj'


def read_int(prompt='> ', errmsg='Invalid number!'):
    number = None
    while number is None:
        try:
            number = int(input(prompt))
        except ValueError:
            print(errmsg)
    return number


def display_menu():
    print('What do you want to do?')
    print('[1] List all historical events')
    print('[2] Add event')
    print('[3] Remove event')
    print('[4] Quiz')
    print('[5] Statistics')
    print('[6] Clear statistics') # TODO: move to options submenu
    print('[7] Exit')


def clear_screen():
    print(chr(27) + "[2J")


def pause():
    input('Press any key to continue...')


def yes_or_no(prompt='Proceed? [y|n]\n> ', errmsg='Valid answers are y and n.'):
    answer = input(prompt).strip().lower()
    while answer != 'y' and answer != 'n':
        print(errmsg)
        answer = input(prompt).strip().lower()
    return answer


def read_data_file():
    file = open(data_filename, 'a+b')
    file.seek(0)
    data = {'events': [], 'statistics': {'total_successes': 0, 'total_failures': 0}}
    if os.path.getsize(data_filename) > 0:
        data = pickle.load(file)
    file.close()
    return data


def list_events(data):
    events = data['events']
    if len(events) == 0:
        print('Event list is empty!')
    else:
        print('Historical events:')
        for event in events:
            print(event)


def add_event(data):
    events = data['events']
    year = read_int(prompt='Enter year: ')
    description = input('Enter description: ')
    events.append({'year': year, 'description': description})
    print('Successfully added a new historical event!')


def remove_event(data):
    events = data['events']
    if len(events) == 0:
        print('Event list is empty!')
    else:
        for event in events:
            print(events.index(event), event)
        index = read_int('Which event do you want to delete? ')
        try:
            events.pop(index)
            print('Successfully deleted event!')
        except IndexError:
            print('Number out of range!')


def quiz(data):
    events = data['events']
    stats = data['statistics']
    if len(events) == 0:
        print('Event list is empty!')
    else:
        num = read_int(prompt='How many questions should I ask? ')
        if 0 < num <= len(events):
            for event in random.sample(events, num):
                print(event['description'])
                year = read_int('In which year was following event occurred? ')
                if year == event['year']:
                    stats['total_successes'] += 1
                    print('Good answer!')
                else:
                    stats['total_failures'] += 1
                    print('Bad answer!')
        elif num < 0:
            print('Number of questions can\'t be negative!')
        else:
            print('Too much questions!')


def display_stats(data):
    stats = data['statistics']
    tries = stats['total_successes'] + stats['total_failures']
    if tries == 0:
        total_successes = 0
        total_failures = 0
    else:
        total_successes = stats['total_successes']/tries * 100
        total_failures = stats['total_failures']/tries * 100
    print('Statistics')
    print('Total: {0:10.2f}% successes, {1:10.2f}% failures'.format(total_successes, total_failures))


def clear_stats(data):
    answer = yes_or_no('Are you sure you want to clear statistics? [y|n]\n> ')
    if answer == 'y':
        data['statistics'] = {'total_successes': 0, 'total_failures': 0}
        print('Successfully cleared statistics!')
    else:
        print('Statistics left unchanged.')


# TODO: settings submenu
# def settings(data):
#     print('-' * 10)
#     print('Program settings')
#     print('-' * 10)
#     print('[1] Clear statistics')
#     print('[2] Back')
#     user_choice = read_int()
#     while user_choice != 2:
#         if user_choice == 1:
#             clear_stats(data)


def update_data_file(data):
    file = open(data_filename, 'wb')
    pickle.dump(data, file)
    file.close()


class Choices(Enum):
    list_events = 1
    add_event = 2
    remove_event = 3
    quiz = 4
    statistics = 5
    clear_stats = 6
    exit = 7


program_data = read_data_file()
choice = None
while choice != Choices.exit.value:
    clear_screen()
    display_menu()
    choice = read_int()
    if choice == Choices.list_events.value:
        list_events(program_data)
    elif choice == Choices.add_event.value:
        add_event(program_data)
    elif choice == Choices.remove_event.value:
        remove_event(program_data)
    elif choice == Choices.quiz.value:
        quiz(program_data)
    elif choice == Choices.statistics.value:
        display_stats(program_data)
    elif choice == Choices.clear_stats.value:
        clear_stats(program_data)
    elif choice == Choices.exit.value:
        print('Good bye!')
    else:
        print('Invalid choice!')
    update_data_file(program_data)
    pause()

Answer 1

Stałe

data_filename należy pisać wielką literą, ponieważ jest to stała globalna.

Wcześniejszy powrót

Nie ma potrzeby używania numberjako warunku while; zamiast:

number = None
while number is None:
    try:
        number = int(input(prompt))
    except ValueError:
        print(errmsg)
return number

może być

while True:
    try:
        return int(input(prompt))
    except ValueError:
        print(errmsg)

Zarządzanie menu

display_menumógłby użyć sekwencji krotek, jeszcze lepiej sekwencji nazwanych krotek lub @dataclasses, z których każda ma atrybut ciągu tytułu i atrybut wywoływalny. Wtedy display_menumógłbyś być

print('What do you want to do?')
print('\n'.join(f'[{i}] {item.title}' for i, item in enumerate(menu, 1)))

Widzę, że masz też Choiceswyliczenie. To nie jest złe i możesz potencjalnie użyć zarówno wyliczenia, jak i powyższej sugestii, o ile masz słownik odwołań do wyliczeń-wyborów do funkcji.

Testy członkowskie

answer != 'y' and answer != 'n'

może być

answer not in {'y', 'n'}

Struktura pętli

Unikaj inputpodwójnego dzwonienia ; to:

answer = input(prompt).strip().lower()
while answer != 'y' and answer != 'n':
    print(errmsg)
    answer = input(prompt).strip().lower()
return answer

może być

while True:
    answer = input(prompt).strip().lower()
    if answer in {'y', 'n'}:
        return answer
    print(errmsg)

Operacje na plikach

file = open(data_filename, 'a+b')
file.seek(0)

ma kilka problemów:

• Nowo otwarte uchwyty plików nie wymagają początkowego wyszukiwania do początku; jest to zbędne, jeśli otworzysz w trybie odczytu binarnego
• Powinieneś używać withi unikać jawnegoclose()
• Powinieneś zawracać sobie głowę inicjalizacją domyślnego tylko datawtedy, gdy jest to potrzebne
• Chcesz sprawdzić, czy plik istnieje, a nie jego rozmiar

Więc:

if os.path.exists(data_filename):
    with open(data_filename, 'rb') as file:
        return pickle.load(file)
return {'events': [], 'statistics': {'total_successes': 0, 'total_failures': 0}}

Nadmiarowe predykaty

if 0 < num <= len(events):
    ...
elif num < 0:
    print('Number of questions can\'t be negative!')
else:
    print('Too much questions!')

wymaga ponownego przemyślenia. Po pierwsze, too much questionspowinno too many questions. A co jeśli użytkownik wprowadzi 0? Z pewnością nie jest to „zbyt wiele pytań”, ale to właśnie zostanie wydrukowane. Zasugerował:

if num < 1:
    print('Not enough questions.')
elif num > len(events):
    print('Too many questions.')
else:
    ...

Dane o silniejszej strukturze i lepszej strukturze

stats['total_successes'] + stats['total_failures']

jest przykładem czegoś, co widziałem, nazywanego „makaronem danych”. Słowniki są tu nadużywane, gdy @dataclassbardziej odpowiednie jest coś w rodzaju podpowiedzi typu zawierającego.

Interpolacja ciągów

'Total: {0:10.2f}% successes, {1:10.2f}% failures'.format(total_successes, total_failures)

można łatwiej wyrazić jako

(
    f'Total: {total_successes:10.2f}% successes, '
    f'{total_failures:10.2f}% failures'
)

Podział linii jest opcjonalny, ale lepszy ze względu na czytelność.

Ciąg ucieka

'Number of questions can\'t be negative!'

można łatwiej zapisać jako

"Number of questions can't be negative!"