Pluggable Django Application Patterns PyCon 2011
•
12 likes•6,115 views
The document discusses making Django applications more "pluggable" by designing them to be focused, self-contained, and easily adaptable. It provides several examples of how to achieve pluggable applications, such as through configurable options, abstract models, optional integrations, and lazy registration of custom fields, managers, model admins, URLs, and templates. The goal is to make applications reusable by allowing users to customize the core functionality without modifying the application code itself.
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Similar to Pluggable Django Application Patterns PyCon 2011
Similar to Pluggable Django Application Patterns PyCon 2011 (20)
Recently uploaded
Recently uploaded (20)
Pluggable Django Application Patterns PyCon 2011
- 1. Pluggable Patterns For Reusable Django Applications Friday, March 11, 2011
- 2. An app MyBlog App should not be • Categories • Custom Tagging a monolithic • Custom Comments pile of code • Comment Moderation • Assumption of text markup type • Single blogs For example, most blog • Multiple Sites “apps” available provide too much functionality ACME MONOLITHS Friday, March 11, 2011
- 3. An application should be “pluggable” Friday, March 11, 2011
- 4. A “pluggable” app is Focused Write programs that do one thing and do it well. — Doug McIlroy (inventor of UNIX pipes) Friday, March 11, 2011
- 5. A “pluggable” app is Self-Contained Batteries are included Dependencies are declared Friday, March 11, 2011
- 6. A “pluggable” app is Easily Adaptable Corey’s Law: The less adaptable you make your code, the sooner you will be tasked to adapt it. Friday, March 11, 2011
- 7. A “pluggable” app is Easily Installed pip install coolapp You did declare your dependencies, right? Friday, March 11, 2011
- 8. How do we make a “pluggable” application? Friday, March 11, 2011
- 9. Stop thinking like this http://upload.wikimedia.org/wikipedia/commons/archive/a/aa/20090315161532!Ferrari_Enzo_Ferrari.JPG Friday, March 11, 2011
- 10. and think like this Friday, March 11, 2011
- 11. Applications can have very different purposes http://www.flickr.com/photos/tiemposdelruido/4051083769/ Friday, March 11, 2011
- 12. Application Types • Data. Manages specific data and access to it • Utility. Provide aapplication a specific problem for any way of handling • Decorator.functionality of many applications aggregates Adds functionality to one or Friday, March 11, 2011
- 13. Situation 1 You want to configure your app without modifying its code (e.g. API keys) Friday, March 11, 2011
- 14. Configurable Options Django Supertagging http://github.com/josesoa Internal Name Setting Name Default Value Friday, March 11, 2011
- 15. Configurable Options Django Debug Toolbar http://github.com/robhudson Friday, March 11, 2011
- 16. Data Apps http://www.flickr.com/photos/29276244@N03/3200630853/ Friday, March 11, 2011
- 17. Situation 2 Lots of variations Each implementation is different (e.g. blogs) Friday, March 11, 2011
- 18. Abstract Models GLAMKit http://www.glamkit.org/ EntryBase FeaturableEntryMixin StatusableEntryMixin TaggableEntryMixin HTMLFormattableEntryMixin Friday, March 11, 2011
- 19. Situation 3 A few, well-known of variations (e.g. Use django.contrib.sites?) Friday, March 11, 2011
- 20. Optional Field Settings Friday, March 11, 2011
- 21. Situation 4 Optionally use another application (e.g. Use django-tagging?) Friday, March 11, 2011
- 22. Optional Integration Friday, March 11, 2011
- 23. Situation 5 You want to reference different models (e.g. Customizable author field) Friday, March 11, 2011
- 24. Runtime Configurable Foreign Keys Viewpoint http://github.com/washingtontimes Friday, March 11, 2011
- 25. Runtime Configurable Foreign Keys Viewpoint http://github.com/washingtontimes Friday, March 11, 2011
- 26. Utility Apps http://www.flickr.com/photos/s8/3638531205/ Friday, March 11, 2011
- 27. Required for template tags or management commands Friday, March 11, 2011
- 28. Decorator Apps http://www.flickr.com/photos/yum9me/2109549869/ Friday, March 11, 2011
- 29. New Method New Field Custom Manager New Admin Friday, March 11, 2011
- 30. Situation 6 You want to add a field to a model Friday, March 11, 2011
- 31. Lazy Field Insertion Django Categories http://github.com/washingtontimes Friday, March 11, 2011
- 32. Lazy Field Insertion Django Categories http://github.com/washingtontimes Friday, March 11, 2011
- 33. Lazy Field Insertion Django Categories http://github.com/washingtontimes Friday, March 11, 2011
- 34. Situation 7 You want to add a custom manager to a model Friday, March 11, 2011
- 35. Lazy Manager Insertion Django MPTT http://github.com/django-mptt Friday, March 11, 2011
- 36. Adding a manager Django MPTT http://github.com/django-mptt from django.db.models import get_model import django.conf import settings from coolapp.managers import CustomManager MODELS = getattr(settings, 'COOLAPP_MODELS', {}) for model_name, mgr_name in MODELS.items(): if not isinstance(model_name, basestring): continue model = get_model(*model_name.split('.')) if not getattr(model, mgr_name, False): manager = CustomManager() manager.contribute_to_class(model, mgr_name) Friday, March 11, 2011
- 37. Situation 8 You want to customize a model’s ModelAdmin (e.g. Change the widget of a field) Friday, March 11, 2011
- 38. Lazy Registration of a Custom ModelAdmin Django TinyMCE http://github.com/justquick project’s settings.py Friday, March 11, 2011
- 39. Lazy Registration of a Custom ModelAdmin Django TinyMCE http://github.com/justquick Django-TinyMCE’s models.py Friday, March 11, 2011
- 40. Lazy Registration of a Custom ModelAdmin Django TinyMCE http://github.com/justquick Django-TinyMCE’s admin.py Friday, March 11, 2011
- 41. Lazy Registration of a Custom ModelAdmin Django TinyMCE http://github.com/justquick bottom of Django-TinyMCE’s admin.py Friday, March 11, 2011
- 42. Touch Points Friday, March 11, 2011
- 43. Touch Points of an App The parts of an application that usually need tweaking • URLs • Templates • View responses Friday, March 11, 2011
- 44. Situation 9 You want the URLs of your app to live under any prefix (e.g. /blogs/ vs. /weblogs/) Friday, March 11, 2011
- 45. Name your URLs Friday, March 11, 2011
- 46. Name your URLs url Function name Friday, March 11, 2011
- 47. Reference your URLs by name Friday, March 11, 2011
- 48. Situation 10 You want your templates to be easily overridable Friday, March 11, 2011
- 49. “Namespace” Templates All templates in coolapp a template “name space” templates coolapp base.html Friday, March 11, 2011
- 50. “Namespace” Templates coolapp templates coolapp Referenced as base.html “coolapp/base.html” Friday, March 11, 2011
- 51. Extend one template site_base.html base.html summary.html index.html detail.html Friday, March 11, 2011
- 52. Extend one template site_base.html base.html base.html summary.html index.html detail.html Friday, March 11, 2011
- 53. Extend one template site_base.html base.html base.html summary.html index.html detail.html Friday, March 11, 2011
- 54. Extend one template coolapp/base.html Friday, March 11, 2011
- 55. Extend one template coolapp/base.html Friday, March 11, 2011
- 56. Import your blocks Allows you to override any of the templates extra_head.html coolapp/detail.html Friday, March 11, 2011
- 57. Situation 11 You want flexibility storing uploaded files Friday, March 11, 2011
- 58. Define a Storage Option Friday, March 11, 2011
- 59. Situation 12 You want to alter the data your views use (e.g. Extra context, different template) Friday, March 11, 2011
- 60. 100% more class- based views! django-cbv for backwards compatibility! Friday, March 11, 2011
- 61. My Info • coreyoordt@gmail.com • @coordt • github.com/coordt • github.com/washingtontimes • opensource.washingtontimes.com Friday, March 11, 2011