occupancy_count.py

import logging
import string
from tkinter import *
from tkinter import ttk
import os
import json
import datetime

global configuration_data
global log_filename


def enable_logging(log_filename='occupancy_count.log'):
    logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
                        datefmt='%m/%d/%Y %H:%M:%S', filename=log_filename,
                        level=logging.DEBUG)


def display_options():
    options = """
Occupancy Verification Script
[Enter] to accept
    """
    print(f'{options}')


def validate_user_input_metadata(data: list) -> list:
    check_items = {'Direction': {'n': 'NB', 'nb': 'NB', 's': 'SB', 'sb': 'SB'},
                   'Location': {'80th': '80TH', 'cp': 'CP'},
                   'Lane': {'etl': 'ETL', 'hov': 'ETL', 'gp': 'GP'}
                   }
    for i in data:
        if i[0] in check_items:
            possible_matches = check_items[i[0]]
            for item in possible_matches:
                if i[1].lower() in possible_matches:
                    i[1] = check_items[i[0]][i[1].lower()]
                else:
                    raise ValueError(f'{i[1]} is not a valid input')
    return data


def get_user_information():
    logging.debug('Get user information')
    display_options()
    all_inputs = [['Analyst'], ['Location'], ['Direction'], ['Lane']]

    for parameter in all_inputs:
        user_input = input(f'{parameter[0]}: ')
        if user_input.lower() == 'x':
            break
        else:
            parameter.append(user_input)

    # validate inputs
    all_inputs = validate_user_input_metadata(all_inputs)

    for item in all_inputs:
        logging.info(f'- METADATA - {item[0]}: {item[1]}')


