Hypothesis DRF
Project description
[Hypothesis](https://github.com/HypothesisWorks/hypothesis-python) strategy for
[Django REST framework](http://www.django-rest-framework.org/) serializers.
Generate data that is valid according to a DRF serializer
### Known issues
* Only tested with python3.6
* `URLField` can be slow when generating the first example
* `*RelatedField` gets first object in queryset, not random
* Not all fields are supported, known non-working:
- FileField
- FilePathField
- ImageField
- ModelField
### Example
```bash
pip install hypothesis-drf
```
```python
from hypothesis_drf import from_serializer, from_field
from rest_framework import serializers
class ExampleSerializer(serializers.Serializer):
name = serializers.CharField(min_length=3, max_length=8)
amount = serializers.IntegerField(min_value=200, max_value=500)
from_serializer(ExampleSerializer).example()
# {'amount': 391, 'name': '\U00053a6b&\U00030fee$.'}
from_field(serializers.FloatField(min_value=-10, max_value=22)).example()
# -8.499125311228873
```
For HyperLinkedRelatedField (and variants) you must pass an instantiated serializer as
they require access to the request via context:
```python
from hypothesis_drf import from_serializer
class RelatedExample(serializers.ModelSerializer):
class Meta:
model = SourceModel
fields = ('target', )
target = HyperLinkedRelatedField(queryset=TargetModel.objects.all())
from_serializer(RelatedExample(context={'request': request})).example()
# {'target': 'http://example.com/something/'}
```
### Custom fields
Provide `hypothesis_strategy` on the field:
```python
from rest_framework import fields
from hypothesis import strategies as st
class MyField(fields.Field):
hypothesis_strategy = st.booleans()
# ...
```
[Django REST framework](http://www.django-rest-framework.org/) serializers.
Generate data that is valid according to a DRF serializer
### Known issues
* Only tested with python3.6
* `URLField` can be slow when generating the first example
* `*RelatedField` gets first object in queryset, not random
* Not all fields are supported, known non-working:
- FileField
- FilePathField
- ImageField
- ModelField
### Example
```bash
pip install hypothesis-drf
```
```python
from hypothesis_drf import from_serializer, from_field
from rest_framework import serializers
class ExampleSerializer(serializers.Serializer):
name = serializers.CharField(min_length=3, max_length=8)
amount = serializers.IntegerField(min_value=200, max_value=500)
from_serializer(ExampleSerializer).example()
# {'amount': 391, 'name': '\U00053a6b&\U00030fee$.'}
from_field(serializers.FloatField(min_value=-10, max_value=22)).example()
# -8.499125311228873
```
For HyperLinkedRelatedField (and variants) you must pass an instantiated serializer as
they require access to the request via context:
```python
from hypothesis_drf import from_serializer
class RelatedExample(serializers.ModelSerializer):
class Meta:
model = SourceModel
fields = ('target', )
target = HyperLinkedRelatedField(queryset=TargetModel.objects.all())
from_serializer(RelatedExample(context={'request': request})).example()
# {'target': 'http://example.com/something/'}
```
### Custom fields
Provide `hypothesis_strategy` on the field:
```python
from rest_framework import fields
from hypothesis import strategies as st
class MyField(fields.Field):
hypothesis_strategy = st.booleans()
# ...
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hypothesis-drf-1.0.0.tar.gz
(8.5 kB
view details)
Built Distribution
File details
Details for the file hypothesis-drf-1.0.0.tar.gz
.
File metadata
- Download URL: hypothesis-drf-1.0.0.tar.gz
- Upload date:
- Size: 8.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f05d4c1b93627c237585b7988de7f02b900aa02494d197adb025dc3e77faa90e |
|
MD5 | e243801a97d3a10bf038dbdb998b3697 |
|
BLAKE2b-256 | 69933a61da055b8a2f7fb5c5ca0d3bbf701713360ede472071a1e891de45d15d |
File details
Details for the file hypothesis_drf-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: hypothesis_drf-1.0.0-py3-none-any.whl
- Upload date:
- Size: 6.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cff9a2d3878aa4a4414a852e7f0006c4839e3fabae45b897fb07cec361dfd2a4 |
|
MD5 | 5f53a5bfe2a03a6afab49d9a0285f35f |
|
BLAKE2b-256 | b9bdcbdbcf1d59c690540ebeae69e82207817b6a6ca119b230d59e1f18bdf4ec |