This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
indicted
=========

indicted - Indexed Document Class

Summary
-------

Find an list element, which is a dict, by a keys value

Usage
-----

Take for example the following data. This structure is being used to reduce
relationships between a parent object and sub objects. This allows us to create
indexes that help with relationships rather than making multiple calls to a
database. This is just an example structure of a document. This specific
structure will benifit heavily from a multi-value index on **subdata._id**.

```javascript
{
"_id" : ObjectId("4f3eb7cac4f804960a859467"),
"subdata" : [
{
"_id" : ObjectId("4f3eb7cac4f804960a859468"),
"bits" : 1234
},
{
"_id" : ObjectId("4f3eb7cac4f804960a859469"),
"bits" : 5678
}
]
}
```

If we access the **subdata** key in the root of this document we will be given
an array when using standard Dict/List types.

```python
[{u'_id': ObjectId('4f3eb7cac4f804960a859468'), u'bits': 1234.0},
{u'_id': ObjectId('4f3eb7cac4f804960a859469'), u'bits': 5678.0}]
```

Ideally we would want to return the list element that matches a specific **_id**
if the list contains dictionaries that have a key matching that ObjectId. This
is where indicted and Inist comes in. InDict is a simple Dict wrapper
that uses InList for all list type values. As InList is initialized and
modified it keeps an internal dictionary of **_id** references relating to list
positions. An extra function called **InList.find** is used to pull out a
referenced object if it finds one. **None** is returned otherwise.

```python
import pprint
import pymongo

from bson import ObjectId

from indicted import InDict

class MongoInDict(InDict):
INDEXCLASS = ObjectId
INDEXKEY = '_id'

connection = pymongo.Connection(document_class=MongoInDict)
database = connection.test

data = database.data.find_one()

pprint.pprint(data['subdata'].find(ObjectId('4f3eb7cac4f804960a859469')))
pprint.pprint(data['subdata'].find(ObjectId('000000000000000000000000')))
```

Yields

```python
{u'_id': ObjectId('4f3eb7cac4f804960a859469'), u'bits': 5678.0}
None
```

There is also **indicted.OrderedInDict** that inherits
**collections.OrderedDict**. This is incredibly useful for maintaining the
document key ordering of your documents.

Status
------

Currently this module only creates references during the initialization of the
list. This will be addressed soon.

Todo
----

* Dot notation
* JSON encoding/decoding/pretty printing helpers
Release History

Release History

0.0.2

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
indicted-0.0.2.tar.gz (3.5 kB) Copy SHA256 Checksum SHA256 Source Nov 2, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting