Module utils

Classes

• class FieldIsAForeignKeyColumnName
  A field is a foreign key attname, i.e. <FK>_id.
• class NestedObjects
• class NotRelationField

Functions

• ▶ def construct_change_message(form, formsets, add)

  Construct a JSON structure describing changes from a changed object. Translations are deactivated so that strings are stored untranslated. Translation happens later on LogEntry access.

  source link

  Reexports

  • Imported in django.contrib.admin.options.
• ▶ def display_for_field(value, field, empty_value_display)

  source link

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.templatetags.admin_list.
• ▶ def display_for_value(value, empty_value_display, boolean=False)

  source link

  Reexports

  • Imported in django.contrib.admin.templatetags.admin_list.
• ▶ def flatten(fields)

  Return a list which is a single level of flattening of the original list.

  source link

  Reexports

  • Imported in django.contrib.admin.checks.
• ▶ def flatten_fieldsets(fieldsets)

  Return a list of field names from an admin fieldsets structure.

  source link

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.contenttypes.admin.
• ▶ def get_deleted_objects(objs, request, admin_site)

  Find all objects related to ``objs`` that should also be deleted. ``objs`` must be a homogeneous iterable of objects (e.g. a QuerySet).

  source link

  Return a nested list of strings suitable for display in the
  template with the ``unordered_list`` filter.

  Reexports

  • Imported in django.contrib.admin.options.
• ▶ def get_fields_from_path(model, path)

  Return list of Fields given path relative to model.

  source link

  e.g. (ModelX, "user__groups__name") -> [
      <django.db.models.fields.related.ForeignKey object at 0x...>,
      <django.db.models.fields.related.ManyToManyField object at 0x...>,
      <django.db.models.fields.CharField object at 0x...>,
  ]

  Reexports

  • Imported in django.contrib.admin.checks.
  • Imported in django.contrib.admin.templatetags.admin_list.
  • Imported in django.contrib.admin.views.main.
• ▶ def get_model_from_relation(field)

  source link

  Reexports

  • Imported in django.contrib.admin.filters.
• ▶ def help_text_for_field(name, model)

  source link

  Reexports

  • Imported in django.contrib.admin.helpers.
• ▶ def label_for_field(name, model, model_admin=None, return_attr=False, form=None)

  Return a sensible label for a field name. The name can be a callable,

  source link

  property (but not created with @property decorator), or the name of an
  object's attribute, as well as a model field. If return_attr is True, also
  return the resolved attribute (which could be a callable). This will be
  None if (and only if) the name refers to a field.

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.templatetags.admin_list.
• ▶ def lookup_field(name, obj, model_admin=None)

  source link

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.templatetags.admin_list.
• ▶ def lookup_needs_distinct(opts, lookup_path)

  Return True if 'distinct()' should be used to query the given lookup path.

  source link

  Reexports

  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.admin.views.main.
• ▶ def model_format_dict(obj)

  Return a `dict` with keys 'verbose_name' and 'verbose_name_plural', typically for use with string formatting.

  source link

  `obj` may be a `Model` instance, `Model` subclass, or `QuerySet` instance.

  Reexports

  • Imported in django.contrib.admin.options.
• ▶ def model_ngettext(obj, n=None)

  Return the appropriate `verbose_name` or `verbose_name_plural` value for `obj` depending on the count `n`.

  source link

  `obj` may be a `Model` instance, `Model` subclass, or `QuerySet` instance.
  If `obj` is a `QuerySet` instance, `n` is optional and the length of the
  `QuerySet` is used.

  Reexports

  • Imported in django.contrib.admin.actions.
  • Imported in django.contrib.admin.options.
• ▶ def prepare_lookup_value(key, value)

  Return a lookup value prepared to be used in queryset filtering.

  source link

  Reexports

  • Imported in django.contrib.admin.filters.
  • Imported in django.contrib.admin.views.main.
• ▶ def quote(s)

  Ensure that primary key values do not confuse the admin URLs by escaping

  source link

  any '/', '_' and ':' and similarly problematic characters.
  Similar to urllib.parse.quote(), except that the quoting is slightly
  different so that it doesn't get automatically unquoted by the Web browser.

  Reexports

  • Imported in django.contrib.admin.helpers.
  • Imported in django.contrib.admin.models.
  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.admin.templatetags.admin_urls.
  • Imported in django.contrib.admin.views.main.
• ▶ def reverse_field_path(model, path)

  Create a reversed field path.

  source link

  E.g. Given (Order, "user__groups"),
  return (Group, "user__order").
  
  Final field must be a related model, not a data field.

  Reexports

  • Imported in django.contrib.admin.filters.
• ▶ def unquote(s)

  Undo the effects of quote().

  source link

  Reexports

  • Imported in django.contrib.admin.options.
  • Imported in django.contrib.auth.admin.

Generated by nedoc v0.9 at 2020-12-29 14:04