Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lycantropos/hypothesis_sqlalchemy
hypothesis strategies for generating SQLAlchemy objects
https://github.com/lycantropos/hypothesis_sqlalchemy
hypothesis quickcheck sqlalchemy testing
Last synced: 5 days ago
JSON representation
hypothesis strategies for generating SQLAlchemy objects
- Host: GitHub
- URL: https://github.com/lycantropos/hypothesis_sqlalchemy
- Owner: lycantropos
- License: mit
- Created: 2017-09-17T02:15:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T17:47:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-06T00:35:05.501Z (about 1 month ago)
- Topics: hypothesis, quickcheck, sqlalchemy, testing
- Language: Python
- Homepage:
- Size: 202 KB
- Stars: 28
- Watchers: 2
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hypothesis_sqlalchemy
=====================
[](https://github.com/lycantropos/hypothesis_sqlalchemy/actions/workflows/ci.yml "Github Actions")
[](https://codecov.io/gh/lycantropos/hypothesis_sqlalchemy "Codecov")
[](https://github.com/lycantropos/hypothesis_sqlalchemy/blob/master/LICENSE "License")
[](https://badge.fury.io/py/hypothesis-sqlalchemy "PyPI")
In what follows `python` is an alias for `python3.7` or `pypy3.7`
or any later version (`python3.8`, `pypy3.8` and so on).
Installation
------------
Install the latest `pip` & `setuptools` packages versions
```bash
python -m pip install --upgrade pip setuptools
```
### User
Download and install the latest stable version from `PyPI` repository
```bash
python -m pip install --upgrade hypothesis_sqlalchemy
```
### Developer
Download the latest version from `GitHub` repository
```bash
git clone https://github.com/lycantropos/hypothesis_sqlalchemy.git
cd hypothesis_sqlalchemy
```
Install dependencies
```bash
python -m pip install -r requirements.txt
```
Install
```bash
python setup.py install
```
Usage
-----
With setup
```python
>>> import warnings
>>> from hypothesis.errors import NonInteractiveExampleWarning
>>> # ignore hypothesis warnings caused by `example` method call
... warnings.filterwarnings('ignore', category=NonInteractiveExampleWarning)
```
let's take a look at what can be generated and how.
### Tables
We can write a strategy that produces tables
```python
>>> from hypothesis_sqlalchemy import scheme
>>> from sqlalchemy.engine.default import DefaultDialect
>>> dialect = DefaultDialect()
>>> tables = scheme.tables(dialect,
... min_size=3,
... max_size=10)
>>> table = tables.example()
>>> from sqlalchemy.schema import Table
>>> isinstance(table, Table)
True
>>> from sqlalchemy.schema import Column
>>> all(isinstance(column, Column) for column in table.columns)
True
>>> 3 <= len(table.columns) <= 10
True
```
### Records
Suppose we have a table
```python
>>> from sqlalchemy.schema import (Column,
... MetaData,
... Table)
>>> from sqlalchemy.sql.sqltypes import (Integer,
... String)
>>> metadata = MetaData()
>>> user_table = Table('user', metadata,
... Column('user_id', Integer,
... primary_key=True),
... Column('user_name', String(16),
... nullable=False),
... Column('email_address', String(60)),
... Column('password', String(20),
... nullable=False))
```
and we can write strategy that
* produces single records (as `tuple`s)
```python
>>> from hypothesis import strategies
>>> from hypothesis_sqlalchemy.sample import table_records
>>> records = table_records(user_table,
... email_address=strategies.emails())
>>> record = records.example()
>>> isinstance(record, tuple)
True
>>> len(record) == len(user_table.columns)
True
>>> all(column.nullable and value is None
... or isinstance(value, column.type.python_type)
... for value, column in zip(record, user_table.columns))
True
```
* produces records `list`s (with configurable `list` size bounds)
```python
>>> from hypothesis_sqlalchemy.sample import table_records_lists
>>> records_lists = table_records_lists(user_table,
... min_size=2,
... max_size=5,
... email_address=strategies.emails())
>>> records_list = records_lists.example()
>>> isinstance(records_list, list)
True
>>> 2 <= len(records_list) <= 5
True
>>> all(isinstance(record, tuple) for record in records_list)
True
>>> all(len(record) == len(user_table.columns) for record in records_list)
True
```
Development
-----------
### Bumping version
#### Preparation
Install
[bump2version](https://github.com/c4urself/bump2version#installation).
#### Pre-release
Choose which version number category to bump following [semver
specification](http://semver.org/).
Test bumping version
```bash
bump2version --dry-run --verbose $CATEGORY
```
where `$CATEGORY` is the target version number category name, possible
values are `patch`/`minor`/`major`.
Bump version
```bash
bump2version --verbose $CATEGORY
```
This will set version to `major.minor.patch-alpha`.
#### Release
Test bumping version
```bash
bump2version --dry-run --verbose release
```
Bump version
```bash
bump2version --verbose release
```
This will set version to `major.minor.patch`.
### Running tests
Install dependencies
```bash
python -m pip install -r requirements-tests.txt
```
Plain
```bash
pytest
```
Inside `Docker` container:
- with `CPython`
```bash
docker-compose --file docker-compose.cpython.yml up
```
- with `PyPy`
```bash
docker-compose --file docker-compose.pypy.yml up
```
`Bash` script:
- with `CPython`
```bash
./run-tests.sh
```
or
```bash
./run-tests.sh cpython
```
- with `PyPy`
```bash
./run-tests.sh pypy
```
`PowerShell` script:
- with `CPython`
```powershell
.\run-tests.ps1
```
or
```powershell
.\run-tests.ps1 cpython
```
- with `PyPy`
```powershell
.\run-tests.ps1 pypy
```