معرفی شرکت ها
fastapi-testdb-0.1.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Reproducible SQL database state for testing routines
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi-testdb-0.1.2 |
| نام | fastapi-testdb |
| نسخه کتابخانه | 0.1.2 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Dmitrii Kononenko <dmitriy.sergeevitch@gmail.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/fastapi-testdb/ |
| مجوز | MIT License Copyright (c) 2023 Dmitry Kononenko Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
# fastapi-testdb
[FastAPI](https://https://fastapi.tiangolo.com/) is a cool framework for building
fast and reliable API. It provides various tools to create an app you want. Also
it has convenient way to cover the code with tests. Read the articles for more
details [Testing](https://fastapi.tiangolo.com/tutorial/testing/) and
[Testing a Database](https://fastapi.tiangolo.com/advanced/testing-database/).
It covers the most aspects of testing, but sadly one important thing was left
behind scenes. You have to recreate the database every time before run each test
to make tests *reproducible*, otherwise be ready to get unpredictible results
after every test run.
This package helps you to make database tests reproducible.
## Installation
```shell
pip install fastapi-testdb
```
## Usage
Let's say you have a FastAPI instance `app` with dependency `connect_db` to get a connection
to your database. Your SQLAlchemy ORM base class is `BaseOrm`. Common usage of TestDB for having
repeatable tests:
1) First create a class by call `create_testdb`:
```python
from fastapi_testdb import create_testdb
testdb = create_testdb(app, connect_db, BaseOrm, dsn='sqlite:////tmp/your-testdb.sqlite')
```
`testdb` is your new class type targeted to connect to the test database. In this case it is
an SQLite DB, but you can use other databases - PostgreSQL, MySQL and everything that
supported by SQLAlchemy.
You have to pass `connect_db` because this dependecy must be replaced on a test run for not
to harm you real database.
`BaseOrm` will be used to get metadata when the SQL tables create.
3) Now you can use the new class for creating reproducible DB state:
```python
def test_yourtestfunc():
with testdb() as tdb:
# In this `with` statement a new DB was created and all the tables from
# `BaseOrm.metadata` were initiated. Now you have a completely empty tables in the DB.
# Do your test here:
...
```
### Usage as a decorator
It is also possible to use this as a decorator:
```python
@testdb.initdb
def test_yourtestfunc(tdb):
# A new DB is ready for testing. Do your test below
...
```
### Insert test data
A new DB has created empty. If you have to fill tables with some data, you can use
`prefill_orm` method. For example, let you have an ORM class for users:
```python
class UserDB(BaseOrm):
id: Mapped[int] = mapped_column(primary_key=True, index=True)
name: Mapped[str] = mapped_column(index=True, unique=True)
```
To have some content on testing, call the method `prefill_orm`:
```python
@testdb.initdb
def test_yourtestfunc(tdb):
users_fixture = [
{"id": 1, "name": "Bob"},
{"id": 2, "name": "Henry"},
]
tdb.prefill_orm(UserDB, users_fixture)
# Now you have your users in the table:
with TestClient(app) as client:
client = app.get('/user/1')
assert client.status_code == 200
```
## Contribution
You are welcome to make contribution and proposals for improvement!
نیازمندی
| مقدار | نام |
|---|---|
| >=0.91.0 | fastapi |
| >=2.0.3 | SQLAlchemy |
| - | pytest |
| - | httpx |
| - | pylint |
| - | build |
| - | twine |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl fastapi-testdb-0.1.2:
pip install fastapi-testdb-0.1.2.whl
نصب پکیج tar.gz fastapi-testdb-0.1.2:
pip install fastapi-testdb-0.1.2.tar.gz