&g+dZddlmZddlmZ ddlmZddlmZ ddl m Z dd lmZdd lmZmZGd d eZGd deZGddeZGddeZy#e $rddl mZddlmZ ddl mZ YTwxYw)z9 Module where admin tools dashboard classes are defined. )slugify) import_module)reverse) gettext_lazy) force_str) ugettext_lazy) force_text)modules)get_admin_site_nameuniquifycXeZdZdZedZdZdZdZGddZ dZ dZ d Z d Z y) Dashboarda Base class for dashboards. The Dashboard class is a simple python list that has three additional properties: ``title`` The dashboard title, by default, it is displayed above the dashboard in a ``h2`` tag. Default value: 'Dashboard'. ``template`` The template to use to render the dashboard. Default value: 'admin_tools/dashboard/dashboard.html' ``columns`` An integer that represents the number of columns for the dashboard. Default value: 2. If you want to customize the look of your dashboard and it's modules, you can declare css stylesheets and/or javascript files to include when rendering the dashboard (these files should be placed in your media path), for example:: from admin_tools.dashboard import Dashboard class MyDashboard(Dashboard): class Media: css = { 'screen, projection': ('css/mydashboard.css',), } js = ('js/mydashboard.js',) Here's an example of a custom dashboard:: from django.core.urlresolvers import reverse from django.utils.translation import ugettext_lazy as _ from admin_tools.dashboard import modules, Dashboard class MyDashboard(Dashboard): # we want a 3 columns layout columns = 3 def __init__(self, **kwargs): # append an app list module for "Applications" self.children.append(modules.AppList( title=_('Applications'), exclude=('django.contrib.*',), )) # append an app list module for "Administration" self.children.append(modules.AppList( title=_('Administration'), models=('django.contrib.*',), )) # append a recent actions module self.children.append(modules.RecentActions( title=_('Recent Actions'), limit=5 )) Below is a screenshot of the resulting dashboard: .. image:: images/dashboard_example.png z$admin_tools/dashboard/dashboard.htmlNceZdZdZdZy)Dashboard.MediaN)__name__ __module__ __qualname__cssjsrY/var/www/html/djangosite/lib/python3.12/site-packages/admin_tools/dashboard/dashboards.pyMediar_s  rrc |D])}t|j|st||||+|jxsg|_y)N)hasattr __class__setattrchildren)selfkwargskeys r__init__zDashboard.__init__csA 0Ct~~s+c6#;/ 0 + rcy)a Sometimes you may need to access context or request variables to build your dashboard, this is what the ``init_with_context()`` method is for. This method is called just before the display with a ``django.template.RequestContext`` as unique argument, so you can access to all context variables and to the ``django.http.HttpRequest``. Nr)r contexts rinit_with_contextzDashboard.init_with_contextis rcy)V Internal method used to distinguish different dashboards in js code. dashboardrr s rget_idzDashboard.get_idssrct}t|jD]@\}}t|jxst |dz||_|j By)z) Enumerates children without explicit id N)set enumeraterr idstr_prepare_children)r seenr0modules rr2zDashboard._prepare_childrenysPu#DMM2 'JB !7c"Q$i>FI  $ $ & 'r)rrr__doc___titletemplatecolumnsrrr#r&r+r2rrrrrsAAF kNE5HGH,   'rrc<eZdZdZdZdZfdZdZdZdZ xZ S)AppIndexDashboarda Class that represents an app index dashboard, app index dashboards are displayed in the applications index page. :class:`~admin_tools.dashboard.AppIndexDashboard` is very similar to the :class:`~admin_tools.dashboard.Dashboard` class except that its constructor receives two extra arguments: ``app_title`` The title of the application ``models`` A list of strings representing the available models for the current application, example:: ['yourproject.app.Model1', 'yourproject.app.Model2'] It also provides two helper methods: ``get_app_model_classes()`` Method that returns the list of model classes for the current app. ``get_app_content_types()`` Method that returns the list of content types for the current app. If you want to provide custom app index dashboard, be sure to inherit from this class instead of the :class:`~admin_tools.dashboard.Dashboard` class. Here's an example of a custom app index dashboard:: from django.urls import reverse from django.utils.translation import gettext_lazy as _ from admin_tools.dashboard import modules, AppIndexDashboard class MyAppIndexDashboard(AppIndexDashboard): # we don't want a title, it's redundant title = '' def __init__(self, app_title, models, **kwargs): AppIndexDashboard.__init__(self, app_title, models, **kwargs) # append a model list module that lists all models # for the app and a recent actions module for the current app self.children += [ modules.ModelList(self.app_title, self.models), modules.RecentActions( include_list=self.models, limit=5 ) ] Below is a screenshot of the resulting dashboard: .. image:: images/dashboard_app_index_example.png Nc T|j||dtt|di|y)N) app_titlemodelsr)updatesuperr;r#)r r=r>r!rs rr#zAppIndexDashboard.__init__s' I@A /9&9rcg}|jD]=}|jdd\}}t|}|jt ||?|S)zY Helper method that returns a list of model classes for the current app. .r-)r>rsplitrappendgetattr)r r>mmodclss rget_app_model_classesz'AppIndexDashboard.get_app_model_classessT -AxxQ'HC$C MM'#s+ , - rcddlm}g}|jD]-} |j|jj |/|S#t $rY=wxYw)zB Return a list of all content_types for this app. r) ContentType)"django.contrib.contenttypes.modelsrKrIrDobjects get_for_modelAttributeError)r rKresultrHs rget_app_content_typesz'AppIndexDashboard.get_app_content_typessd C--/ C  k11??DE  "   s*A  AAcDdtt|jzS)r(z %s-dashboard)rrr=r*s rr+zAppIndexDashboard.get_ids $..(A BBBr) rrrr5r>r=r#rIrQr+ __classcell__)rs@rr;r;s*6pFI: $Crr;ceZdZdZdZy)DefaultIndexDashboardag The default dashboard displayed on the admin index page. To change the default dashboard you'll have to type the following from the commandline in your project root directory:: python manage.py customdashboard And then set the ``ADMIN_TOOLS_INDEX_DASHBOARD`` settings variable to point to your custom index dashboard class. ct|}|jjtjt dddddt ddgt dt d|zgt dt d |zgg |jjtjt d d |jjtjt dd |jjtjt dd|jjtjt ddd|jjtjt dt ddddt ddddt ddddgy)Nz Quick linksinlineFzReturn to site/zChange passwordz%s:password_changezLog outz %s:logout)layout draggable deletable collapsibler Applications)zdjango.contrib.*)excludeAdministration)r>Recent ActionszLatest Django Newsz(http://www.djangoproject.com/rss/weblog/)feed_urllimitSupportzDjango documentationzhttp://docs.djangoproject.com/T)r7urlexternalz"Django "django-users" mailing listz+http://groups.google.com/group/django-userszDjango irc channelzirc://irc.freenode.net/django)r) r rrDr LinkListr6rAppList RecentActionsFeed)r r% site_names rr&z'DefaultIndexDashboard.init_with_contexts'0  W-- m #$c*$%- 9:<9w{Y'>?@    W__ n )  W__  (  W2215E3FJK W\\ " #?   W-- iL56; $ CDH $ 34: $  rN)rrrr5r&rrrrUrUs  ; rrUceZdZdZdZdZy)DefaultAppIndexDashboardav The default dashboard displayed on the applications index page. To change the default dashboard you'll have to type the following from the commandline in your project root directory:: python manage.py customdashboard And then set the ``ADMIN_TOOLS_APP_INDEX_DASHBOARD`` settings variable to point to your custom app index dashboard class. ctj|g|i||xjtj|j |j tjtd|jdgz c_y)Nr`ra) include_listrc) r;r#rr ModelListr=r>rir6rQ)r argsr!s rr#z!DefaultAppIndexDashboard.__init__=sm""49$9&9   dnndkk :  ! !"#!779   rN)rrrr5r7r#rrrrmrm.s  E  rrmN)r5django.template.defaultfiltersr importlibr django.urlsrdjango.utils.translationrr6django.utils.encodingr ImportErrordjango.core.urlresolversrr admin_tools.dashboardr admin_tools.utilsr r objectrr;rUrmrrrr}s3# >$:/ *;h'h'VaC aCHF IF R 0 C >0;=>sAA76A7