-
Notifications
You must be signed in to change notification settings - Fork 7
/
chap11.xml
1894 lines (1610 loc) · 71.8 KB
/
chap11.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[
<!ENTITY BASEID "djangobook.chap11">
]>
<chapter lang="ru" id="&BASEID;">
<title id="&BASEID;.title">
Генерация данных, отличных от HTML
</title>
<para>
Данная глава временно взята из первой версии книги и подлежит
корректировке. Вы можете помочь с этим!
</para>
<para>
Перевод © Попов Руслан <radz • yandex • ru>
</para>
<para>
Обычно, говоря о разработке веб сайтов, мы имеем в виду генерацию
HTML. Конечно, кроме HTML в сфере веба существует ещё много
чего. Мы используем веб для распространения информации во всех
форматах: RSS, PDF, изображения и так далее.
</para>
<para>
До сих пор мы рассматривали общий случай создания HTML, но в этой
главе мы пойдём другим путём и рассмотрим возможности Django для
генерации других видов контента.
</para>
<para>
Django обладает удобными встроенными инструментами, которые можно
использовать для создания контента, отличного от HTML:
<itemizedlist>
<listitem>
<para>
Рассылки RSS/Atom.
</para>
</listitem>
<listitem>
<para>
Карты сайтов (в XML формате, разработанном Google, который
очень помогает поисковым машинам).
</para>
</listitem>
</itemizedlist>
</para>
<para>
Мы исследуем каждый из этих инструментов немного позже, сначала
рассмотрим основные принципы.
</para>
<section id="&BASEID;.basics">
<title id="&BASEID;.basics.title">
Основы: представление и MIME-типы
</title>
<para>
Помните из главы <quote><xref linkend="djangobook.chap03"
endterm="djangobook.chap03.title"/></quote> это:
</para>
<para>
<emphasis>Функция представления, или просто представление,
является функцией языка Python, которая принимает запрос и
возвращает отклик. Этим откликом может быть HTML контент веб
страницы, перенаправление на другую страницу, ошибка 404, XML
документ, изображение или что-нибудь ещё.</emphasis>
</para>
<para>
Более формально, функция представления Django должна:
<itemizedlist>
<listitem>
<para>
Принимать экземпляр класса
<classname>HttpRequest</classname> в качестве первого
аргумента.
</para>
</listitem>
<listitem>
<para>
Возвращать экземпляр класса
<classname>HttpResponse</classname>.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Возможность возвращать из представление не-HTML данные лежит в
классе <classname>HttpResponse</classname>, а точнее в аргументе
конструктора <varname>mimetype</varname>. Определяя MIME-тип, мы
можем указывать браузеру формат возвращаемых данных.
</para>
<para>
Например, рассмотрим представление, которое возвращает
изображение в формате PNG. Для простоты мы просто читаем файл с
диска:
<screen>
<![CDATA[
from django.http import HttpResponse
def my_image(request):
image_data = open("/path/to/my/image.png", "rb").read()
return HttpResponse(image_data, mimetype="image/png")
]]>
</screen>
</para>
<para>
Вот так! Если вы замените путь до файла в вызове функции
<function>open()</function> на путь до реального изображения, вы
можете использовать это очень простое представление для
обработки изображений, а броузер будет отображает их корректно.
</para>
<para>
Ещё следует помнить о том, что объекты
<classname>HttpResponse</classname> работают через стандартный
API для работы с файлами. Это означает, что вы можете
использовать <classname>HttpResponse</classname> в любом месте,
где требуется обработать файл.
</para>
<para>
Для того, чтобы увидеть как всё это работает, давайте рассмотрим
как Django генерирует CSV.
</para>
</section>
<section id="&BASEID;.csv">
<title id="&BASEID;.csv.title">
Генерация CSV
</title>
<para>
CSV является простым форматом данных, который обычно
используется программным обеспечением для работы с электронными
таблицами. Формат описывает набор записей таблицы, в котором
каждая ячейка ряда отделена друг от друга запятой (CSV —
это аббревиатура для <emphasis>comma-separated
values</emphasis>). Например, ниже представлены некоторые данные
на "недисциплинированных" пассажиров авиакомпании в формате CSV:
<screen>
<![CDATA[
Year,Unruly Airline Passengers
1995,146
1996,184
1997,235
1998,200
1999,226
2000,251
2001,299
2002,273
2003,281
2004,304
2005,203
]]>
</screen>
</para>
<para>
<note>
<para>
Вышеприведённый пример содержит реальные числа. Они были
любезно предоставлены Федеральным Управлением Авиации
США. См. <ulink
url="http://www.faa.gov/data_statistics/passengers_cargo/unruly_passengers/"/>.
</para>
</note>
</para>
<para>
Несмотря на то, что CSV выглядит просто, он не является форматом
как таковым. Разные программные продукты создают и используют
различные варианты CSV, делая непростым его использование. К
счастью, Python поставляется со стандартной библиотекой для
работы с CSV.
</para>
<para>
По причине того, что модуль <token>csv</token> работает как
файлоподобные объекты, его можно использовать вместе с
<classname>HttpResponse</classname>:
<screen>
<![CDATA[
import csv
from django.http import HttpResponse
# Количество недисциплинированных пассажиров за каждый год диапазона 1995 - 2005.
# В реальном приложении эта информация будет получена из базы данных.
UNRULY_PASSENGERS = [146,184,235,200,226,251,299,273,281,304,203]
def unruly_passengers_csv(request):
# Создаём объект HttpResponse с соответствующим CSV заголовком.
response = HttpResponse(mimetype='text/csv')
response['Content-Disposition'] = 'attachment; filename=unruly.csv'
# Создаём объект для записи CSV, используя HttpResponse как "файл"
writer = csv.writer(response)
writer.writerow(['Year', 'Unruly Airline Passengers'])
for (year, num) in zip(range(1995, 2006), UNRULY_PASSENGERS):
writer.writerow([year, num])
return response
]]>
</screen>
</para>
<para>
Код и комментарии должны быть достаточно очевидными, но
некоторые моменты требует особого упоминания:
<itemizedlist>
<listitem>
<para>
Отклик имеет отличный от <token>text/html</token> MIME-тип
— <token>text/csv</token>. Это указывает браузерам,
что передаваемый документ является CSV файлом.
</para>
</listitem>
<listitem>
<para>
Отклик получает дополнительный заголовок
<quote>Content-Disposition</quote>, который содержит имя
CSV файла. Этот заголовок, а точнее часть вложения,
указывает браузеру, что необходимо запросить у
пользователя место куда надо сохранить файл, а не
отображать его на экране. Имя файла может быть
произвольным, назовите его как пожелаете с помощью
диалогового окна <quote>Сохранить как ...</quote>.
</para>
</listitem>
<listitem>
<para>
Подключение к API генерации CSV несложно: просто передайте
<token>response</token> в качестве первого аргумента для
<function>csv.writer</function>. Функция
<function>csv.writer</function> ожидает файлоподобный
объект и объекты <classname>HttpResponse</classname>
соответствуют этому требованию.
</para>
</listitem>
<listitem>
<para>
Для каждой записи в вашем CSV файле требуется вызывать
функцию <function>writer.writerow</function>, передавая ей
итерационный объект, подобный списку или кортежу.
</para>
</listitem>
<listitem>
<para>
Модуль <token>csv</token> заботится об экранировании
данных. Просто передавайте информацию в функцию
<function>writerow()</function> и она сделает всё
правильно.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Это основной шаблон поведения в случае когда вам требуется
вернуть информацию отличную от HTML: создайте объект
<classname>HttpResponse</classname> (с определённым MIME-типом),
передайте его чему-нибудь, ожидающему файл и затем возвратите
отклик.
</para>
<para>
Давайте рассмотрим ещё несколько примеров.
</para>
</section>
<section id="&BASEID;.pdf">
<title id="&BASEID;.pdf.title">
Генерация PDF
</title>
<para>
Формат PDF, разработанный компанией Adobe, используется для
отображения печатных документов с полным попиксельным
форматированием, встроенными шрифтами и двумерной векторной
графикой. Вы можете рассматривать PDF документ в качестве
электронного эквивалента напечатанного документа. В реальности,
PDF документ довольно часто используется для передачи
информации, которую затем требуется напечатать.
</para>
<para>
Вы можете легко создавать PDF документы с помощью Python и
Django благодаря отличной открытой библиотеке <ulink
url="http://www.reportlab.org/rl_toolkit.html">ReportLab</ulink>. Преимущество
динамического создания PDF документов заключается в том, что вы
можете изменять его различными способами, например, разная
информация для разных пользователей.
</para>
<para>
Например, мы используем Django и ReportLab на сайте <ulink
url="KUSports.com"/> для генерации NCAA программ соревнований.
</para>
<section id="&BASEID;.pdf.install-reportlab">
<title id="&BASEID;.pdf.install-reportlab.title">
Установка ReportLab
</title>
<para>
Однако перед тем как сгенерировать PDF документ вам
потребуется установить ReportLab. Это несложно: просто
скачайте и установите библиотеку с <ulink
url="http://www.reportlab.org/downloads.html"/>.
</para>
<para>
Руководство пользователя (доступное только в виде PDF) на
<ulink url="http://www.reportlab.org/rsrc/userguide.pdf"/>
содержит дополнительные инструкции по установке.
</para>
<para>
<note>
<para>
При использовании современного дистрибутива Linux, вы
можете проверить наличие этой библиотеки в репозиториях
операционной системы. Большинство репозиториев содержит
данную библиотеку.
</para>
<para>
Например, если вы используете (обалденный) дистрибутив
Ubuntu, установка библиотеки крайне проста:
<screen>
apt-get install python-reportlab
</screen>
</para>
</note>
</para>
<para>
Проверьте установку с помощью импортирования библиотеки в
интерактивном интерпретаторе Python:
<screen>
<![CDATA[
>>> import reportlab
]]>
</screen>
</para>
<para>
Если эта команда не вызывает никаких ошибок, значит установка
библиотеки прошла успешно.
</para>
</section>
<section id="&BASEID;.pdf.writing-view">
<title id="&BASEID;.pdf.writing-view.title">
Создание представления
</title>
<para>
Аналогично случаю с CSV, динамическое создание PDF объектов с
помощью Django является несложным, по причине того, что API
библиотеки ReportLab работает как файлоподобный объект.
</para>
<para>
Ниже представлен пример <quote>Hello World</quote>:
<screen>
<![CDATA[
from reportlab.pdfgen import canvas
from django.http import HttpResponse
def hello_pdf(request):
# Создаём объект HttpResponse с соответствующим PDF заголовком.
response = HttpResponse(mimetype='application/pdf')
response['Content-Disposition'] = 'attachment; filename=hello.pdf'
# Создаём объект PDF, используя объект HttpResponse как файл.
p = canvas.Canvas(response)
# Выводим в PDF необходимую информацию. Вот так создаются PDF.
# Обратитесь к документации на ReportLab для подробностей.
p.drawString(100, 100, "Hello world.")
# Явно закрываем объект PDF.
p.showPage()
p.save()
return response
]]>
</screen>
</para>
<para>
А теперь несколько замечаний:
<itemizedlist>
<listitem>
<para>
В данном случае мы используем
<token>application/pdf</token> в качестве MIME-типа. Это
указывает браузеру, что документ является PDF файлом, а
не HTML. Если вы забудете указать эту информацию,
браузер проинтерпретирует документ как HTML файл и
вывалит кучу мусора на экран.
</para>
</listitem>
<listitem>
<para>
Подключение к ReportLab API несложно: просто передайте
<token>response</token> в качестве первого аргумента для
<function>canvas.Canvas</function>. Объект
<classname>Canvas</classname> ожидает файлоподобный
объект и объекты <classname>HttpResponse</classname>
соответствуют этому требованию.
</para>
</listitem>
<listitem>
<para>
Все вызовы дополнительных методов для создания PDF
документа производятся от PDF объекта
(см. <token>p</token> в коде), а не от
<token>response</token>.
</para>
</listitem>
<listitem>
<para>
Наконец надо вызвать функции
<function>showPage()</function> и
<function>save()</function> для PDF файла, иначе вы
получите испорченный PDF документ.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="&BASEID;.pdf.complex">
<title id="&BASEID;.pdf.complex.title">
Сложные PDF документы
</title>
<para>
Если вы создаёте сложный PDF документ (или любой большой объём
данных), рассмотрите возможность использования библиотеки
<token>cStringIO</token> в качестве временного хранилища для
вашего PDF файла. Библиотека <token>cStringIO</token>
предоставляет файлоподобный интерфейс, который написан на
языке C для достижения максимальной эффективности.
</para>
<para>
Перепишем предыдущий <quote>Hello World</quote> пример,
используя библиотеку <token>cStringIO</token>:
<screen>
<![CDATA[
from cStringIO import StringIO
from reportlab.pdfgen import canvas
from django.http import HttpResponse
def hello_pdf(request):
# Создаём объект HttpResponse с соответствующим PDF заголовком.
response = HttpResponse(mimetype='application/pdf')
response['Content-Disposition'] = 'attachment; filename=hello.pdf'
temp = StringIO()
# Создаём объект PDF, используя объект StringIO как файл.
p = canvas.Canvas(temp)
# Выводим в PDF необходимую информацию. Здесь генерируется содержимое PDF.
# Обратитесь к документации на ReportLab для подробностей.
p.drawString(100, 100, "Hello world.")
# Явно закрываем объект PDF.
p.showPage()
p.save()
# Получаем данные из буфера StringIO и пишем отклик.
response.write(temp.getvalue())
return response
]]>
</screen>
</para>
</section>
</section>
<section id="&BASEID;.other">
<title id="&BASEID;.other.title">
Другие возможности
</title>
<para>
Существует целый набор других типов данных, которые вы можете
генерировать с помощью Python. Ниже представлены некоторые идеи
и ссылки на библиотеки, которые вы можете использовать для их
реализации:
<itemizedlist>
<listitem>
<para>
<emphasis>ZIP файлы</emphasis>: Стандартная библиотека
Python поставляется с модулем <token>zipfile</token>,
который может читать и писать сжатые ZIP файлы. Вы можете
использовать этот модуль для предоставления по требованию
архивов с набором файлов или, возможно, сжимать большие
документы, когда это необходимо. Аналогично вы можете
предоставлять TAR файлы с помощью модуля
<token>tarfile</token> стандартной библиотеки.
</para>
</listitem>
<listitem>
<para>
<emphasis>Динамические изображения</emphasis>: графическая
библиотека Python, <ulink
url="http://www.pythonware.com/products/pil/">PIL</ulink>
— это фантастический набор инструментов для создания
изображений (в таких форматах как <token>PNG</token>,
<token>JPEG</token>, <token>GIF</token> и многих
других). Вы можете использовать её для автоматического
создания миниатюр изображений, объединения нескольких
изображений в единое или даже для онлайновой обработки
изображений.
</para>
</listitem>
<listitem>
<para>
<emphasis>Графики и диаграммы</emphasis>: Существует ряд
невероятно мощных библиотек Python для создания графиков и
диаграмм, которые вы можете использовать для генерации по
запросу различной графической информации. Мы не имеем
возможности привести здесь их список, укажем лишь
несколько:
<itemizedlist>
<listitem>
<para>
Библиотека <token>matplotlib</token> (<ulink
url="http://matplotlib.sourceforge.net/"/>) может
быть использована для создания высококачественных
графиков, аналогичных графиком из MatLab или
Methematica.
</para>
</listitem>
<listitem>
<para>
Библиотека <token>pygraphviz</token> (<ulink
url="https://networkx.lanl.gov/wiki/pygraphviz"/>),
которая является интерфейсом к <ulink
url="http://graphviz.org/">GraphViz</ulink>, может
быть использована для создания структурных диаграмм
графов и сетей
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</para>
<para>
В общем, любая библиотека языка Python, имеющая возможность
записи в файл может быть подключена к Django. Возможности при
этом бесконечны.
</para>
<para>
Мы рассмотрели основы создание отличной от HTML информации,
перейдём на другой уровень абстракции. Django поставляется с
некоторыми прикольными инструментами для генерации общих типов
не-HTML информации.
</para>
</section>
<section id="&BASEID;.rss">
<title id="&BASEID;.rss.title">
Средства трансляции
</title>
<para>
Django поставляется со средствами высокого уровня для трансляции
данных, что позволяет легко создавать потоки RSS или Atom.
</para>
<para>
<note>
<title>
Что такое RSS? Что такое Atom?
</title>
<para>
RSS и Atom оба являются форматами, базирующимися на XML,
которые вы можете использовать для рассылки автоматически
обновляемого <quote>содержания</quote> для вашего
сайта. Более подробно об RSS можно узнать на <ulink
url="http://www.whatisrss.com/"/>, об Atom — на <ulink
url="http://www.atomenabled.org/"/>.
</para>
<para>
Здесь и далее мы будем использовать термин
<quote>трансляция</quote> для английской фразы
<quote>syndication feed</quote>.
</para>
</note>
</para>
<para>
Для создания любой трансляции вам понадобится только написать
короткий класс на языке Python. Вы можете создавать столько
трансляций, сколько требуется.
</para>
<para>
Средой высокого уровня для генерации трансляций является
представление, которое по договорённости подключено к
<token>/feeds/</token>. Django использует хвостовую часть URL
(то, что идёт после <token>/feeds/</token>) для определения
того, какую именно трансляцию следует вернуть.
</para>
<para>
Для создания трансляции, вам потребуется написать класс
<classname>Feed</classname> и указать на него в вашем файле
привязок URL (обратитесь к главам <quote><xref
linkend="djangobook.chap03"
endterm="djangobook.chap03.title"/></quote> и <quote><xref
linkend="djangobook.chap08"
endterm="djangobook.chap08.title"/></quote> для подробностей).
</para>
<section id="&BASEID;.rss.init">
<title id="&BASEID;.rss.init.title">
Инициализация
</title>
<para>
Чтобы активировать трансляции на вашем сайте, добавьте
следующее в файл привязок:
<screen>
<![CDATA[
(r'^feeds/(?P<url>.*)/$',
'django.contrib.syndication.views.feed',
{'feed_dict': feeds}
),
]]>
</screen>
</para>
<para>
Этот код указывает Django, что следует использовать RSS среду
для обработки всех URL, которые начинаются с
<token>feeds/</token>. (Вы можете изменить этот префикс
<token>feeds/</token> на любой необходимый.)
</para>
<para>
Следует отметить, что параметр <varname>feed_dict</varname>
должен быть словарём, который совпадает с сокращением для
трансляции (метка для короткого URL). Вы можете определить
этот параметр в файле привязок. Ниже дан полный пример:
<screen>
<![CDATA[
from django.conf.urls.defaults import *
from myproject.feeds import LatestEntries, LatestEntriesByCategory
feeds = {
'latest': LatestEntries,
'categories': LatestEntriesByCategory,
}
urlpatterns = patterns('',
# ...
(r'^feeds/(?P<url>.*)/$', 'django.contrib.syndication.views.feed',
{'feed_dict': feeds}),
# ...
)
]]>
</screen>
</para>
<para>
Вышеприведённый пример регистрирует две трансляции:
<itemizedlist>
<listitem>
<para>
Трансляция, представленная <token>LatestEntries</token>,
будет жить на <token>feeds/latest/</token>.
</para>
</listitem>
<listitem>
<para>
Трансляция, представленная
<token>LatestEntriesByCategory</token>, будет жить на
<token>feeds/categories/</token>.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Теперь надо определить сами классы
<classname>Feed</classname>.
</para>
<para>
Класс <classname>Feed</classname> является обычным классом
Python и представляет собой класс трансляции. Трансляция может
быть простой (т.е. отображающей новости сайта или последние
записи блога) или более сложной (т.е. отображающей все записи
блога в определённой категории, где категория является
переменной).
</para>
<para>
Вы должны подключать в код представления класс
<token>django.contrib.syndication.feeds.Feed</token>. Классы
<classname>Feed</classname> могут располагаться в любой точке
вашего кода.
</para>
</section>
<section id="&BASEID;.rss.simple">
<title id="&BASEID;.rss.simple.title">
Простая трансляция
</title>
<para>
Этот простой пример, взятый с <ulink
url="http://chicagocrime.org/"/>, описывает трансляцию,
которая возвращает пять свежих новостей:
<screen>
<![CDATA[
from django.contrib.syndication.feeds import Feed
from chicagocrime.models import NewsItem
class LatestEntries(Feed):
title = "Chicagocrime.org site news"
link = "/sitenews/"
description = "Updates on changes and additions to chicagocrime.org."
def items(self):
return NewsItem.objects.order_by('-pub_date')[:5]
]]>
</screen>
</para>
<para>
Отметим важные аспекты этого кода:
<itemizedlist>
<listitem>
<para>
Класс подключает
<token>django.contrib.syndication.feeds.Feed</token>.
</para>
</listitem>
<listitem>
<para>
Атрибуты <token>title</token>, <token>link</token> и
<token>description</token> соответствуют стандартным
элементам RSS: <title>, <link> и
<description>.
</para>
</listitem>
<listitem>
<para>
Метод <function>items()</function> возвращает список
объектов, которые должны быть включены в трансляцию в
виде элементов <![CDATA[<item>]]>. Несмотря на то, что
этот пример возвращает объекты
<classname>NewsItem</classname> с помощью API для работы
с базой данных, метод <function>items()</function> не
обязан возвращать экземпляры модели.
</para>
<para>
Вы <quote>бесплатно</quote> получаете некоторую
функциональность, используя модели Django, но метод
<function>items()</function> может вернуть любой тип
объекта.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Надо сделать ещё кое-что. В RSS-потоке каждый элемент
<![CDATA[<item>]]> имеет элементы <![CDATA[<title>]]>,
<![CDATA[<link>]]> и <![CDATA[<description>]]>. Необходимо
указать среде какие именно данные следует помещать в эти
элементы.
<itemizedlist>
<listitem>
<para>
Чтобы указать содержимое для <![CDATA[<title>]]> и
<![CDATA[<description>]]>, создайте шаблоны (см. главу
<quote><xref linkend="djangobook.chap04"
endterm="djangobook.chap04.title"/></quote>) с именами
<filename>feeds/latest_title.html</filename> и
<filename>feeds/latest_description.html</filename>, где
<token>latest</token> является сокращением, которое
указано в файле привязки для конкретной
трансляции. Следует отметить, что наличие расширения
<token>.html</token> обязательно.
</para>
<para>
Система RSS обрабатывает этот шаблон для каждого
элемента, передавая ему две контекстные переменные:
<itemizedlist>
<listitem>
<para>
<varname>obj</varname>: текущий объект (один из
объектов полученных от метода
<function>items()</function>).
</para>
</listitem>
<listitem>
<para>
<varname>site</varname>: Объект класса
<token>django.models.core.sites.Site</token>,
представляющий текущий сайт. Полезен для <token>{{
site.domain }}</token> или <token>{{ site.name
}}</token>.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Если вы не создадите шаблон хотя бы для одного элемента,
среда будет использовать шаблон <token>{{ obj }}</token>
по умолчанию, т.е. обычное текстовое представление
объекта.
</para>
<para>
Также вы можете поменять имена этих двух шаблонов,
определив атрибуты <varname>title_template</varname> и
<varname>description_template</varname> для класса
<classname>Feed</classname>.
</para>
</listitem>
<listitem>
<para>
При определении содержимого для <![CDATA[<link>]]> у вас
есть две опции. Для каждого элемента, возвращённого
методом <function>items()</function>, Django сначала
пытается выполнить его метод
<function>get_absolute_url()</function>. Если такого
метода нет у объекта, Django пытается вызвать метод
<function>item_link()</function> для класса
<classname>Feed</classname>, передавая ему один параметр
<varname>item</varname>, который является этим объектом.
</para>
<para>
Оба метода, <function>get_absolute_url()</function> и
<function>item_link()</function>, должны возвращать URL
элемента в виде обычной строки Python.
</para>
</listitem>
<listitem>
<para>
Для показанного ранее примера
<token>LatestEntries</token> мы можем создать очень
простые шаблоны:
<screen>
# latest_title.html
{{ obj.title }}
#latest_description.html
{{ obj.description }}
</screen>
Это всегда <emphasis>слишком</emphasis> просто ...
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="&BASEID;.rss.complex">
<title id="&BASEID;.rss.complex.title">
Более сложная трансляция
</title>
<para>
Сайт <ulink url="http://chicagocrime.org"/> предоставляет
RSS-потоки по последним преступлениям для каждого полицейского
участка в Чикаго. Можно устать, создавая классы
<classname>Feed</classname> для каждого участка. Это нарушит
принцип DRY и приведёт к размещению данных в логике программы.
</para>
<para>
Вместо этого, среда трансляций позволяет вам создать базовые
трансляции, которые возвращают элементы в зависимости от URL.
</para>
<para>
На нашем сайте трансляции для полицейских участков доступны
через URL, подобные этим:
<itemizedlist>
<listitem>
<para>
<ulink
url="http://www.chicagocrime.org/rss/beats/0613/"/>:
возвращает данные о последних преступлениях на участке
0613.
</para>
</listitem>
<listitem>
<para>
<ulink
url="http://www.chicagocrime.org/rss/beats/1424/"/>:
возвращает данные о последних преступлениях на участке
1424.
</para>
</listitem>
</itemizedlist>
</para>
<para>
Здесь сокращением является <token>beats</token>. Среда
трансляций обнаруживает хвостовую часть URL после
<token>beats</token> — <token>0613</token> и
<token>1424</token> — и предоставляет вам возможность
указать ей, что означает эта дополнительная часть URL и как
она влияет на транслируемые данные.
</para>
<para>
Пример должен всё прояснить. Ниже представлен код для таких
трансляций:
<screen>
<![CDATA[
from django.core.exceptions import ObjectDoesNotExist
class BeatFeed(Feed):
def get_object(self, bits):
# In case of "/rss/beats/0613/foo/bar/baz/", or other such
# clutter, check that bits has only one member.
if len(bits) != 1:
raise ObjectDoesNotExist
return Beat.objects.get(beat__exact=bits[0])
def title(self, obj):
return "Chicagocrime.org: Crimes for beat %s" % obj.beat
def link(self, obj):
return obj.get_absolute_url()
def description(self, obj):
return "Crimes recently reported in police beat %s" % obj.beat