Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onyb/reobject
Python without ifs and buts - an ORM layer for Python objects, inspired by Django
https://github.com/onyb/reobject
design-patterns django-orm models object-oriented-programming python
Last synced: 7 days ago
JSON representation
Python without ifs and buts - an ORM layer for Python objects, inspired by Django
- Host: GitHub
- URL: https://github.com/onyb/reobject
- Owner: onyb
- License: apache-2.0
- Created: 2017-01-20T22:36:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-26T00:52:15.000Z (over 3 years ago)
- Last Synced: 2024-10-14T09:47:09.987Z (20 days ago)
- Topics: design-patterns, django-orm, models, object-oriented-programming, python
- Language: Python
- Homepage:
- Size: 134 KB
- Stars: 81
- Watchers: 8
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - reobject - Python without ifs and buts - an ORM layer for Python objects, inspired by Django (Python)
README
# reobject
[](https://travis-ci.org/onyb/reobject)
[](https://badge.fury.io/py/reobject)
[](https://pypi.python.org/pypi/reobject)
[](https://codecov.io/gh/onyb/reobject)
*reobject* is an ORM layer for your objects. It allows you to track and query
objects at runtime using a familiar query langauge inspired by Django ORM.
**Note:** *reobject* is **NOT** a database ORM. It keeps track of regular objects in the memory.
**This is highly experimental code, and not safe for production.**
### Installation
*reobject* supports Python 3 only.
```sh
pip install reobject
```
### Example usage
```py3
from reobject.models import Model, Field
class Book(Model):
title = Field()
authors = Field()
price = Field()
>>> # Create a bunch of objects
>>> Book(title='The C Programming Language', authors=['Kernighan', 'Ritchie'], price=52)
>>> Book(title='The Go Programming Language', authors=['Donovan', 'Kernighan'], price=30)
>>> Book.objects.all() # All books
[Book(title='The C Programming Language', authors=['Kernighan', 'Ritchie'], price=52),
Book(title='The Go Programming Language', authors=['Donovan', 'Kernighan'], price=30)]
>>> Book.objects.filter(price__lt=50).values('title') # Titles of books priced under $50
[{'title': 'The Go Programming Language'}, {'title': 'The C Programming Language'}]
>>> # Titles of books co-authored by Brian Kernighan
>>> Book.objects.filter(authors__contains='Kernighan').values_list('title', flat=True)
['The Go Programming Language', 'The C Programming Language']
```
### Features
* Elegant data-model syntax inspired by Django ORM.
* Class-level model fields, out of the box object protocols, pretty reprs; powered by [attrs](http://attrs.org).
* Advanced query language and chainable querysets. Read the [QuerySet API docs](https://anirudha.co/reobject).
* Transactions. See [example](tests/unit/test_transaction.py#L7-L13).
* Many-to-one model relationships. See [example](tests/unit/test_manager.py#L61-L108)
* [TBA] Attribute indexes for fast lookups.
### Crunching Design Patterns
| Pattern | Description | Pure Python | reobject |
|:-------------:|:--------------------------------------------------------:|:--------:|:-----------:|
| Flyweight | Reuse existing instances of objects with identical state | [Link](https://github.com/faif/python-patterns/blob/master/structural/flyweight.py) | [Link](examples/flyweight.py) |
| Memento | Transactional rollback of an object to a previous state in case of an exception | [Link](https://github.com/faif/python-patterns/blob/master/behavioral/memento.py) | [Link](tests/unit/test_transaction.py) |
| Prototype | Create clones of a prototype without instantiation | [Link](https://github.com/faif/python-patterns/blob/master/creational/prototype.py) | [Link](examples/prototype.py) |
| Singleton | Restrict a class to provide only a single instance | [Link](http://python-3-patterns-idioms-test.readthedocs.io/en/latest/Singleton.html) | [Link](examples/singleton.py) |
| Facade | Encapsulate a complex subsystem within a single interface object | [Link](https://github.com/faif/python-patterns/blob/master/structural/facade.py) | [Link](examples/facade.py) |
| Flux | Event-driven state management inspired by Facebook Flux | [Link](https://github.com/onyb/python-flux/blob/master/flux/store.py) | [Link](examples/flux.py) |
Note: Some of the examples above may be inaccurate. The idea is to demonstrate what reobject is capable of. Pull requests are most welcome.
### Contributing
Want to help? You can contribute to the project by:
* Using reobject in your projects, finding bugs, and proposing new features.
* Sending pull requests with recipes built using reobject.
* Trying your hand at some [good first bugs](https://github.com/onyb/reobject/issues?q=is%3Aissue+is%3Aopen+label%3Abitesize).
* Improving test coverage, and writing documentation.