tutorial01.txt 30 KB

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