| Name | bepatient-db JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | Plugin for the 'bepatient' library adding database support. |
| upload_time | 2023-11-15 13:29:43 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Dawid Szaniawski 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. |
| keywords |
api
async
api_testing
automation
database
json
mysql
postgresql
sql
sqlite
testing
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/dawid-szaniawski/bepatient-db/actions/workflows/tox.yml)
[](https://pypi.org/project/bepatient-db/)
[](https://pypi.org/project/bepatient-db/)
[](https://github.com/dawid-szaniawski/bepatient-db/blob/master/LICENSE)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
[](https://codecov.io/github/dawid-szaniawski/bepatient-db)
[](https://www.codefactor.io/repository/github/dawid-szaniawski/bepatient-db)
# bepatient-db
Plugin for the `bepatient` library adding database support.
It enables the repeated execution of database queries while waiting for a specific
condition to be met.
## Supported databases:
- PostgreSQL,
- MySQL,
- SQLite.
## Installation
To install _bepatient-db_, you can use pip:
```bash
pip install bepatient-db
```
_bepatient_ supports Python 3.10+
## Usage
First and foremost, we need to configure the database connection. `SQLWaiter` utilizes
the `Cursor` object of supported databases. Data returned by the `Cursor` should be in
the format of a list of dictionaries (`list[dict]`) or a dictionary (`dict`).
Each of the supported databases allows for such configuration.
### SQLite example
```python
import sqlite3
from flask import current_app, g
def dict_factory(cur, row):
fields = [column[0] for column in cur.description]
return dict(zip(fields, row))
def get_db():
if 'db' not in g:
g.db = sqlite3.connect(
current_app.config['DATABASE'],
detect_types=sqlite3.PARSE_DECLTYPES
)
g.db.row_factory = dict_factory
return g.db
def close_db(e=None):
db = g.pop('db', None)
if db is not None:
db.close()
```
With the `Cursor` configured in this way, we can use `SQLWaiter` to repeatedly execute
queries until we receive the desired data or reach a predefined number of attempts.
Database: `user`
| id | name |
|----|-------|
| 1 | Bob |
| 2 | Jerry |
| 3 | Matt |
```python
from sqlite3 import Cursor
from bepatient_db import SQLWaiter
def wait_for_user(cursor: Cursor) -> list[dict[str, str]]:
waiter = SQLWaiter(cursor=cursor, query="SELECT name FROM user")
waiter.add_checker(
expected_value="Bob", comparer="is_equal", dict_path="0.name"
)
return waiter.run(retries=1).get_result()
```
Output:
```python
[
{"name": "Bob"},
{"name": "Jerry"},
{"name": "Matt"},
]
```
## License
MIT License
Copyright (c) 2023 Dawid Szaniawski
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "bepatient-db",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "api,async,api_testing,automation,database,json,mySQL,postgreSQL,SQL,SQLite,testing,web",
"author": "",
"author_email": "Dawid Szaniawski <webluduspl@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/16/08/7c4bd55c29f47bfcc33aabeff0efc3d2e7ea1118f5333e15becd20316d8f/bepatient-db-0.3.0.tar.gz",
"platform": null,
"description": "[](https://github.com/dawid-szaniawski/bepatient-db/actions/workflows/tox.yml)\n[](https://pypi.org/project/bepatient-db/)\n[](https://pypi.org/project/bepatient-db/)\n[](https://github.com/dawid-szaniawski/bepatient-db/blob/master/LICENSE)\n[](https://github.com/psf/black)\n[](https://github.com/astral-sh/ruff)\n[](https://codecov.io/github/dawid-szaniawski/bepatient-db)\n[](https://www.codefactor.io/repository/github/dawid-szaniawski/bepatient-db)\n\n# bepatient-db\n\nPlugin for the `bepatient` library adding database support.\nIt enables the repeated execution of database queries while waiting for a specific\ncondition to be met.\n\n## Supported databases:\n\n- PostgreSQL,\n- MySQL,\n- SQLite.\n\n## Installation\n\nTo install _bepatient-db_, you can use pip:\n\n```bash\npip install bepatient-db\n```\n\n_bepatient_ supports Python 3.10+\n\n## Usage\n\nFirst and foremost, we need to configure the database connection. `SQLWaiter` utilizes\nthe `Cursor` object of supported databases. Data returned by the `Cursor` should be in\nthe format of a list of dictionaries (`list[dict]`) or a dictionary (`dict`).\nEach of the supported databases allows for such configuration.\n\n### SQLite example\n\n```python\nimport sqlite3\n\nfrom flask import current_app, g\n\n\ndef dict_factory(cur, row):\n fields = [column[0] for column in cur.description]\n return dict(zip(fields, row))\n\n\ndef get_db():\n if 'db' not in g:\n g.db = sqlite3.connect(\n current_app.config['DATABASE'],\n detect_types=sqlite3.PARSE_DECLTYPES\n )\n g.db.row_factory = dict_factory\n\n return g.db\n\n\ndef close_db(e=None):\n db = g.pop('db', None)\n\n if db is not None:\n db.close()\n```\n\nWith the `Cursor` configured in this way, we can use `SQLWaiter` to repeatedly execute\nqueries until we receive the desired data or reach a predefined number of attempts.\n\n\n\nDatabase: `user`\n\n| id | name |\n|----|-------|\n| 1 | Bob |\n| 2 | Jerry |\n| 3 | Matt |\n\n\n```python\nfrom sqlite3 import Cursor\n\nfrom bepatient_db import SQLWaiter\n\n\ndef wait_for_user(cursor: Cursor) -> list[dict[str, str]]:\n waiter = SQLWaiter(cursor=cursor, query=\"SELECT name FROM user\")\n waiter.add_checker(\n expected_value=\"Bob\", comparer=\"is_equal\", dict_path=\"0.name\"\n )\n return waiter.run(retries=1).get_result()\n```\n\nOutput:\n\n```python\n[\n {\"name\": \"Bob\"},\n {\"name\": \"Jerry\"},\n {\"name\": \"Matt\"},\n]\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2023 Dawid Szaniawski\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Dawid Szaniawski 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. ",
"summary": "Plugin for the 'bepatient' library adding database support.",
"version": "0.3.0",
"project_urls": {
"Source": "https://github.com/dawid-szaniawski/bepatient-db"
},
"split_keywords": [
"api",
"async",
"api_testing",
"automation",
"database",
"json",
"mysql",
"postgresql",
"sql",
"sqlite",
"testing",
"web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43679fc0ca4e70ebf71c54e461e66cd9cc64a7d4328385d26de104a258234eb7",
"md5": "6cc84ef5505f9c85b450340d4b078007",
"sha256": "794357f230e2fe76f0a6d67cfe44bcc3c23270e4f47615a7ce77e910088e3e8c"
},
"downloads": -1,
"filename": "bepatient_db-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cc84ef5505f9c85b450340d4b078007",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7831,
"upload_time": "2023-11-15T13:29:42",
"upload_time_iso_8601": "2023-11-15T13:29:42.655335Z",
"url": "https://files.pythonhosted.org/packages/43/67/9fc0ca4e70ebf71c54e461e66cd9cc64a7d4328385d26de104a258234eb7/bepatient_db-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "16087c4bd55c29f47bfcc33aabeff0efc3d2e7ea1118f5333e15becd20316d8f",
"md5": "abe5775b413564fcdb04496cf7c86e6d",
"sha256": "ba22f1fad82f143461b8cf18696a2036d2b605b85dbc80673a7b27fb9fb93fa5"
},
"downloads": -1,
"filename": "bepatient-db-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "abe5775b413564fcdb04496cf7c86e6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10671,
"upload_time": "2023-11-15T13:29:43",
"upload_time_iso_8601": "2023-11-15T13:29:43.756661Z",
"url": "https://files.pythonhosted.org/packages/16/08/7c4bd55c29f47bfcc33aabeff0efc3d2e7ea1118f5333e15becd20316d8f/bepatient-db-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 13:29:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dawid-szaniawski",
"github_project": "bepatient-db",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bepatient-db"
}
