tutorial01.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737
  1. =====================================
  2. Writing your first Django app, part 1
  3. =====================================
  4. Let's learn by example.
  5. Throughout this tutorial, we'll walk you through the creation of a basic
  6. poll application.
  7. It'll consist of two parts:
  8. * A public site that lets people view polls and vote in them.
  9. * An admin site that lets you add, change and delete polls.
  10. We'll assume you have :doc:`Django installed </intro/install>` already. You can
  11. tell Django is installed and which version by running the following command:
  12. .. code-block:: bash
  13. python -c "import django; print(django.get_version())"
  14. You should see either the version of your Django installation or an error
  15. telling "No module named django". Check also that the version number matches
  16. the version of this tutorial. If they don't match, you can refer to the
  17. tutorial for your version of Django or update Django to the newest version.
  18. See :doc:`How to install Django </topics/install>` for advice on how to remove
  19. older versions of Django and install a newer one.
  20. .. admonition:: Where to get help:
  21. If you're having trouble going through this tutorial, please post a message
  22. to `django-users`__ or drop by `#django on irc.freenode.net`__ to chat
  23. with other Django users who might be able to help.
  24. __ http://groups.google.com/group/django-users
  25. __ irc://irc.freenode.net/django
  26. Creating a project
  27. ==================
  28. If this is your first time using Django, you'll have to take care of some
  29. initial setup. Namely, you'll need to auto-generate some code that establishes a
  30. Django :term:`project` -- a collection of settings for an instance of Django,
  31. including database configuration, Django-specific options and
  32. application-specific settings.
  33. From the command line, ``cd`` into a directory where you'd like to store your
  34. code, then run the following command:
  35. .. code-block:: bash
  36. django-admin.py startproject mysite
  37. This will create a ``mysite`` directory in your current directory.
  38. .. admonition:: Script name may differ in distribution packages
  39. If you installed Django using a Linux distribution's package manager
  40. (e.g. apt-get or yum) ``django-admin.py`` may have been renamed to
  41. ``django-admin``. You may continue through this documentation by omitting
  42. ``.py`` from each command.
  43. .. admonition:: Mac OS X permissions
  44. If you're using Mac OS X, you may see the message "permission denied" when
  45. you try to run ``django-admin.py startproject``. This is because, on
  46. Unix-based systems like OS X, a file must be marked as "executable" before it
  47. can be run as a program. To do this, open Terminal.app and navigate (using
  48. the ``cd`` command) to the directory where :doc:`django-admin.py
  49. </ref/django-admin>` is installed, then run the command
  50. ``sudo chmod +x django-admin.py``.
  51. .. note::
  52. You'll need to avoid naming projects after built-in Python or Django
  53. components. In particular, this means you should avoid using names like
  54. ``django`` (which will conflict with Django itself) or ``test`` (which
  55. conflicts with a built-in Python package).
  56. :doc:`django-admin.py </ref/django-admin>` should be on your system path if you
  57. installed Django via ``python setup.py``. If it's not on your path, you can find
  58. it in ``site-packages/django/bin``, where ``site-packages`` is a directory
  59. within your Python installation. Consider symlinking to :doc:`django-admin.py
  60. </ref/django-admin>` from some place on your path, such as
  61. :file:`/usr/local/bin`.
  62. .. admonition:: Where should this code live?
  63. If your background is in PHP, you're probably used to putting code under the
  64. Web server's document root (in a place such as ``/var/www``). With Django,
  65. you don't do that. It's not a good idea to put any of this Python code
  66. within your Web server's document root, because it risks the possibility
  67. that people may be able to view your code over the Web. That's not good for
  68. security.
  69. Put your code in some directory **outside** of the document root, such as
  70. :file:`/home/mycode`.
  71. Let's look at what :djadmin:`startproject` created::
  72. mysite/
  73. manage.py
  74. mysite/
  75. __init__.py
  76. settings.py
  77. urls.py
  78. wsgi.py
  79. .. admonition:: Doesn't match what you see?
  80. The default project layout recently changed. If you're seeing a "flat"
  81. layout (with no inner :file:`mysite/` directory), you're probably using
  82. a version of Django that doesn't match this tutorial version. You'll
  83. want to either switch to the older tutorial or the newer Django version.
  84. These files are:
  85. * The outer :file:`mysite/` directory is just a container for your
  86. project. Its name doesn't matter to Django; you can rename it to anything
  87. you like.
  88. * :file:`manage.py`: A command-line utility that lets you interact with this
  89. Django project in various ways. You can read all the details about
  90. :file:`manage.py` in :doc:`/ref/django-admin`.
  91. * The inner :file:`mysite/` directory is the actual Python package for your
  92. project. Its name is the Python package name you'll need to use to import
  93. anything inside it (e.g. ``import mysite.settings``).
  94. * :file:`mysite/__init__.py`: An empty file that tells Python that this
  95. directory should be considered a Python package. (Read `more about
  96. packages`_ in the official Python docs if you're a Python beginner.)
  97. * :file:`mysite/settings.py`: Settings/configuration for this Django
  98. project. :doc:`/topics/settings` will tell you all about how settings
  99. work.
  100. * :file:`mysite/urls.py`: The URL declarations for this Django project; a
  101. "table of contents" of your Django-powered site. You can read more about
  102. URLs in :doc:`/topics/http/urls`.
  103. * :file:`mysite/wsgi.py`: An entry-point for WSGI-compatible webservers to
  104. serve your project. See :doc:`/howto/deployment/wsgi/index` for more details.
  105. .. _more about packages: http://docs.python.org/tutorial/modules.html#packages
  106. The development server
  107. ----------------------
  108. Let's verify this worked. Change into the outer :file:`mysite` directory, if
  109. you haven't already, and run the command ``python manage.py runserver``. You'll
  110. see the following output on the command line::
  111. Validating models...
  112. 0 errors found.
  113. Django version 1.4, using settings 'mysite.settings'
  114. Development server is running at http://127.0.0.1:8000/
  115. Quit the server with CONTROL-C.
  116. You've started the Django development server, a lightweight Web server written
  117. purely in Python. We've included this with Django so you can develop things
  118. rapidly, without having to deal with configuring a production server -- such as
  119. Apache -- until you're ready for production.
  120. Now's a good time to note: DON'T use this server in anything resembling a
  121. production environment. It's intended only for use while developing. (We're in
  122. the business of making Web frameworks, not Web servers.)
  123. Now that the server's running, visit http://127.0.0.1:8000/ with your Web
  124. browser. You'll see a "Welcome to Django" page, in pleasant, light-blue pastel.
  125. It worked!
  126. .. admonition:: Changing the port
  127. By default, the :djadmin:`runserver` command starts the development server
  128. on the internal IP at port 8000.
  129. If you want to change the server's port, pass
  130. it as a command-line argument. For instance, this command starts the server
  131. on port 8080:
  132. .. code-block:: bash
  133. python manage.py runserver 8080
  134. If you want to change the server's IP, pass it along with the port. So to
  135. listen on all public IPs (useful if you want to show off your work on other
  136. computers), use:
  137. .. code-block:: bash
  138. python manage.py runserver 0.0.0.0:8000
  139. Full docs for the development server can be found in the
  140. :djadmin:`runserver` reference.
  141. Database setup
  142. --------------
  143. Now, edit :file:`mysite/settings.py`. It's a normal Python module with
  144. module-level variables representing Django settings. Change the
  145. following keys in the :setting:`DATABASES` ``'default'`` item to match
  146. your database connection settings.
  147. * :setting:`ENGINE <DATABASE-ENGINE>` -- Either
  148. ``'django.db.backends.postgresql_psycopg2'``,
  149. ``'django.db.backends.mysql'``, ``'django.db.backends.sqlite3'`` or
  150. ``'django.db.backends.oracle'``. Other backends are :setting:`also available
  151. <DATABASE-ENGINE>`.
  152. * :setting:`NAME` -- The name of your database. If you're using
  153. SQLite, the database will be a file on your computer; in that
  154. case, :setting:`NAME` should be the full absolute path,
  155. including filename, of that file. If the file doesn't exist, it
  156. will automatically be created when you synchronize the database
  157. for the first time (see below).
  158. When specifying the path, always use forward slashes, even on
  159. Windows (e.g. ``C:/homes/user/mysite/sqlite3.db``).
  160. * :setting:`USER` -- Your database username (not used for SQLite).
  161. * :setting:`PASSWORD` -- Your database password (not used for
  162. SQLite).
  163. * :setting:`HOST` -- The host your database is on. Leave this as
  164. an empty string if your database server is on the same physical
  165. machine (not used for SQLite).
  166. If you're new to databases, we recommend simply using SQLite by setting
  167. :setting:`ENGINE` to ``'django.db.backends.sqlite3'`` and :setting:`NAME` to
  168. the place where you'd like to store the database. SQLite is included in Python,
  169. so you won't need to install anything else to support your database.
  170. .. note::
  171. If you're using PostgreSQL or MySQL, make sure you've created a database by
  172. this point. Do that with "``CREATE DATABASE database_name;``" within your
  173. database's interactive prompt.
  174. If you're using SQLite, you don't need to create anything beforehand - the
  175. database file will be created automatically when it is needed.
  176. While you're editing :file:`settings.py`, set :setting:`TIME_ZONE` to your
  177. time zone. The default value is the Central time zone in the U.S. (Chicago).
  178. Also, note the :setting:`INSTALLED_APPS` setting toward the bottom of
  179. the file. That holds the names of all Django applications that are
  180. activated in this Django instance. Apps can be used in multiple projects, and
  181. you can package and distribute them for use by others in their projects.
  182. By default, :setting:`INSTALLED_APPS` contains the following apps, all of which
  183. come with Django:
  184. * :mod:`django.contrib.auth` -- An authentication system.
  185. * :mod:`django.contrib.contenttypes` -- A framework for content types.
  186. * :mod:`django.contrib.sessions` -- A session framework.
  187. * :mod:`django.contrib.sites` -- A framework for managing multiple sites
  188. with one Django installation.
  189. * :mod:`django.contrib.messages` -- A messaging framework.
  190. * :mod:`django.contrib.staticfiles` -- A framework for managing
  191. static files.
  192. These applications are included by default as a convenience for the common case.
  193. Each of these applications makes use of at least one database table, though,
  194. so we need to create the tables in the database before we can use them. To do
  195. that, run the following command:
  196. .. code-block:: bash
  197. python manage.py syncdb
  198. The :djadmin:`syncdb` command looks at the :setting:`INSTALLED_APPS` setting and
  199. creates any necessary database tables according to the database settings in your
  200. :file:`settings.py` file. You'll see a message for each database table it
  201. creates, and you'll get a prompt asking you if you'd like to create a superuser
  202. account for the authentication system. Go ahead and do that.
  203. If you're interested, run the command-line client for your database and type
  204. ``\dt`` (PostgreSQL), ``SHOW TABLES;`` (MySQL), or ``.schema`` (SQLite) to
  205. display the tables Django created.
  206. .. admonition:: For the minimalists
  207. Like we said above, the default applications are included for the common
  208. case, but not everybody needs them. If you don't need any or all of them,
  209. feel free to comment-out or delete the appropriate line(s) from
  210. :setting:`INSTALLED_APPS` before running :djadmin:`syncdb`. The
  211. :djadmin:`syncdb` command will only create tables for apps in
  212. :setting:`INSTALLED_APPS`.
  213. .. _creating-models:
  214. Creating models
  215. ===============
  216. Now that your environment -- a "project" -- is set up, you're set to start
  217. doing work.
  218. Each application you write in Django consists of a Python package, somewhere
  219. on your `Python path`_, that follows a certain convention. Django comes with a
  220. utility that automatically generates the basic directory structure of an app,
  221. so you can focus on writing code rather than creating directories.
  222. .. admonition:: Projects vs. apps
  223. What's the difference between a project and an app? An app is a Web
  224. application that does something -- e.g., a Weblog system, a database of
  225. public records or a simple poll app. A project is a collection of
  226. configuration and apps for a particular Web site. A project can contain
  227. multiple apps. An app can be in multiple projects.
  228. Your apps can live anywhere on your `Python path`_. In this tutorial, we'll
  229. create our poll app right next to your :file:`manage.py` file so that it can be
  230. imported as its own top-level module, rather than a submodule of ``mysite``.
  231. To create your app, make sure you're in the same directory as :file:`manage.py`
  232. and type this command:
  233. .. code-block:: bash
  234. python manage.py startapp polls
  235. That'll create a directory :file:`polls`, which is laid out like this::
  236. polls/
  237. __init__.py
  238. models.py
  239. tests.py
  240. views.py
  241. This directory structure will house the poll application.
  242. The first step in writing a database Web app in Django is to define your models
  243. -- essentially, your database layout, with additional metadata.
  244. .. admonition:: Philosophy
  245. A model is the single, definitive source of data about your data. It contains
  246. the essential fields and behaviors of the data you're storing. Django follows
  247. the :ref:`DRY Principle <dry>`. The goal is to define your data model in one
  248. place and automatically derive things from it.
  249. In our simple poll app, we'll create two models: ``Poll`` and ``Choice``.
  250. A ``Poll`` has a question and a publication date. A ``Choice`` has two fields:
  251. the text of the choice and a vote tally. Each ``Choice`` is associated with a
  252. ``Poll``.
  253. These concepts are represented by simple Python classes. Edit the
  254. :file:`polls/models.py` file so it looks like this::
  255. from django.db import models
  256. class Poll(models.Model):
  257. question = models.CharField(max_length=200)
  258. pub_date = models.DateTimeField('date published')
  259. class Choice(models.Model):
  260. poll = models.ForeignKey(Poll)
  261. choice_text = models.CharField(max_length=200)
  262. votes = models.IntegerField()
  263. The code is straightforward. Each model is represented by a class that
  264. subclasses :class:`django.db.models.Model`. Each model has a number of class
  265. variables, each of which represents a database field in the model.
  266. Each field is represented by an instance of a :class:`~django.db.models.Field`
  267. class -- e.g., :class:`~django.db.models.CharField` for character fields and
  268. :class:`~django.db.models.DateTimeField` for datetimes. This tells Django what
  269. type of data each field holds.
  270. The name of each :class:`~django.db.models.Field` instance (e.g. ``question`` or
  271. ``pub_date`` ) is the field's name, in machine-friendly format. You'll use this
  272. value in your Python code, and your database will use it as the column name.
  273. You can use an optional first positional argument to a
  274. :class:`~django.db.models.Field` to designate a human-readable name. That's used
  275. in a couple of introspective parts of Django, and it doubles as documentation.
  276. If this field isn't provided, Django will use the machine-readable name. In this
  277. example, we've only defined a human-readable name for ``Poll.pub_date``. For all
  278. other fields in this model, the field's machine-readable name will suffice as
  279. its human-readable name.
  280. Some :class:`~django.db.models.Field` classes have required elements.
  281. :class:`~django.db.models.CharField`, for example, requires that you give it a
  282. :attr:`~django.db.models.Field.max_length`. That's used not only in the database
  283. schema, but in validation, as we'll soon see.
  284. Finally, note a relationship is defined, using
  285. :class:`~django.db.models.ForeignKey`. That tells Django each ``Choice`` is related
  286. to a single ``Poll``. Django supports all the common database relationships:
  287. many-to-ones, many-to-manys and one-to-ones.
  288. .. _`Python path`: http://docs.python.org/tutorial/modules.html#the-module-search-path
  289. Activating models
  290. =================
  291. That small bit of model code gives Django a lot of information. With it, Django
  292. is able to:
  293. * Create a database schema (``CREATE TABLE`` statements) for this app.
  294. * Create a Python database-access API for accessing ``Poll`` and ``Choice`` objects.
  295. But first we need to tell our project that the ``polls`` app is installed.
  296. .. admonition:: Philosophy
  297. Django apps are "pluggable": You can use an app in multiple projects, and
  298. you can distribute apps, because they don't have to be tied to a given
  299. Django installation.
  300. Edit the :file:`settings.py` file again, and change the
  301. :setting:`INSTALLED_APPS` setting to include the string ``'polls'``. So
  302. it'll look like this::
  303. INSTALLED_APPS = (
  304. 'django.contrib.auth',
  305. 'django.contrib.contenttypes',
  306. 'django.contrib.sessions',
  307. 'django.contrib.sites',
  308. 'django.contrib.messages',
  309. 'django.contrib.staticfiles',
  310. # Uncomment the next line to enable the admin:
  311. # 'django.contrib.admin',
  312. # Uncomment the next line to enable admin documentation:
  313. # 'django.contrib.admindocs',
  314. 'polls',
  315. )
  316. Now Django knows to include the ``polls`` app. Let's run another
  317. command:
  318. .. code-block:: bash
  319. python manage.py sql polls
  320. You should see something similar to the following (the ``CREATE TABLE`` SQL
  321. statements for the polls app):
  322. .. code-block:: sql
  323. BEGIN;
  324. CREATE TABLE "polls_poll" (
  325. "id" serial NOT NULL PRIMARY KEY,
  326. "question" varchar(200) NOT NULL,
  327. "pub_date" timestamp with time zone NOT NULL
  328. );
  329. CREATE TABLE "polls_choice" (
  330. "id" serial NOT NULL PRIMARY KEY,
  331. "poll_id" integer NOT NULL REFERENCES "polls_poll" ("id") DEFERRABLE INITIALLY DEFERRED,
  332. "choice_text" varchar(200) NOT NULL,
  333. "votes" integer NOT NULL
  334. );
  335. COMMIT;
  336. Note the following:
  337. * The exact output will vary depending on the database you are using.
  338. * Table names are automatically generated by combining the name of the app
  339. (``polls``) and the lowercase name of the model -- ``poll`` and
  340. ``choice``. (You can override this behavior.)
  341. * Primary keys (IDs) are added automatically. (You can override this, too.)
  342. * By convention, Django appends ``"_id"`` to the foreign key field name.
  343. (Yes, you can override this, as well.)
  344. * The foreign key relationship is made explicit by a ``REFERENCES``
  345. statement.
  346. * It's tailored to the database you're using, so database-specific field
  347. types such as ``auto_increment`` (MySQL), ``serial`` (PostgreSQL), or
  348. ``integer primary key`` (SQLite) are handled for you automatically. Same
  349. goes for quoting of field names -- e.g., using double quotes or single
  350. quotes. The author of this tutorial runs PostgreSQL, so the example
  351. output is in PostgreSQL syntax.
  352. * The :djadmin:`sql` command doesn't actually run the SQL in your database -
  353. it just prints it to the screen so that you can see what SQL Django thinks
  354. is required. If you wanted to, you could copy and paste this SQL into your
  355. database prompt. However, as we will see shortly, Django provides an
  356. easier way of committing the SQL to the database.
  357. If you're interested, also run the following commands:
  358. * :djadmin:`python manage.py validate <validate>` -- Checks for any errors
  359. in the construction of your models.
  360. * :djadmin:`python manage.py sqlcustom polls <sqlcustom>` -- Outputs any
  361. :ref:`custom SQL statements <initial-sql>` (such as table modifications or
  362. constraints) that are defined for the application.
  363. * :djadmin:`python manage.py sqlclear polls <sqlclear>` -- Outputs the
  364. necessary ``DROP TABLE`` statements for this app, according to which
  365. tables already exist in your database (if any).
  366. * :djadmin:`python manage.py sqlindexes polls <sqlindexes>` -- Outputs the
  367. ``CREATE INDEX`` statements for this app.
  368. * :djadmin:`python manage.py sqlall polls <sqlall>` -- A combination of all
  369. the SQL from the :djadmin:`sql`, :djadmin:`sqlcustom`, and
  370. :djadmin:`sqlindexes` commands.
  371. Looking at the output of those commands can help you understand what's actually
  372. happening under the hood.
  373. Now, run :djadmin:`syncdb` again to create those model tables in your database:
  374. .. code-block:: bash
  375. python manage.py syncdb
  376. The :djadmin:`syncdb` command runs the SQL from :djadmin:`sqlall` on your
  377. database for all apps in :setting:`INSTALLED_APPS` that don't already exist in
  378. your database. This creates all the tables, initial data and indexes for any
  379. apps you've added to your project since the last time you ran syncdb.
  380. :djadmin:`syncdb` can be called as often as you like, and it will only ever
  381. create the tables that don't exist.
  382. Read the :doc:`django-admin.py documentation </ref/django-admin>` for full
  383. information on what the ``manage.py`` utility can do.
  384. Playing with the API
  385. ====================
  386. Now, let's hop into the interactive Python shell and play around with the free
  387. API Django gives you. To invoke the Python shell, use this command:
  388. .. code-block:: bash
  389. python manage.py shell
  390. We're using this instead of simply typing "python", because :file:`manage.py`
  391. sets the ``DJANGO_SETTINGS_MODULE`` environment variable, which gives Django
  392. the Python import path to your :file:`settings.py` file.
  393. .. admonition:: Bypassing manage.py
  394. If you'd rather not use :file:`manage.py`, no problem. Just set the
  395. ``DJANGO_SETTINGS_MODULE`` environment variable to ``mysite.settings`` and
  396. run ``python`` from the same directory :file:`manage.py` is in (or ensure
  397. that directory is on the Python path, so that ``import mysite`` works).
  398. For more information on all of this, see the :doc:`django-admin.py
  399. documentation </ref/django-admin>`.
  400. Once you're in the shell, explore the :doc:`database API </topics/db/queries>`::
  401. >>> from polls.models import Poll, Choice # Import the model classes we just wrote.
  402. # No polls are in the system yet.
  403. >>> Poll.objects.all()
  404. []
  405. # Create a new Poll.
  406. # Support for time zones is enabled in the default settings file, so
  407. # Django expects a datetime with tzinfo for pub_date. Use timezone.now()
  408. # instead of datetime.datetime.now() and it will do the right thing.
  409. >>> from django.utils import timezone
  410. >>> p = Poll(question="What's new?", pub_date=timezone.now())
  411. # Save the object into the database. You have to call save() explicitly.
  412. >>> p.save()
  413. # Now it has an ID. Note that this might say "1L" instead of "1", depending
  414. # on which database you're using. That's no biggie; it just means your
  415. # database backend prefers to return integers as Python long integer
  416. # objects.
  417. >>> p.id
  418. 1
  419. # Access database columns via Python attributes.
  420. >>> p.question
  421. "What's new?"
  422. >>> p.pub_date
  423. datetime.datetime(2012, 2, 26, 13, 0, 0, 775217, tzinfo=<UTC>)
  424. # Change values by changing the attributes, then calling save().
  425. >>> p.question = "What's up?"
  426. >>> p.save()
  427. # objects.all() displays all the polls in the database.
  428. >>> Poll.objects.all()
  429. [<Poll: Poll object>]
  430. Wait a minute. ``<Poll: Poll object>`` is, utterly, an unhelpful representation
  431. of this object. Let's fix that by editing the polls model (in the
  432. ``polls/models.py`` file) and adding a
  433. :meth:`~django.db.models.Model.__unicode__` method to both ``Poll`` and
  434. ``Choice``::
  435. class Poll(models.Model):
  436. # ...
  437. def __unicode__(self):
  438. return self.question
  439. class Choice(models.Model):
  440. # ...
  441. def __unicode__(self):
  442. return self.choice_text
  443. It's important to add :meth:`~django.db.models.Model.__unicode__` methods to
  444. your models, not only for your own sanity when dealing with the interactive
  445. prompt, but also because objects' representations are used throughout Django's
  446. automatically-generated admin.
  447. .. admonition:: Why :meth:`~django.db.models.Model.__unicode__` and not
  448. :meth:`~django.db.models.Model.__str__`?
  449. If you're familiar with Python, you might be in the habit of adding
  450. :meth:`~django.db.models.Model.__str__` methods to your classes, not
  451. :meth:`~django.db.models.Model.__unicode__` methods. We use
  452. :meth:`~django.db.models.Model.__unicode__` here because Django models deal
  453. with Unicode by default. All data stored in your database is converted to
  454. Unicode when it's returned.
  455. Django models have a default :meth:`~django.db.models.Model.__str__` method
  456. that calls :meth:`~django.db.models.Model.__unicode__` and converts the
  457. result to a UTF-8 bytestring. This means that ``unicode(p)`` will return a
  458. Unicode string, and ``str(p)`` will return a normal string, with characters
  459. encoded as UTF-8.
  460. If all of this is gibberish to you, just remember to add
  461. :meth:`~django.db.models.Model.__unicode__` methods to your models. With any
  462. luck, things should Just Work for you.
  463. Note these are normal Python methods. Let's add a custom method, just for
  464. demonstration::
  465. import datetime
  466. from django.utils import timezone
  467. # ...
  468. class Poll(models.Model):
  469. # ...
  470. def was_published_recently(self):
  471. return self.pub_date >= timezone.now() - datetime.timedelta(days=1)
  472. Note the addition of ``import datetime`` and ``from django.utils import
  473. timezone``, to reference Python's standard :mod:`datetime` module and Django's
  474. time-zone-related utilities in :mod:`django.utils.timezone`, respectively. If
  475. you aren't familiar with time zone handling in Python, you can learn more in
  476. the :doc:`time zone support docs </topics/i18n/timezones>`.
  477. Save these changes and start a new Python interactive shell by running
  478. ``python manage.py shell`` again::
  479. >>> from polls.models import Poll, Choice
  480. # Make sure our __unicode__() addition worked.
  481. >>> Poll.objects.all()
  482. [<Poll: What's up?>]
  483. # Django provides a rich database lookup API that's entirely driven by
  484. # keyword arguments.
  485. >>> Poll.objects.filter(id=1)
  486. [<Poll: What's up?>]
  487. >>> Poll.objects.filter(question__startswith='What')
  488. [<Poll: What's up?>]
  489. # Get the poll whose year is 2012.
  490. >>> Poll.objects.get(pub_date__year=2012)
  491. <Poll: What's up?>
  492. >>> Poll.objects.get(id=2)
  493. Traceback (most recent call last):
  494. ...
  495. DoesNotExist: Poll matching query does not exist. Lookup parameters were {'id': 2}
  496. # Lookup by a primary key is the most common case, so Django provides a
  497. # shortcut for primary-key exact lookups.
  498. # The following is identical to Poll.objects.get(id=1).
  499. >>> Poll.objects.get(pk=1)
  500. <Poll: What's up?>
  501. # Make sure our custom method worked.
  502. >>> p = Poll.objects.get(pk=1)
  503. >>> p.was_published_recently()
  504. True
  505. # Give the Poll a couple of Choices. The create call constructs a new
  506. # Choice object, does the INSERT statement, adds the choice to the set
  507. # of available choices and returns the new Choice object. Django creates
  508. # a set to hold the "other side" of a ForeignKey relation
  509. # (e.g. a poll's choices) which can be accessed via the API.
  510. >>> p = Poll.objects.get(pk=1)
  511. # Display any choices from the related object set -- none so far.
  512. >>> p.choice_set.all()
  513. []
  514. # Create three choices.
  515. >>> p.choice_set.create(choice_text='Not much', votes=0)
  516. <Choice: Not much>
  517. >>> p.choice_set.create(choice_text='The sky', votes=0)
  518. <Choice: The sky>
  519. >>> c = p.choice_set.create(choice_text='Just hacking again', votes=0)
  520. # Choice objects have API access to their related Poll objects.
  521. >>> c.poll
  522. <Poll: What's up?>
  523. # And vice versa: Poll objects get access to Choice objects.
  524. >>> p.choice_set.all()
  525. [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]
  526. >>> p.choice_set.count()
  527. 3
  528. # The API automatically follows relationships as far as you need.
  529. # Use double underscores to separate relationships.
  530. # This works as many levels deep as you want; there's no limit.
  531. # Find all Choices for any poll whose pub_date is in 2012.
  532. >>> Choice.objects.filter(poll__pub_date__year=2012)
  533. [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]
  534. # Let's delete one of the choices. Use delete() for that.
  535. >>> c = p.choice_set.filter(choice_text__startswith='Just hacking')
  536. >>> c.delete()
  537. For more information on model relations, see :doc:`Accessing related objects
  538. </ref/models/relations>`. For more on how to use double underscores to perform
  539. field lookups via the API, see :ref:`Field lookups <field-lookups-intro>`. For
  540. full details on the database API, see our :doc:`Database API reference
  541. </topics/db/queries>`.
  542. When you're comfortable with the API, read :doc:`part 2 of this tutorial
  543. </intro/tutorial02>` to get Django's automatic admin working.