Downloads puzzle inputs for Advent of Code and synthesizes PyTest fixtures
This pytest plugin downloads puzzle inputs for Advent of Code and synthesizes fixtures that you can use in your tests.
Does this DDoS the adventofcode.com website?
This plugin tries pretty hard to not hit the adventofcode.com website unless absolutely necessary. When the test session starts, the puzzle inputs that should be available are calculated based on the system clock. For every input that should be available (after 05:00:00 GMT), if no corresponding text file is found on disk, it gets downloaded and saved, if the HTTP status code is 200 OK.
The personal downloaded puzzle inputs should be committed to source control, so that pytest doesn't need to hit the adventofcode.com API to run the tests in another environment.
New in version 1.22.0: the code also sleeps (2.5 seconds by default) after hitting the server. This can be disabled if you have leaderboard aspirations, but really, do you have time to be practising TDD in that case? (I'll answer that for you: no, you do not.)
Installing and configuring
Installing is easy:
python -m pip install pytest-aoc. Next you will need to configure
two things: for which event (year) the plugin should download inputs, and a
valid session cookie. These are normally valid for about a month or so.
To set the year, put it in
[tool:pytest] aoc_year = 2018
Then, put a valid session ID in a file named
.cookie and also name this file
With these two things in place, when running pytest, this plugin will download any missing inputs, and generate pytest fixtures that you can use in your test functions, see 'Using' and 'Fixtures', below.
With this plugin properly configured, you can write tests like this:
def test_01a(day01_numbers): assert sum(day01_numbers) == 123
Here, the parameter
day01_numbers is a fixture that contains the numbers on
each line in the file
These fixtures are synthesized for each available day. They're not executed until you ask for them in a test.
dayNN_text: The text in the input file, but stripped of any leading and trailing whitespace. ~
dayNN_raw: The raw text in the input file. ~
dayNN_lines: A list of stripped lines. ~
["spam", "eggs", "albatross"]
dayNN_numbers: A list of numbers. ~
[1, 1, 2, 3, 5, 8]
dayNN_number: A single number. ~
dayNN_grid: A list of lists, representing a grid of textual values. ~
[["spam", "eggs"], ["ham", "albatross"]]
dayNN_number_grid: A list of lists, representing a grid of numbers. ~
[[8, 1, 6], [3, 5, 7], [4, 9, 2]]
Command-line and configuration options
You can pass the options from the command line or set them in setup.cfg. The command line takes precedence.
aoc_year: The year for which to download puzzle inputs. (Mandatory)
--aoc-session-id: The session ID to use for requesting puzzle inputs. This one has no equivalent setup.cfg key; that's a security feature. (Optional)
aoc_session_file: The file from which to read the session ID. (Optional; default
aoc_input_dir: The directory in which inputs are stored. Will be created if it doesn't exist. (Optional; default
aoc_sleep_time: Time to sleep after downloading puzzle input, set to
0if you're a hardcore quick-coder, can't miss the default 2.5 seconds, and promise to not DDoS the adventofcode.com website. (Optional, default
Developing / testing
Set environment variables using
. .envrc or by automatically loading them
Create a virtualenv named
env and install an editable version of this package
with all extra development dependencies:
python -m venv env python -m pip install -U -e .[dev,test]
Run tests directly, to test against the current Python, or via tox to test against multiple Python versions:
python -m pytest python -m tox
This package uses setuptools-scm to derive the version from tags in the Git history. I use twine to upload the distribution files to PyPI and github-cli to create releases on GitHub.
The procedure goes like this:
(Optional) Tag the release version (or it will be a dev release on the next version as
x.y.z is the version:
git tag -a x.y.z
Check that the version is actually sane:
python -m setuptools_scm
Bake an sdist and a wheel into a clean
rm -f dist/* python -m build
Upload the goods to PyPI:
python -m twine upload dist/*
Upload the goods to Github, where again
x.y.z is the version:
git push github master --tags gh release create --prerelease x.y.z dist/*
(Leave out the
--prerelease flag as necessary.)
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pytest_aoc-1.22.0-py3-none-any.whl