Skip to main content

Normalize '__unicode__' accross django models

Don't repeat your self, use monkeypatching - a better default '__unicode__'

This latest top-secret project for sure is keeping me busy and time wise leaves little to keep blogging, however it being Friday and all and because you're worth it here is a Django expert tip.

Django's default '__unicode__' representation leaves a bit to be desired to say the least. In a nut shell it returns the class name + 'object' for all instances and so requires that all your models have a '__unicode__' defined to have a useful string represenation. Well with a bit of friendly monkeys we can patch it right up as per the code below:

from django.db.models.base import Model
import logging
import hashlib
import re
from django.conf import settings

logger = logging.getLogger(__name__)


#---------------------------------------------------------------------------------------------------------------------- 
logger.info("Patching 'django.db.models.base.Model': adding get_pk_display() method that return pk like string "\
  " that is based on class name and pk of the model, ex. #NG000-341-000 or #NGNone, or #NGXYA") 

# confirm signature of code we are patching and warn if it has changed
#raise Exception(hashlib.md5(str(Model)).hexdigest())
if not '300fd49fc5099da23c0929fb1b7b48cd' == \
  hashlib.md5(str(Model)).hexdigest():
 logger.warn("Hexdigest md5 signature of 'django.db.models.base.Model' does not match expected value."
     " There might be a chance patch is broken so please review code and update as needed.")

def get_pk_display(self):
 try:
  return u'#{0}{1:09}'.format(''.join(re.findall('[A-Z]', self.__class__.__name__)), self.pk)
 except: # most likely non integer based pk or not yet saved i.e. pk == None
  return u'#{0}{1}'.format(''.join(re.findall('[A-Z]', self.__class__.__name__)), self.pk)

# do the actual patch
Model.get_pk_display = get_pk_display
del get_pk_display  # clean up namespace after patching 
#----------------------------------------------------------------------------------------------------------------------


#---------------------------------------------------------------------------------------------------------------------- 
logger.info("Patching 'django.db.models.base.Model': adding default __unicode__() method that return self.name" \
  " prepended with self.get_pk_display if settings.DEBUG = True. If self.name does not exist then only" \
  " self.get_pk_display is returned") 

# confirm signature of code we are patching and warn if it has changed
#raise Exception(hashlib.md5(str(Model)).hexdigest())
if not '300fd49fc5099da23c0929fb1b7b48cd' == \
  hashlib.md5(str(Model)).hexdigest():
 logger.warn("Hexdigest md5 signature of 'django.db.models.base.Model' does not match expected value."
     " There might be a chance patch is broken so please review code and update as needed.")
def __unicode__(self):
 try:
  return u'{0}{1}'.format(self.get_pk_display() + ': ' if settings.DEBUG else '', self.name)
 except:
  return self.get_pk_display()
Model.__unicode__ = __unicode__ 

I store the above file in the project root with an app labled '_monkeypatches' in a file named 'patch_django_db_models_base_model.py' - nomenclature and organization is an art in itself but I prefer verbose for my own sake and the team - and below is what it does in plain English:

  • Every model in your django project gets a new method 'get_pk_display' – it takes the capital letters of the class name and the instances default pk and renders a front end friendly id of object. For example UserProfile with pk 7 would be rendered as '#UP000000007'. This is a handy method in itself as for example I use it heavily on the current project that requires information is hidden until certian conditions are met.
  • Every model get's a new shiny __unicode__ that returns the objects 'self.name' (from 4+ years of Django it's uncommon for my objects not to need a 'name' field) and prepends it with the output 'get_pk_display' IF settings.DEBUG is True – if object does not have 'self.name' defined then 'get_pk_display' is just returned, ex '#C000000312 Danols Web Engineering'.

I tell you – the above is rather handy and now I am in the process of wiping out uneeded __unicode__ and cleaning up templates.

Thoughts, comments and feel free to share your nuggets of Django wisdom.

Be great – @danielsokolow

Comments

Popular posts from this blog

How to child proof a fireplace

DIY - Do it yourself fireplace child guard Our wonderful 8.5 month old Sofia has become a crawling race car with an untamed thirst for exploration. And so with the cold nights approaching we needed to child proof the fireplace. This however proved to be more difficult than would reasonably expect, I've checked the local Toys "R" Us, Walmart, and even a Canadian Tire with no success for a ready to use product. Internet search was more fruitful and returned a few online stores one could order from, however in all honestly they didn't look too sturdy to me. So I build my own relatively quickly and inexpensively. Materials needed is a privacy plastic lattice - the smallest hole pattern - a few screws and anchors; tools needed are a drill, and a handsaw if you don't have the lattice cut at the store - that’s it. The construction consits of screwing the lattice into the wall and the final product is easiest explained through following pictures. Feel free to +1 this po…

Duplicate value found: duplicates value on record with id: <unknown>.

System.DmlException: Insert failed. First exception on row 0; first error: DUPLICATE_VALUE, duplicate value found: <unknown> duplicates value on record with id: <unknown>.The above error is triggered in the database layer and caused by a trigger or workflow outside of your main code of block that is bubbling this exception. This is rather difficult to track down especially if you are unfamiliar with the code, I am sharing my procedure in the hopes this saves you time - if you find this helpful drop me a line or follow me on twitter @danielsokolows. This error is caused by unique field constraint on the object, so the first step is to examine the object and locate the API names of all unique fieds. You can do this through SF direclty 'Setup < Customize &lt <object being inserted> &lt Fields' or by downloading the `src/objects` metadata information and searching for <unique>; I preffer the latter and actually download ALL matadata information f…

Setting up ZOTAC ZBOX nano AD Remote for XBMC

Getting the Windows, Info and Colored buttons to workThe included Zotac remote is Windows MCERemote compatible but the additional buttons (Windows, Info, Colored buttons) will not work out of the box. The XBMC MCERemote add-on will fail with: * Warning * The ReportMappingTable registry key is not present * No Microsoft remote is installed Good NewsBut before I begin, if this helps you please do +1 or share it as that helps me.So take the MCERemote registry files, this, this,0 and this thread and a 3 hours and you get a tweaked Zotac Remote Registry Fix below; it labels all keys I could discover and maps some as follow:The Windows remote key to Win keyboard key (perfect if you are running Windows 8)The Colored Buttons to Ctrl 1 through 4The Info button to 'Ctrl D' - XBMC display info[T] Teletext? key to send 'T' - XBMC toggles subtitliesThe '≡' right of 'T' to send 'C' - XBMC display contextual menuCopy and paste the below into a file on your …