advent-of-code-24

A repository for hosting my advent of code solutions

structure & assumptions

each solution resides in a:

main.py

and each problem input resides in

input.txt

both reside in a directory for the respective day.

the main function will search for input.txt in the same directory, so make sure it's in the leaf of the file

boilerplate

The problems usually follow a structure of first needing to do some input parsing and later solving a part one and a part two for the input. The same input is usually for both parts.

Therefore each day I can reuse the following base structure to get a good starting point

def parse_input(input_data="input.txt"):
    with open(input_data, 'r') as file:
        lines = file.readlines()
    return lines


def part_one(input_data):
    return 0


def part_two(input_data):
    return 0


def test_solution(func, input_data, result):
    GREEN = "\033[92m"
    RED = "\033[91m"
    RESET = "\033[0m"
    example_input_data = parse_input(input_data)
    expected_output = result
    actual_output = func(example_input_data)

    if actual_output == expected_output:
        print(f"Test for {func.__name__} - {GREEN}PASSED{RESET}: expected {actual_output}, got {actual_output}")
    else:
        print(f"Test for {func.__name__} - {RED}FAILED{RESET}: expected {expected_output}, got {actual_output}")


if __name__ == "__main__":
    input_data = parse_input()
    test_solution(part_one, "example.txt", 0)
    print(f"Part 1 = {part_one(input_data)}")
    test_solution(part_two, "example.txt", 0)
    print(f"Part 2 = {part_two(input_data)}")

testing

there are two tests for part one and part two that will expect a sepperate input file for each.

example_part_{one/two}.txt

the test functions will require the user to send the expected output for these. Since the examples for each problem comes with a expected result this is a very good way to run the basic case and establish the base functionallity before attempting the personalized input. Right now they need to be updated in the source with the expected results.

setup_day.sh

this is a very simple nice-to-have helper for setting up all expected entrypoints and directories for a given day / problem

to setup the boilerplate, for example for day10 I would call it like so:

./setup_day.sh 10

running

I have been running everything with python3 doing direct interpertation of the source file,

example:

python3 main.py