Simple Models for Python
Project description
============
Simple Model
============
.. image:: https://travis-ci.org/lamenezes/simple-model.svg?branch=master
:target: https://travis-ci.org/lamenezes/simple-model
.. image:: https://coveralls.io/repos/github/lamenezes/simple-model/badge.svg?branch=master
:target: https://coveralls.io/github/lamenezes/simple-model?branch=master
.. image:: https://badge.fury.io/py/pysimplemodel.svg
:target: https://badge.fury.io/py/pysimplemodel
*SimpleModel* offers a simple way to handle data using classes instead of a
plenty of lists and dicts.
It has simple objectives:
- Define your fields easily (just a tuple, nor dicts or instances of type classes whatever)
- Support for field validation
- Conversion to dict
That's it. If you want something more complex there are plenty of libraries and
frameworks that does a lot of cool stuff.
.. contents:: **Table of Contents**
--------------
How to install
--------------
.. code:: shell
pip install pysimplemodel
-----------
1.0 Roadmap
-----------
Support:
1. field definition inside Meta class and not the inside the model
(as currently it is)
2. typing + default values via type hints
3. simplified changelog
4. model inheritance
5. (maybe) proper docs
----------
How to use
----------
.. code:: python
from simple_model import Model
from simple_model.exceptions import ValidationError
class Person(Model):
fields = ('name', 'age', 'height', 'weight')
allow_empty = ('height', 'weight')
def validate_age(self, value):
if 0 > value > 150:
raise ValidationError
def validate_height(self, value):
if value <= 0:
raise ValidationError
.. code:: python
>> person = Person(name='John Doe', age=18)
>> person.name
'John Doe'
>> person.validate()
>> dict(person)
{'name': 'John Doe', 'age': 18, 'height': '', 'weight': ''}
Validation
----------
Model values aren't validated until the `validated` method is called:
.. code:: python
>> person = Person() # no exception
>> person.validate()
...
EmptyField: name field cannot be empty
>> person = Person(name='Jane Doe', age=60)
>> person.validate() # now it's ok!
You may change the validate method to return a boolean instead of raising an
exception:
.. code:: python
>> person = Person()
>> person.validate(raise_exception=False)
False
>>> person = Person(name='Jane Doe', age=60)
>>> person.validate(raise_exception=False)
True
Cleaning
--------
Sometimes it is necessary to clean some values of your models, this can be
easily done using simple-model:
.. code:: python
class CleanPerson(Model):
fields = ('name', 'age')
def clean_name(self, value):
return value.strip()
def clean_age(self, value):
return int(value)
>> person = CleanPerson(name='John Doe \n', age='10')
>> person.name, person.age
('John Doe \n', '10')
>> person.clean()
>> person.name, person.age
('John Doe', 10)
Build many models
-----------------
It's possible to build many models in a single step, it can be done by passing an iterable
to the `build_many` method.
.. code:: python
people = [{'name': 'John Doe'}, {'name': 'John Doe II'}]
models = Person.build_many(people)
Conversion to Dict
------------------
To convert to dict is pretty straight-forward task:
.. code:: python
>> person = Person(name='Jane Doe', age=60)
>> dict(person)
{'age': 60, 'height': None, 'name': 'Jane Doe', 'weight': None}
Simple model also supports dict conversion of nested models:
.. code:: python
class SocialPerson(Model):
fields = ('name', 'friend')
>> person = Person(name='Jane Doe', age=60)
>> other_person = SocialPerson(name='John Doe', friend=person)
>> dict(other_person)
{'friend': {'age': 60, 'height': None, 'name': 'Jane Doe', 'weight': None}, 'name': 'John Doe'}
It also supports nested models as lists:
.. code:: python
class MoreSocialPerson(Model):
fields = ('name', 'friends')
>> person = Person(name='Jane Doe', age=60)
>> other_person = Person(name='John Doe', age=15)
>> social_person = MoreSocialPerson(name='Foo Bar', friends=[person, other_person])
>> dict(social_person)
{
'name': 'Foo Bar',
'friends': [
{
'age': 60,
'height': None,
'name': 'Jane Doe',
'weight': None
},
{
'age': 15,
'height': None,
'name': 'John Doe',
'weight': None
}
]
}
Simple Model
============
.. image:: https://travis-ci.org/lamenezes/simple-model.svg?branch=master
:target: https://travis-ci.org/lamenezes/simple-model
.. image:: https://coveralls.io/repos/github/lamenezes/simple-model/badge.svg?branch=master
:target: https://coveralls.io/github/lamenezes/simple-model?branch=master
.. image:: https://badge.fury.io/py/pysimplemodel.svg
:target: https://badge.fury.io/py/pysimplemodel
*SimpleModel* offers a simple way to handle data using classes instead of a
plenty of lists and dicts.
It has simple objectives:
- Define your fields easily (just a tuple, nor dicts or instances of type classes whatever)
- Support for field validation
- Conversion to dict
That's it. If you want something more complex there are plenty of libraries and
frameworks that does a lot of cool stuff.
.. contents:: **Table of Contents**
--------------
How to install
--------------
.. code:: shell
pip install pysimplemodel
-----------
1.0 Roadmap
-----------
Support:
1. field definition inside Meta class and not the inside the model
(as currently it is)
2. typing + default values via type hints
3. simplified changelog
4. model inheritance
5. (maybe) proper docs
----------
How to use
----------
.. code:: python
from simple_model import Model
from simple_model.exceptions import ValidationError
class Person(Model):
fields = ('name', 'age', 'height', 'weight')
allow_empty = ('height', 'weight')
def validate_age(self, value):
if 0 > value > 150:
raise ValidationError
def validate_height(self, value):
if value <= 0:
raise ValidationError
.. code:: python
>> person = Person(name='John Doe', age=18)
>> person.name
'John Doe'
>> person.validate()
>> dict(person)
{'name': 'John Doe', 'age': 18, 'height': '', 'weight': ''}
Validation
----------
Model values aren't validated until the `validated` method is called:
.. code:: python
>> person = Person() # no exception
>> person.validate()
...
EmptyField: name field cannot be empty
>> person = Person(name='Jane Doe', age=60)
>> person.validate() # now it's ok!
You may change the validate method to return a boolean instead of raising an
exception:
.. code:: python
>> person = Person()
>> person.validate(raise_exception=False)
False
>>> person = Person(name='Jane Doe', age=60)
>>> person.validate(raise_exception=False)
True
Cleaning
--------
Sometimes it is necessary to clean some values of your models, this can be
easily done using simple-model:
.. code:: python
class CleanPerson(Model):
fields = ('name', 'age')
def clean_name(self, value):
return value.strip()
def clean_age(self, value):
return int(value)
>> person = CleanPerson(name='John Doe \n', age='10')
>> person.name, person.age
('John Doe \n', '10')
>> person.clean()
>> person.name, person.age
('John Doe', 10)
Build many models
-----------------
It's possible to build many models in a single step, it can be done by passing an iterable
to the `build_many` method.
.. code:: python
people = [{'name': 'John Doe'}, {'name': 'John Doe II'}]
models = Person.build_many(people)
Conversion to Dict
------------------
To convert to dict is pretty straight-forward task:
.. code:: python
>> person = Person(name='Jane Doe', age=60)
>> dict(person)
{'age': 60, 'height': None, 'name': 'Jane Doe', 'weight': None}
Simple model also supports dict conversion of nested models:
.. code:: python
class SocialPerson(Model):
fields = ('name', 'friend')
>> person = Person(name='Jane Doe', age=60)
>> other_person = SocialPerson(name='John Doe', friend=person)
>> dict(other_person)
{'friend': {'age': 60, 'height': None, 'name': 'Jane Doe', 'weight': None}, 'name': 'John Doe'}
It also supports nested models as lists:
.. code:: python
class MoreSocialPerson(Model):
fields = ('name', 'friends')
>> person = Person(name='Jane Doe', age=60)
>> other_person = Person(name='John Doe', age=15)
>> social_person = MoreSocialPerson(name='Foo Bar', friends=[person, other_person])
>> dict(social_person)
{
'name': 'Foo Bar',
'friends': [
{
'age': 60,
'height': None,
'name': 'Jane Doe',
'weight': None
},
{
'age': 15,
'height': None,
'name': 'John Doe',
'weight': None
}
]
}
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pysimplemodel-0.15.0.tar.gz
(5.4 kB
view details)
File details
Details for the file pysimplemodel-0.15.0.tar.gz.
File metadata
- Download URL: pysimplemodel-0.15.0.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 724902f55a5d7f03751146743a12fe4810c339d8578a5ba6ecee0c09128a3f99 |
|
| MD5 | fa9927fdae2952e00b77c4a2b85c8461 |
|
| BLAKE2b-256 | f63d31a4b1a5eb871498c6fd63bfef6f286a68b9785c321cb33c3457c3694541 |