def start_collection_ui():
    root = Tk()
    root.title('Occupancy Count')

    content = ttk.Frame(root)
    content.grid(column=0, row=0)

    # button images
    current_directory = os.getcwd()
    assets_directory = current_directory + '\\assets\\'

    car_one_occupant_image = PhotoImage(master=root, file=assets_directory + 'passenger_car_one.png')
    car_two_occupant_image = PhotoImage(master=root, file=assets_directory + 'passenger_car_two.png')
    car_three_occupant_image = PhotoImage(master=root, file=assets_directory + 'passenger_car_three.png')
    car_four_occupant_image = PhotoImage(master=root, file=assets_directory + 'passenger_car_four.png')
    motorcycle_image = PhotoImage(master=root, file=assets_directory + 'motorcycle.png')
    van_image = PhotoImage(master=root, file=assets_directory + 'van.png')
    transit_image = PhotoImage(master=root, file=assets_directory + 'transit.png')
    other_transit_image = PhotoImage(master=root, file=assets_directory + 'transit_other.png')
    truck_image = PhotoImage(master=root, file=assets_directory + 'two_axle_truck.png')
    truck_three_image = PhotoImage(master=root, file=assets_directory + 'three_axle_truck.png')

    # create buttons
    car_one_occupant = ttk.Button(content, text='Car 1 Person', command=log_one_passenger_car,
                                  image=car_one_occupant_image)
    car_two_occupant = ttk.Button(content, text='Car 2 Person', command=log_two_passenger_car,
                                  image=car_two_occupant_image)
    car_three_occupant = ttk.Button(content, text='Car 3 Person', command=log_three_passenger_car,
                                    image=car_three_occupant_image)
    car_four_occupant = ttk.Button(content, text='Car 4 Person', command=log_four_passenger_car,
                                   image=car_four_occupant_image)
    motorcycle = ttk.Button(content, text='Motorcycle', command=log_motorcycle,
                            image=motorcycle_image)
    van = ttk.Button(content, text='Van', command=log_van,
                     image=van_image)
    transit = ttk.Button(content, text='Transit', command=log_transit,
                         image=transit_image)
    other_transit = ttk.Button(content, text='Other Transit', command=log_transit_other,
                               image=other_transit_image)
    truck = ttk.Button(content, text='Truck', command=log_two_axle_truck,
                       image=truck_image)
    truck_three = ttk.Button(content, text='Truck 3+', command=log_three_axle_truck,
                             image=truck_three_image)

    # add buttons to grid
    car_one_occupant.grid(column=0, row=0, sticky='nsew')
    car_two_occupant.grid(column=1, row=0, sticky='nsew')
    car_three_occupant.grid(column=2, row=0, sticky='nsew')
    car_four_occupant.grid(column=3, row=0, sticky='nsew')
    motorcycle.grid(column=4, row=0, sticky='nsew')
    van.grid(column=0, row=2, sticky='nsew')
    transit.grid(column=1, row=2, sticky='nsew')
    other_transit.grid(column=2, row=2, sticky='nsew')
    truck.grid(column=3, row=2, sticky='nsew')
    truck_three.grid(column=4, row=2, sticky='nsew')

    # create shortcut labels
    one_passenger_car_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['one_passenger_car'] + ']'
    one_passenger_car_shortcut = ttk.Label(content, text=one_passenger_car_shortcut_text).grid(column=0, row=1)
    two_passenger_car_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['two_passenger_car'] + ']'
    two_passenger_car_shortcut = ttk.Label(content, text=two_passenger_car_shortcut_text).grid(column=1, row=1)
    three_passenger_car_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['three_passenger_car'] + ']'
    three_passenger_car_shortcut = ttk.Label(content, text=three_passenger_car_shortcut_text).grid(column=2, row=1)
    four_passenger_car_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['four_passenger_car'] + ']'
    four_passenger_car_shortcut = ttk.Label(content, text=four_passenger_car_shortcut_text).grid(column=3, row=1)
    motorcycle_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['motorcycle'] + ']'
    motorcycle_shortcut = ttk.Label(content, text=motorcycle_shortcut_text).grid(column=4, row=1)
    van_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['van'] + ']'
    van_shortcut = ttk.Label(content, text=van_shortcut_text).grid(column=0, row=3)
    transit_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['transit'] + ']'
    transit_shortcut = ttk.Label(content, text=transit_shortcut_text).grid(column=1, row=3)
    other_transit_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['transit_other'] + ']'
    other_transit_shortcut = ttk.Label(content, text=other_transit_shortcut_text).grid(column=2, row=3)
    truck_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['two_axle_truck'] + ']'
    truck_shortcut = ttk.Label(content, text=truck_shortcut_text).grid(column=3, row=3)
    truck_three_axle_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['three_axle_truck'] + ']'
    truck_three_axle_shortcut = ttk.Label(content, text=truck_three_axle_shortcut_text).grid(column=4, row=3)

    undo_shortcut_text = '[' + configuration_data['keyboard_shortcuts']['undo'] + '] = Undo'
    undo_shortcut = ttk.Label(content, text=undo_shortcut_text).grid(column=0, row=4)

    # bind keyboard shortcuts
    root.bind(configuration_data['keyboard_shortcuts']['one_passenger_car'], log_one_passenger_car)
    root.bind(configuration_data['keyboard_shortcuts']['two_passenger_car'], log_two_passenger_car)
    root.bind(configuration_data['keyboard_shortcuts']['three_passenger_car'], log_three_passenger_car)
    root.bind(configuration_data['keyboard_shortcuts']['four_passenger_car'], log_four_passenger_car())
    root.bind(configuration_data['keyboard_shortcuts']['motorcycle'], log_motorcycle)
    root.bind(configuration_data['keyboard_shortcuts']['two_axle_truck'], log_two_axle_truck)
    root.bind(configuration_data['keyboard_shortcuts']['three_axle_truck'], log_three_axle_truck)
    root.bind(configuration_data['keyboard_shortcuts']['van'], log_van)
    root.bind(configuration_data['keyboard_shortcuts']['transit'], log_transit)
    root.bind(configuration_data['keyboard_shortcuts']['transit_other'], log_transit_other)
    root.bind(configuration_data['keyboard_shortcuts']['undo'], undo_last_action)

    # set resizing to occur evenly
    for i in range(5):
        content.grid_columnconfigure(i, weight=1)
        content.grid_rowconfigure(i, weight=1)
        root.grid_columnconfigure(i, weight=1)
        root.grid_rowconfigure(i, weight=1)

    root.mainloop()


