Downloads puzzle inputs for Advent of Code and synthesizes PyTest fixtures
Project description
pytest-aoc
This pytest plugin downloads puzzle inputs for Advent of Code and synthesizes fixtures that you can use in your tests.
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 setup.cfg
:
[tool:pytest]
aoc_year = 2018
Then, put a valid session ID in a file named .cookie
and also name this file
in your .gitignore
.
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.
Using
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 input/day01.txt
.
Fixtures
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. ~"spam"
-
dayNN_raw
: The raw text in the input file. ~"eggs\n"
-
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. ~5
-
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
/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
/aoc_session_file
: The file from which to read the session ID. (Optional; default.cookie
)--aoc-input-dir
/aoc_input_dir
: The directory in which inputs are stored. Will be created if it doesn't exist. (Optional; defaultinput
)
Developing / testing
Set environment variables using . .envrc
or by automatically loading them
using direnv allow
.
Create a virtualenv named env
and install/upgrade basic packaging
dependencies:
python -m venv
pip install pip setuptools wheel setuptools-version-command twine
Install this package in editable mode with all extra dev
dependencies:
pip install -e .[dev]
Run tests:
pytest
Releasing
This package is currently using [setuptools-version-command][svc] to derive
the version number from the Git tags using git describe
.
Tag the release version (or it will be a post-release on a previous version),
where x.y.z
is the version:
git tag -a x.y.z
Check that the version is actually sane:
./setup.py --version
Bake an sdist and a wheel into a clean dist
directory:
rm -f dist/*
./setup.py sdist bdist_wheel
Upload the goods to PyPI:
twine upload dist/*
Upload the goods to Github, where again x.y.z
is the version:
git push github master --tags
gh release create x.y.z --title $(env/bin/python -m setup --version) --prerelease
gh release upload x.y.z dist/*
(Leave out the --prerelease
flag as necessary.)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest_aoc-1.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a595da84be28d42f8efec994eb673eba9f622309a6330526463f3ffe2a7a9d0a |
|
MD5 | 15c93a31b3c3857c20be0130e8fd5a37 |
|
BLAKE2b-256 | e780f04f87fa51c3ce617e455f0553648cebee00dadf7e547328fb4ab4258f88 |