MagicStack / MagicStack/asyncpg
Update documentation to cover testing using pytest
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
Please add a section in your documentation on how to test code that uses pool, fetch, executemany etc using pytest. I could not find anything on stackoverflow or issues where is a slight reference somewhere to TempCluster but no examples whatsoever. Are you supposed to mock this library or create an actual database while testing. Would be super helpful for future readers
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing documentation and the slight TempCluster reference mentioned in the issue. Add pytest guidance and examples for testing pool, fetch, and executemany usage, including the documented choice between mocking and using an actual database.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql, python
- Domain
- databases, documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100