def undo_last_action(*args):
    print(f'Undo')
    log_parameter = configuration_data['data_parameters']['undo']
    logging.info(f'{log_parameter}')


def remove_last_line_in_file(*args):
    print('Undo')
    global log_filename
    with open(log_filename, "r+") as file:

        # Move the pointer to the end of the file
        file.seek(0, os.SEEK_END)

        # This code means the following code skips the very last character in the file -
        # i.e. in the case the last line is null we delete the last line
        # and the penultimate one
        pos = file.tell() - 1

        # Read each character in the file one at a time from the penultimate
        # character going backwards, searching for the second newline character
        # once we find hte second, exit the search
        for i in range(2):
            while pos > 0 and file.read(1) != "\n":
                pos -= 1
                file.seek(pos, os.SEEK_SET)

        # So long as we're not at the start of the file, delete all the characters ahead
        # of this position
        if pos > 0:
            file.seek(pos, os.SEEK_SET)
            file.truncate()
        print('Undo Complete')


def validate_keyboard_shortcuts(shortcuts: dict):
    for key in shortcuts:
        value = str(shortcuts[key])
        alphanumeric = string.ascii_lowercase + string.ascii_uppercase + string.digits
        if len(value) > 1:
            raise ValueError(f'Keyboard shortcut for {value} is too long')
        elif value not in alphanumeric:
            raise ValueError(f'{shortcuts[key]} is not a valid input')


def log_one_passenger_car(*args):
    print(f'one passenger car')
    log_parameter = configuration_data['data_parameters']['one_passenger_car']
    logging.info(f'{log_parameter}')


def log_two_passenger_car(*args):
    print(f'two passenger car')
    log_parameter = configuration_data['data_parameters']['two_passenger_car']
    logging.info(f'{log_parameter}')


def log_three_passenger_car(*args):
    print(f'three passenger car')
    log_parameter = configuration_data['data_parameters']['three_passenger_car']
    logging.info(f'{log_parameter}')


def log_four_passenger_car(*args):
    print(f'four passenger car')
    log_parameter = configuration_data['data_parameters']['four_passenger_car']
    logging.info(f'{log_parameter}')


def log_motorcycle(*args):
    print(f'motorcycle')
    log_parameter = configuration_data['data_parameters']['motorcycle']
    logging.info(f'{log_parameter}')


def log_two_axle_truck(*args):
    print(f'two axle truck')
    log_parameter = configuration_data['data_parameters']['two_axle_truck']
    logging.info(f'{log_parameter}')


def log_three_axle_truck(*args):
    print(f'three axle truck')
    log_parameter = configuration_data['data_parameters']['three_axle_truck']
    logging.info(f'{log_parameter}')


def log_van(*args):
    print(f'van')
    log_parameter = configuration_data['data_parameters']['van']
    logging.info(f'{log_parameter}')


def log_transit(*args):
    print(f'transit')
    log_parameter = configuration_data['data_parameters']['transit']
    logging.info(f'{log_parameter}')


def log_transit_other(*args):
    print(f'transit other')
    log_parameter = configuration_data['data_parameters']['transit_other']
    logging.info(f'{log_parameter}')


def read_configuration_file(filename):
    logging.debug(f'Read configuration file: {filename}')
    f = open(filename)
    global configuration_data
    configuration_data = json.load(f)
    validate_keyboard_shortcuts(configuration_data['keyboard_shortcuts'])


def get_date_prefix() -> str:
    current_time = datetime.datetime.now()
    prefix_date = f'{current_time.year}{current_time.month}{current_time.day}_'
    prefix_time = f'{current_time.hour}{current_time.minute}{current_time.second}'
    return prefix_date + prefix_time


def main():
    global log_filename
    datetime_prefix = get_date_prefix()
    log_filename = datetime_prefix + '_occupancy_count.log'
    configuration_filename = 'configuration.json'
    enable_logging(log_filename)

    read_configuration_file(configuration_filename)
    get_user_information()
    start_collection_ui()


if __name__ == '__main__':
    main()