Test examples #510
Test examples #510
Conversation
This allows for src/package layout based tests to import the main package during the unit tests.
Start testing example projects by adding Pytest tests to the Python code itself.
There was a problem hiding this comment.
Thanks for starting these tests! They are going to be a big help to the guide.
I have opened a separate PR to your repo that addresses the knock-on effects of changing examplePy. There is not a good way to see this relationship or when it applies, so don't worry about it. Please merge that change before requesting a new review here.
| from examplePy import temperature, temporal | ||
|
|
||
| # Get the path to the test data directory | ||
| TEST_DATA = pathlib.Path(__file__).parents[0] / "data" |
There was a problem hiding this comment.
For a simple module in the wild, I would be okay with this load, but as we explicitly recommend Python's resources, can you please use importlib.resources to get this csv? https://docs.python.org/3/library/importlib.resources.html
You will have to add an __init__.py to the data dir.
There was a problem hiding this comment.
Quick question - the CSV file is only really used to be able to test the example Python code. Do you still want it in the resources if it won't be included in the built package (due to the src/package example project layout)?
There was a problem hiding this comment.
The CSV file can be included, not in the build project, but in the sdist, with advanced Hatch build options.
https://hatch.pypa.io/1.12/config/build/#explicit-selection
However, I am okay opening a follow-up issue for this and doing it later. There is no urgency here, we are not publishing this package at all.
Probably want to reference/link to this discussion that involves test data
#59
There was a problem hiding this comment.
Thanks for the clarification discussion and Hatch config links. I'll take a look at this and see if I can get it corrected, but I may be slightly delayed by travel.
fixup literalinclude endings
|
Summoning @lwasser: I thought we had recommended |
Begin work on #249 (and #248 to some degree) by adding a few Pytest-based unit tests to the "pure-hatch" example code.
I added some dummy data to use to test the actual "mean" calculations, since I thought a more complex mocking / faking example would probably be out of scope.
Moving forward, I'd like to add the tests to CI and add nox tests for the actual packaging steps.
As this is my first PR for the project, please let me know anything I might need to clean up!