API Reference

Utility Functions

class relatives.utils.GenericObjects(_object)

Search GenericForeignKey over all models and returns related objects if has relations with given object.

class relatives.utils.RelatedObject(field, ct_pk)

Generates fake django RelatedObject

relatives.utils.get_admin_url(obj)

Return admin URL for given object (raise NoReverseMatch on error)

Return function that takes an object and returns admin link to object

Arguments:

  • edit_text is displayed in link text
  • blank_text is displayed in unlinked text (when no admin link)

edit_text defaults to the object’s unicode representation and blank_text defaults to the object’s unicode representation if edit_text is None and an empty string otherwise

Return admin link to given object or blank text if no link

Equivalent to object_edit_link()(obj)

Template Tags

Return field contents or link to related object if foreign key field

Example Usage:

{% load relatives %}
{{ field|contents_or_fk_link }}
relatives.templatetags.relatives.related_objects(obj)

Return list of objects related to the given model instance

Example Usage:

{% load relatives %}
{% related_objects obj as related_objects %}
{% for related_obj in related_objects %}
    <a href="{{ related_obj.url }}">{{ related_obj.plural_name }}</a>
{% endfor %}