The django book - Chap10 : Advanced Models

Transcript

1. Advanced Models ˜The Django Book™ Chapter 10 4QJO -BJ +VMZ   ϋ˜˚݋ಂɧ
2. ፠̡̻ 4QJO ༟ן҃ρ ं൥߅Ҧԫุஈ 1)1e+BWBTDSJQUe1ZUIPO About me ϋ˜˚݋ಂɧ
3. 3FMBUFE PCKFDUT 6QEBUF EBUBCBTF TDIFNB .PEFM NFUIPET .BOBHFST &YFDVUF SBX 42- RVFSJFT .PSF BCPVU .BOBHFST Today’s topics ϋ˜˚݋ಂɧ
4. Related objects ϋ˜˚݋ಂɧ
5. Recalling the Chapter 5 ... ϋ˜˚݋ಂɧ
6. Publisher id name address city state_province country website AutoField CharField CharField CharField CharField CharField URLField Book id title authors publisher publication_date AutoField CharField ManyToManyField ForeignKey DateField Author id first_name last_name email AutoField CharField CharField EmailField N:1 N:M ϋ˜˚݋ಂɧ
7. class Publisher(models.Model): name = models.CharField(max_length=30) address = models.CharField(max_length=50) city = models.CharField(max_length=60) state_province = models.CharField(max_length=30) country = models.CharField(max_length=50) website = models.URLField() def __unicode__(self): return self.name ϋ˜˚݋ಂɧ
8. class Author(models.Model): first_name = models.CharField(max_length=30) last_name = models.CharField(max_length=40) email = models.EmailField() def __unicode__(self): return u'%s %s' % (self.first_name, self.last_name) ϋ˜˚݋ಂɧ
9. class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
10. class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
11. Foreign Key Value Publisher id name address city state_province country website AutoField CharField CharField CharField CharField CharField URLField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> b = Book.objects.get(id=50) >>> b.publisher <Publisher: Apress Publishing> >>> b.publisher.website u'http://www.apress.com/' <Publisher: Apress Publishing> ϋ˜˚݋ಂɧ
12. Foreign Key Value Publisher id name address city state_province country website AutoField CharField CharField CharField CharField CharField URLField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> p = Publisher.objects.get(name='Apress Publishing') >>> p.book_set.all() [<Book: The Django Book>, <Book: Dive Into Python>, ...] >>> p.book_set.filter(name__icontains='django') [<Book: The Django Book>, <Book: Pro Django>] ϋ˜˚݋ಂɧ
13. Foreign Key Value Publisher id name address city state_province country website AutoField CharField CharField CharField CharField CharField URLField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> p = Publisher.objects.get(name='Apress Publishing') >>> p.book_set.all() [<Book: The Django Book>, <Book: Dive Into Python>, ...] >>> p.book_set.filter(name__icontains='django') [<Book: The Django Book>, <Book: Pro Django>] ϋ˜˚݋ಂɧ
14. class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
15. class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
16. Many-to-Many Values Author id first_name last_name email AutoField CharField CharField EmailField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> b = Book.objects.get(id=50) >>> b.authors.all() [<Author: Adrian Holovaty>, <Author: Jacob Kaplan-Moss>] >>> b.authors.filter (first_name='Adrian') [<Author: Adrian Holovaty>] >>> b.authors.filter (first_name='Adam') [] ϋ˜˚݋ಂɧ
17. Many-to-Many Values Author id first_name last_name email AutoField CharField CharField EmailField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> a = Author.objects.get(first_name='Adrian', last_name='Holovaty') >>> a.book_set.all() [<Book: The Django Book>, <Book: Adrian's Other Book>]' ϋ˜˚݋ಂɧ
18. Many-to-Many Values Author id first_name last_name email AutoField CharField CharField EmailField Book id title authors publisher AutoField CharField ManyToManyField ForeignKey >>> a = Author.objects.get(first_name='Adrian', last_name='Holovaty') >>> a.book_set.all() [<Book: The Django Book>, <Book: Adrian's Other Book>]' ϋ˜˚݋ಂɧ
19. Update database schema ϋ˜˚݋ಂɧ
20. First of all ϋ˜˚݋ಂɧ
21. Does not care extra DB table columns Does not care extra DB tables Complains if model contains fields that has not yet been created in the DB table Django ϋ˜˚݋ಂɧ
22. `syncdb` only create tables for models which have not yet been installed. ϋ˜˚݋ಂɧ
23. "EE NPEFM GJFMET 3FNPWF NPEFM GJFMET 3FNPWF NPEFMT Update database schema ϋ˜˚݋ಂɧ
24. Add model fields ϋ˜˚݋ಂɧ
25. Add model fields Add fields to the model Check the column definitions for new fields Add new columns to the DB table Verify new fields was added properly In development environments ... ϋ˜˚݋ಂɧ
26. Add model fields Add fields to the model Check the column definitions for new fields Add new columns to the DB table Verify new fields was added properly In development environments ... class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() num_pages = models.IntegerField(blank=True, null=True) def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
27. Add model fields Add fields to the model Check the column definitions for new fields Add new columns to the DB table Verify new fields was added properly In development environments ... CREATE TABLE "books_book" ( "id" serial NOT NULL PRIMARY KEY, "title" varchar(100) NOT NULL, "publisher_id" integer NOT NULL REFERENCES "books_publisher" ("id"), "publication_date" date NOT NULL, "num_pages" integer NULL ); $ python manage.py sqlall books ϋ˜˚݋ಂɧ
28. Add model fields Add fields to the model Check the column definitions for new fields Add new columns to the DB table Verify new fields was added properly In development environments ... ALTER TABLE books_book ADD COLUMN num_pages integer; ϋ˜˚݋ಂɧ
29. Add model fields Add fields to the model Check the column definitions for new fields Add new columns to the DB table Verify new fields was added properly In development environments ... >>> from mysite.books.models import Book >>> Book.objects.all()[:5] ϋ˜˚݋ಂɧ
30. Add model fields Add new columns to the DB table Add fields to the model Restart the web server In production environments ... ϋ˜˚݋ಂɧ
31. Remove model fields ϋ˜˚݋ಂɧ
32. Add model fields Remove fields from the model Restart the web server Remove columns from the DB table Remove Normal fields ... ϋ˜˚݋ಂɧ
33. Add model fields Remove fields from the model Restart the web server Remove columns from the DB table Remove Normal fields ... ALTER TABLE books_book DROP COLUMN num_pages; ϋ˜˚݋ಂɧ
34. Add model fields Remove Many-to-Many fields from the model Restart the web server Remove Many-to-Many table from the DB Remove Many-to-Many fields ... ϋ˜˚݋ಂɧ
35. Add model fields Remove Many-to-Many fields from the model Restart the web server Remove Many-to-Many table from the DB Remove Many-to-Many fields ... DROP TABLE books_book_authors; ϋ˜˚݋ಂɧ
36. Remove models ϋ˜˚݋ಂɧ
37. Remove model from the models.py Restart the web server Remove dependent tables from the DB Remove the target table from the DB Remove models ϋ˜˚݋ಂɧ
38. Remove model from the `models.py` Restart the web server Remove dependent tables from the DB Remove the target table from the DB Remove models DROP TABLE books_book; ϋ˜˚݋ಂɧ
39. Model methods ϋ˜˚݋ಂɧ
40. class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) birth_date = models.DateField() address = models.CharField(max_length=100) city = models.CharField(max_length=50) state = USStateField() # Yes, this is U.S.-centric... def baby_boomer_status(self): "Returns the person's baby-boomer status." import datetime if datetime.date(1945, 8, 1) <= self.birth_date <= datetime.date(1964, 12, 31): return "Baby boomer" if self.birth_date < datetime.date(1945, 8, 1): return "Pre-boomer" return "Post-boomer" def is_midwestern(self): "Returns True if this person is from the Midwest." return self.state in ('IL', 'WI', 'MI', 'IN', 'OH', 'IA', 'MO') def _get_full_name(self): "Returns the person's full name." return u'%s %s' % (self.first_name, self.last_name) full_name = property(_get_full_name) ϋ˜˚݋ಂɧ
41. class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) birth_date = models.DateField() address = models.CharField(max_length=100) city = models.CharField(max_length=50) state = USStateField() # Yes, this is U.S.-centric... def baby_boomer_status(self): "Returns the person's baby-boomer status." import datetime if datetime.date(1945, 8, 1) <= self.birth_date <= datetime.date(1964, 12, 31): return "Baby boomer" if self.birth_date < datetime.date(1945, 8, 1): return "Pre-boomer" return "Post-boomer" def is_midwestern(self): "Returns True if this person is from the Midwest." return self.state in ('IL', 'WI', 'MI', 'IN', 'OH', 'IA', 'MO') def _get_full_name(self): "Returns the person's full name." return u'%s %s' % (self.first_name, self.last_name) full_name = property(_get_full_name) ϋ˜˚݋ಂɧ
42. Model methods >>> p = Person.objects.get(first_name='Barack', last_name='Obama') >>> p.birth_date datetime.date(1961, 8, 4) >>> p.baby_boomer_status() 'Baby boomer' >>> p.is_midwestern() True ϋ˜˚݋ಂɧ
43. class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) birth_date = models.DateField() address = models.CharField(max_length=100) city = models.CharField(max_length=50) state = USStateField() # Yes, this is U.S.-centric... def baby_boomer_status(self): "Returns the person's baby-boomer status." import datetime if datetime.date(1945, 8, 1) <= self.birth_date <= datetime.date(1964, 12, 31): return "Baby boomer" if self.birth_date < datetime.date(1945, 8, 1): return "Pre-boomer" return "Post-boomer" def is_midwestern(self): "Returns True if this person is from the Midwest." return self.state in ('IL', 'WI', 'MI', 'IN', 'OH', 'IA', 'MO') def _get_full_name(self): "Returns the person's full name." return u'%s %s' % (self.first_name, self.last_name) full_name = property(_get_full_name) ϋ˜˚݋ಂɧ
44. Property methods >>> p = Person.objects.get(first_name='Barack', last_name='Obama') >>> p.full_name # Note this isn't a method u'Barack Obama' ϋ˜˚݋ಂɧ
45. Managers ϋ˜˚݋ಂɧ
46. What is Manager? ϋ˜˚݋ಂɧ
47. Manager Book.objects.all() ϋ˜˚݋ಂɧ
48. Manager Book.objects.all() ϋ˜˚݋ಂɧ
49. Manager “ The interface through which database query operations are provided to Django models. ” ϋ˜˚݋ಂɧ
50. Why do we need a custom Manager? ϋ˜˚݋ಂɧ
51. "EE FYUSB .BOBHFS NFUIPET .PEJGZ JOJUJBM .BOBHFS 2VFSZ4FUT Custom Mangers ϋ˜˚݋ಂɧ
52. Add extra Manager methods ϋ˜˚݋ಂɧ
53. Add extra Manager methods # Get the number of books that have a title ‘Django’ >>> Book.objects.filter(title__icontains='Django') # Get the number of books that have a title ‘Python’ >>> Book.objects.filter(title__icontains='Python') # Get the number of books that have a title ‘xxx’ .... # Get the number of books that have a title ‘yyy’ .... ..... ....... ϋ˜˚݋ಂɧ
54. Add extra Manager methods # takes a keyword and returns the number of books >>> Book.objects.title_count('django') >>> Book.objects.title_count('python') ϋ˜˚݋ಂɧ
55. # models.py from django.db import models # ... Author and Publisher models here ... class BookManager(models.Manager): def title_count(self, keyword): return self.filter(title__icontains=keyword).count() class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() num_pages = models.IntegerField(blank=True, null=True) objects = BookManager() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
56. # models.py from django.db import models # ... Author and Publisher models here ... class BookManager(models.Manager): def title_count(self, keyword): return self.filter(title__icontains=keyword).count() class Book(models.Model): title = models.CharField(max_length=100) authors = models.ManyToManyField(Author) publisher = models.ForeignKey(Publisher) publication_date = models.DateField() num_pages = models.IntegerField(blank=True, null=True) objects = BookManager() def __unicode__(self): return self.title ϋ˜˚݋ಂɧ
57. Modify initial Manager QuerySets ϋ˜˚݋ಂɧ
58. Modify initial Manager QuerySets Default Manager return all the records Override Manager’s base QuerySets ϋ˜˚݋ಂɧ
59. Modify initial Manager QuerySets Default Manager return all the records Override Manager’s base QuerySets # returns all books in the book database >>> Book.objects.all() ϋ˜˚݋ಂɧ
60. Modify initial Manager QuerySets Default Manager return all the records Override Manager’s base QuerySets By overriding the Manager.get_query_set() ϋ˜˚݋ಂɧ
61. Modify initial Manager QuerySets from django.db import models # First, define the Manager subclass. class DahlBookManager(models.Manager): def get_query_set(self): return super(DahlBookManager, self).get_query_set()\ .filter(author='Roald Dahl') # Then hook it into the Book model explicitly. class Book(models.Model): title = models.CharField(max_length=100) author = models.CharField(max_length=50) # ... objects = models.Manager() # The default manager. dahl_objects = DahlBookManager() # The Dahl-specific manager. ϋ˜˚݋ಂɧ
62. Modify initial Manager QuerySets from django.db import models # First, define the Manager subclass. class DahlBookManager(models.Manager): def get_query_set(self): return super(DahlBookManager, self).get_query_set()\ .filter(author='Roald Dahl') # Then hook it into the Book model explicitly. class Book(models.Model): title = models.CharField(max_length=100) author = models.CharField(max_length=50) # ... objects = models.Manager() # The default manager. dahl_objects = DahlBookManager() # The Dahl-specific manager. ϋ˜˚݋ಂɧ
63. Modify initial Manager QuerySets >>> Book.dahl_objects.all() >>> Book.dahl_objects.filter(title='Matilda') >>> Book.dahl_objects.count() ϋ˜˚݋ಂɧ
64. Another example class MaleManager(models.Manager): def get_query_set(self): return super(MaleManager, self).get_query_set().filter(sex='M') class FemaleManager(models.Manager): def get_query_set(self): return super(FemaleManager, self).get_query_set().filter(sex='F') class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) sex = models.CharField(max_length=1, choices=(('M', 'Male'), ('F', 'Female'))) people = models.Manager() men = MaleManager() women = FemaleManager() ϋ˜˚݋ಂɧ
65. Another example class MaleManager(models.Manager): def get_query_set(self): return super(MaleManager, self).get_query_set().filter(sex='M') class FemaleManager(models.Manager): def get_query_set(self): return super(FemaleManager, self).get_query_set().filter(sex='F') class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) sex = models.CharField(max_length=1, choices=(('M', 'Male'), ('F', 'Female'))) people = models.Manager() men = MaleManager() women = FemaleManager() ϋ˜˚݋ಂɧ
66. Modify initial Manager QuerySets >>> Person.men.all() >>> Person.women.all() >>> Person.people.all() ϋ˜˚݋ಂɧ
67. Execute raw SQL queries ϋ˜˚݋ಂɧ
68. Django DB objects ϋ˜˚݋ಂɧ
69. connection object cursor object cursor.execute() cursor.fetchone() / cursor.fetchall() Implement the Python DB-API (PEP-0249) Django DB objects ϋ˜˚݋ಂɧ
70. Execute raw SQL queries >>> from django.db import connection >>> cursor = connection.cursor() >>> cursor.execute(""" ... SELECT DISTINCT first_name ... FROM people_person ... WHERE last_name = %s""", ['Lennon']) >>> row = cursor.fetchone() >>> print row ['John'] ϋ˜˚݋ಂɧ
71. Execute raw SQL queries class PersonManager(models.Manager): def first_names(self, last_name): cursor = connection.cursor() cursor.execute(""" SELECT DISTINCT first_name FROM people_person WHERE last_name = %s""", [last_name]) return [row[0] for row in cursor.fetchone()] class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) objects = PersonManager() ϋ˜˚݋ಂɧ
72. Execute raw SQL queries class PersonManager(models.Manager): def first_names(self, last_name): cursor = connection.cursor() cursor.execute(""" SELECT DISTINCT first_name FROM people_person WHERE last_name = %s""", [last_name]) return [row[0] for row in cursor.fetchone()] class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) objects = PersonManager() ϋ˜˚݋ಂɧ
73. Execute raw SQL queries class PersonManager(models.Manager): def first_names(self, last_name): cursor = connection.cursor() cursor.execute(""" SELECT DISTINCT first_name FROM people_person WHERE last_name = %s""", [last_name]) return [row[0] for row in cursor.fetchone()] class Person(models.Model): first_name = models.CharField(max_length=50) last_name = models.CharField(max_length=50) objects = PersonManager() ϋ˜˚݋ಂɧ
74. Execute raw SQL queries >>> Person.objects.first_names('Lennon') ['John', 'Cynthia'] ϋ˜˚݋ಂɧ
75. More about Managers ϋ˜˚݋ಂɧ
76. As mentioned previously... ϋ˜˚݋ಂɧ
77. Business logic encapsulation Add custom Managers Override default Manager with custom methods ϋ˜˚݋ಂɧ
78. Add custom Managers class IncompleteTodoManager(models.Manager): def get_query_set(self): return super(TodoManager, self).get_query_set().filter(is_done=False) class HighPriorityTodoManager(models.Manager): def get_query_set(self): return super(TodoManager, self).get_query_set().filter(priority=1) class Todo(models.Model): content = models.CharField(max_length=100) # other fields go here.. objects = models.Manager() # the default manager # attach our custom managers: incomplete = models.IncompleteTodoManager() high_priority = models.HighPriorityTodoManager() ϋ˜˚݋ಂɧ
79. Add custom Managers class IncompleteTodoManager(models.Manager): def get_query_set(self): return super(TodoManager, self).get_query_set().filter(is_done=False) class HighPriorityTodoManager(models.Manager): def get_query_set(self): return super(TodoManager, self).get_query_set().filter(priority=1) class Todo(models.Model): content = models.CharField(max_length=100) # other fields go here.. objects = models.Manager() # the default manager # attach our custom managers: incomplete = models.IncompleteTodoManager() high_priority = models.HighPriorityTodoManager() ϋ˜˚݋ಂɧ
80. Add custom Managers >>> Todo.incomplete.all() >>> Todo.high_priority.all() ϋ˜˚݋ಂɧ
81. But ϋ˜˚݋ಂɧ
82. Drawbacks Verbose Managers Cluttered model namespace Not chainable ϋ˜˚݋ಂɧ
83. Custom Manager methods ϋ˜˚݋ಂɧ
84. Custom Manager methods class TodoManager(models.Manager): def incomplete(self): return self.filter(is_done=False) def high_priority(self): return self.filter(priority=1) class Todo(models.Model): content = models.CharField(max_length=100) # other fields go here.. objects = TodoManager() ϋ˜˚݋ಂɧ
85. Custom Manager methods >>> Todo.objects.incomplete() >>> Todo.objects.high_priority() ϋ˜˚݋ಂɧ
86. But ϋ˜˚݋ಂɧ
87. Drawbacks Not chainable between custom methods. # It didn’t work ! >>> Todo.objects.incomplete().high_priority() ϋ˜˚݋ಂɧ
88. Custom QuerySets ϋ˜˚݋ಂɧ
89. Custom QuerySets class TodoQuerySet(models.query.QuerySet): def incomplete(self): return self.filter(is_done=False) def high_priority(self): return self.filter(priority=1) class TodoManager(models.Manager): def get_query_set(self): return TodoQuerySet(self.model, using=self._db) class Todo(models.Model): content = models.CharField(max_length=100) # other fields go here.. objects = TodoManager() ϋ˜˚݋ಂɧ
90. Custom QuerySets class TodoQuerySet(models.query.QuerySet): def incomplete(self): return self.filter(is_done=False) def high_priority(self): return self.filter(priority=1) class TodoManager(models.Manager): def get_query_set(self): return TodoQuerySet(self.model, using=self._db) class Todo(models.Model): content = models.CharField(max_length=100) # other fields go here.. objects = TodoManager() ϋ˜˚݋ಂɧ
91. Custom QuerySets >>> Todo.objects.get_query_set().incomplete() >>> Todo.objects.get_query_set().high_priority() >>> # (or) >>> Todo.objects.all().incomplete() >>> Todo.objects.all().high_priority() >>> # Chainable !!! >>> Todo.objects.all().incomplete().high_priority() ϋ˜˚݋ಂɧ
92. But ϋ˜˚݋ಂɧ
93. Custom QuerySets >>> Todo.objects.get_query_set().incomplete() >>> Todo.objects.get_query_set().high_priority() >>> # (or) >>> Todo.objects.all().incomplete() >>> Todo.objects.all().high_priority() >>> # Chainable !!! >>> Todo.objects.all().incomplete().high_priority() ϋ˜˚݋ಂɧ
94. Custom QuerySets >>> Todo.objects.get_query_set().incomplete() >>> Todo.objects.get_query_set().high_priority() >>> # (or) >>> Todo.objects.all().incomplete() >>> Todo.objects.all().high_priority() >>> # Chainable !!! >>> Todo.objects.all().incomplete().high_priority() Ug== Ugly !! ϋ˜˚݋ಂɧ
95. Proxy everything !! ϋ˜˚݋ಂɧ
96. Proxy everything !! class TodoQuerySet(models.query.QuerySet): def incomplete(self): return self.filter(is_done=False) def high_priority(self): return self.filter(priority=1) class TodoManager(models.Manager): def get_query_set(self): return TodoQuerySet(self.model, using=self._db) def incomplete(self): return self.get_query_set().incomplete() def high_priority(self): return self.get_query_set().high_priority() ϋ˜˚݋ಂɧ
97. Proxy everything !! class TodoQuerySet(models.query.QuerySet): def incomplete(self): return self.filter(is_done=False) def high_priority(self): return self.filter(priority=1) class TodoManager(models.Manager): def get_query_set(self): return TodoQuerySet(self.model, using=self._db) def incomplete(self): return self.get_query_set().incomplete() def high_priority(self): return self.get_query_set().high_priority() ϋ˜˚݋ಂɧ
98. Proxy everything !! >>> Todo.objects.incomplete().high_priority() # Perfect !! ϋ˜˚݋ಂɧ
99. Thank you ϋ˜˚݋ಂɧ