aio-libs/multidict

[TODO] Replace `tests/gen_pickles.py` with a pytest plugin

Open

#922 opened on Jan 16, 2024

View on GitHub
 (13 comments) (2 reactions) (1 assignee)Python (130 forks)auto 404
Hacktoberfestenhancementgood first issuehelp wanted

Repository metrics

Stars
 (491 stars)
PR merge metrics
 (PR metrics pending)

Description

The idea is simple:

  • Make a session-scoped fixture in tests/conftest.py
  • Move the logic from gen_pickles.py there and generate the pickles in a tmppath-provided dir
  • Integrate that into the pickling tests
  • Delete tests/gen_pickles.py and the pickle files in the tests/ dir
  • Bonus points: keep pickles in-memory, so they don't hit the disk
  • Bonus 2: check if a session fixture is needed and switch to the normal function scope, if not

Contributor guide

Research direction
Read `tests/gen pickles.py` and understand the pickle generation logic. Learn about pytest fixtures, especially session scoped ones and conftest.py. Then move the logic into a fixture in conftest.py, integrate with existing tests, and finally remove the old script and pickle files.
Tech stack
python
Domain
testing
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonpytest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75