agiliq / django-admin-cookbook Goto Github PK

License: Other

Python 96.43% HTML 3.57%

django-admin-cookbook's Introduction

Django admin cookbook

Django admin cookbook is a set of recipes of how to do things with Django. They take the form of about 50 questions of the form How to do X with Django admin.

We have a set of models which we use across the book for answering these questions.

The setup

You have been hired by the United Mytic and Supernormal Research Agency - The UMSRA. UMSRA researches and documents mytic and supernormal events. You have been tasked with creating a web app where UMSRA researchers can document their findings and look up their collegue's research.

The models

You plan to write a set of models and an associated admin for UMSRA researchers. You come up with two apps entities and events. The models are

Events

from django.db import models
from entities.models import Hero, Villain

class Epic(models.Model):
    name = models.CharField(max_length=255)
    participating_heroes = models.ManyToManyField(Hero)
    participating_villains = models.ManyToManyField(Villain)


class Event(models.Model):
    epic = models.ForeignKey(Epic, on_delete=models.CASCADE)
    details = models.TextField()
    years_ago = models.PositiveIntegerField()


class EventHero(models.Model):
    event = models.ForeignKey(Event, on_delete=models.CASCADE)
    hero = models.ForeignKey(Hero, on_delete=models.CASCADE)
    is_primary = models.BooleanField()


class EventVillain(models.Model):
    event = models.ForeignKey(Event, on_delete=models.CASCADE)
    hero = models.ForeignKey(Villain, on_delete=models.CASCADE)
    is_primary = models.BooleanField()

Entities

from django.db import models


class Category(models.Model):
    name = models.CharField(max_length=100)


class Origin(models.Model):
    name = models.CharField(max_length=100)


class Entity(models.Model):
    GENDER_MALE = "Male"
    GENDER_FEMALE = "Female"
    GENDER_OTHERS = "Others/Unknown"

    name = models.CharField(max_length=100)
    alternative_name = models.CharField(
        max_length=100, null=True, blank=True
    )


    category = models.ForeignKey(Category, on_delete=models.CASCADE)
    origin = models.ForeignKey(Origin, on_delete=models.CASCADE)
    gender = models.CharField(
        max_length=100,
        choices=(
            (GENDER_MALE, GENDER_MALE),
            (GENDER_FEMALE, GENDER_FEMALE),
            (GENDER_OTHERS, GENDER_OTHERS),
        )
    )
    description = models.TextField()

    class Meta:
        abstract = True


class Hero(Entity):

    is_immortal = models.BooleanField(default=True)

    benevolence_factor = models.PositiveSmallIntegerField(
        help_text="How benevolent this hero is?"
    )
    arbitrariness_factor = models.PositiveSmallIntegerField(
        help_text="How arbitrary this hero is?"
    )
    # relationships
    father = models.ForeignKey(
        "self", related_name="+", null=True, blank=True, on_delete=models.SET_NULL
    )
    mother = models.ForeignKey(
        "self", related_name="+", null=True, blank=True, on_delete=models.SET_NULL
    )
    spouse = models.ForeignKey(
        "self", related_name="+", null=True, blank=True, on_delete=models.SET_NULL
    )


class Villain(Entity):
    is_immortal = models.BooleanField(default=False)

    malevolence_factor = models.PositiveSmallIntegerField(
        help_text="How malevolent this villain is?"
    )
    power_factor = models.PositiveSmallIntegerField(
        help_text="How powerful this villain is?"
    )
    is_unique = models.BooleanField(default=True)
    count = models.PositiveSmallIntegerField(default=1)

django-admin-cookbook's People

Contributors

Stargazers

Watchers

Forkers

dan-gamble tomdyson jciskey projetosparalelos vishalsodani gridl rohan0401 iliaznk dipit2007 tanishqg5325 gogobook liangsongyou sivaa undabah wilgucki coeibu llogs oxalorg patriciomg milovanovm keu210 crystal3a wellic mdrkb pydawan rsalmaso rrebase yousefalsalem arvi9 leehosung theassyrian cuongtransc iceleaf916 oceanheart samlex20 jprecreativo dhirwa13 aaronlaw charanpython lordoftheflies arlington1985 depripramana blackway poiedk kp-forks jeroenpeters1986 ellen364 jubrilissa aymanfekri stanleykywong yujinyuz icodein pichetbuu jack7141 xyn1t avi202020 timur232sdsd leafcoder lld2001 aavendano

django-admin-cookbook's Issues

Use cookbook

Hi!
I wanted to use the examples from your book, but in the process a question arose. Maybe it will sound silly)) But... This is a recipe for a pure django or for an app?

Add list_select_related

Use a FK field attribute on http://django-admin-cookbook.readthedocs.io/en/latest/calculated_fields.html, eg: self.user.email. This would lead to extra query per object. This can be avoided using list_select_related. Add list_select_related to http://django-admin-cookbook.readthedocs.io/en/latest/optimize_queries.html

verbose name neglect by `formfield_for_foreignkey` .

if we had given a verbose name for the model field and if we try to customize our FK representation in the admin panel then we will use formfield_for_foreignkey as shown in the block below

def formfield_for_foreignkey(self, db_field, request, **kwargs):
    if db_field.name == 'category':
        return CategoryChoiceField(queryset=Category.objects.all())
    return super().formfield_for_foreignkey(db_field, request, **kwargs)

and here it will neglect the given verbose name (tbh IDK why its happening maybe DB layer is overridden by the form layer!)
so we have to provide the label argument again

def formfield_for_foreignkey(self, db_field, request, **kwargs):
    if db_field.name == 'category':
        return CategoryChoiceField(queryset=Category.objects.all(), label='_XYZ_')
    return super().formfield_for_foreignkey(db_field, request, **kwargs)

link

Get an ISBN!

When are you actually publishing this? I wanna list it at https://www.twoscoopspress.com/pages/current-django-books!

ENTRY: django manager objects all_objects

This features its not documented but it works

When you implement softdelete (logic delete). On the admin show all objects but on the app not show the objects deleted.

class CustomManager(models.Manager):
      def get_queryset(self):
            qs = super().get_queryset()
            return qs.filter(is_deleted=True)

class Model1(models.Model):

      all_objects = models.Manager()
      objects = CustomManager()

Some typo in the book

Hi, it great to read your django-admin-cookbook. It helps me a lot. While reading the book, I might find some typo in the text.

sublass -> subclass
docs/add_model_twice.rst
AllEntiryAdmin -> AllEntityAdmin
docs/database_view.rst
I wish it could be helpful to you.
Thank you very much.