tutorial01.txt 29 KB

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