https://github.com/magopian/django-inspect-model
Model inspection for Django
https://github.com/magopian/django-inspect-model
Last synced: about 1 month ago
JSON representation
Model inspection for Django
- Host: GitHub
- URL: https://github.com/magopian/django-inspect-model
- Owner: magopian
- License: bsd-3-clause
- Created: 2011-06-01T12:33:13.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2018-03-08T16:51:33.000Z (over 7 years ago)
- Last Synced: 2025-09-30T13:26:26.355Z (about 2 months ago)
- Language: Python
- Homepage: http://django-inspect-model.rtfd.org
- Size: 238 KB
- Stars: 28
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
Django-inspect-model
====================
.. image:: https://secure.travis-ci.org/magopian/django-inspect-model.png?branch=master
:alt: Build Status
:target: https://travis-ci.org/magopian/django-inspect-model
* Authors: Mathieu Agopian and contributors_
* Licence: BSD
* Compatibility: Python 2.6, Python 2.7, Python 3.3, Python 3.4, Django 1.3+
* Requirements: none
* Project URL: https://github.com/magopian/django-inspect-model/
* Documentation: http://django-inspect-model.readthedocs.org/en/latest/
.. _contributors: https://github.com/magopian/django-inspect-model/contributors
Django-inspect-model is a model inspection utility for Django. It allows you to
easily list all available "items" on a model, and get their value.
An item is either:
* a django field (standard field or relation field)
* a standard attribute
* a method that only takes one attribute: 'self'
* a property
The code is generic enough to be applied on just any python object, so Django
isn't a requirement. However, it was tailored towards Django models.
Install
-------
Using pip:
::
pip install django-inspect-model
Usage
-----
Instantiate ``inspect_model.InspectModel`` with your model class or instance, and profit.
::
>>> from django.contrib.comments.models import Comment
>>> from inspect_model import InspectModel
>>> im = InspectModel(Comment)
>>> im.fields
['comment', 'id', 'ip_address', 'is_public', 'is_removed', 'object_pk',
'submit_date', 'user_email', 'user_name', 'user_url']
>>> im.relation_fields
['content_type', 'site', 'user']
>>> im.many_fields
['flags']
>>> im.attributes
[]
>>> im.methods
['get_as_text', 'get_content_object_url']
>>> im.properties
['email', 'name', 'pk', 'url', 'userinfo']
>>> im.items
['comment', 'content_type', 'email', 'flags', 'get_as_text',
'get_content_object_url', u'id', 'ip_address', 'is_public', 'is_removed',
'name', 'object_pk', 'pk', 'site', 'submit_date', 'url', 'user',
'user_email', 'user_name', 'user_url', 'userinfo']
Hacking
=======
Setup your environment:
::
git clone https://github.com/magopian/django-inspect-model.git
cd django-inspect-model
Hack and run the tests using `Tox `_ to test
on all the supported python and Django versions:
::
make test
To build the docs:
::
make docs