Skip to main content

pymongodm

Project description

# pymongodm

pymongodm is a odm respecting pymongo functionality and adds functionality such as model validation.

change your current orm by pymongodb.

Before:

![Imgur](http://i.imgur.com/8TTqJ9h.jpg)


After:

![Imgur](http://i.imgur.com/NDna9Wp.jpg)

https://pypi.python.org/pypi/pymongodm

## install
```
pip install pymongodm
```


## connect db
```python
import pymongodm


pymongodm.connect('name_db')
```

or

```python
import pymongodm
import pymongo

db = pymongo.MongoClient()['name_db']
pymongodm.connect(db)
```

## use db
```python
import pymongodm

pymongodm.connect('example_db')

# Identical to pymongo
pymongodm.db.nice_collection.insert({'name': 'pepis'})
print(pymongodm.db.nice_collection.find_one())
```

## use models!

# In version 2.0.0 change schema validator to cerberus (http://python-cerberus.org)

```python
import pymongodm
pymongodm.connect("gstudio")

from pymongodm.models import Base


class User(Base):
schema = {"name": {'type': 'string'},
"other": {'type': 'list', 'required': False}}
# optional, default is class_name + s
collection_name = "random_name"

def cut_name(self):
return self.name[:3]

# insert
result = User({'name': 'pepito'})
print("id in db", result._id)

# convert dict to object Model

a = User({'_id': result._id, 'name': result.name})
b = User(result.getattrs()) # get attrs return only db attrs
b = User(result.get_clean()) # not return except arguments (exclude_view )

# convert result finds to model
results = pymongodm.db.users.find().model(User)
# or
results = User.collect.find().model(User)
# or
result = User(id)

for result in results:
print(result._id)
print(result.name)
print(result.cut_name())


# Modify values
results = pymongodm.db.users.find().model(User)
for result in results:
result.name = "Pymongodm_%s" % result.name
result.other = ["random", "info"]
result.update()

# Remove
result.remove()

```


### Models options
#### use other collection
by default the name of the collection is the name of the class + s.
It can be changed with the following argument:
collection = "encoding_profiles"

#### hidden arguments in returns
exclude_view = ['name']

## Rewrite basic methods
Only need declare identic name in your class

```python

class User(Base):
schema = {"name": {'type': 'string'},
"other": {'type': 'list', 'required': False}}
# optional, default is class_name + s
collection_name = "random_name"

def remove(self):
print("uhm ...")
```

# Plugins

## create new Plugins

```python
from pymongodm.models.plugins import Plugin


class new_schemaValidation(Plugin):
def __check(self, query):
print(query.fields) # all values
return {'success': False,
'errors': {'example': 'yep'}}

def pre_create(self, query):
return self.__check(query)

def pre_update(self, query):
return self.__check(query)

def post_create(self, query):
pass

def post_update(self, query):
pass
```

## use new plugin
```python
class User(Base):
plugins = [new_schemaValidation]
schema = {"name": {'type': 'string'},
"other": {'type': 'list', 'required': False}}
```


- 2.0.2 (24-03-2017)
- support unset

- 2.0.1 (6-02-2017)
- Hack support ObjectId
- Fix minor bugs

- 2.0.0 (29-12-2016)
- (!!) Changed validation system to cerberus (http://python-cerberus.org) check README.md

- 1.0.8 (12-12-2016)
- Support insert id by create method

- 1.0.7 (03-12-2016)
- Avoid recursive validation (inspect_recursive=False)

- 1.0.6 (10-11-2016)
- Fix .model in find method

- 1.0.5 (05-10-2016)
- Fix remove item

- 1.0.4 (29-9-2016)
- support custom_id

- 1.0.3 (28-9-2016)
- automatic creation

# 1.0.2 (18-7-2016)
- add method insert()

# 1.0.1 (12-7-2016)
- remove prints

# 1.0.0 (12-7-2016)
- auto_get = True
- disable automatic discover cache
- if you use auto_get = False must make a .get() to get the data in the class
- Add support Python 2

# 0.1.0 (11-7-2016)
- Add collect property

# 0.0.5 (11-7-2016)
- fix require=False and value None

# 0.0.4 (6-6-2016)
- Update readme

# 0.0.3 (6-6-2016)
- Update readme
- Fix minor bugs

# 0.0.2 (3-6-2016)
- Fix pip install

# 0.0.1 (3-6-2016)
- Initial version

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

pymongodm-2.0.2.tar.gz (5.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page