Обзор¶

Карта сайта — это XML-файл на вашем веб-сайте, который сообщает индексаторам поисковых систем, как часто изменяются ваши страницы и насколько «важны» определенные страницы по отношению к другим страницам вашего сайта. Эта информация помогает поисковым системам индексировать ваш сайт.

Платформа карты сайта Django автоматизирует создание этого XML-файла, позволяя выразить эту информацию в коде Python.

Он работает во многом похоже на фреймворк синдикации от Django. Чтобы создать карту сайта, напишите класс Sitemap и укажите его в вашем URLconf.

Установка¶

Чтобы установить приложение Sitemap, выполните следующие действия:

1. Добавьте ``“django.contrib.sitemaps“` в настройки INSTALLED_APPS.

2. Убедитесь, что ваш параметр TEMPLATES содержит серверную часть DjangoTemplates, для параметра APP_DIRS установлено значение True. Он находится там по умолчанию, поэтому вам нужно будет изменить его только в том случае, если вы изменили этот параметр.

3. Убедитесь, что вы установили sites framework.

(Примечание. Приложение карты сайта не устанавливает никаких таблиц базы данных. Единственная причина, по которой ему необходимо войти в INSTALLED_APPS, заключается в том, чтобы загрузчик шаблонов Loader() мог найти шаблоны по умолчанию.)

Инициализация¶

views.sitemap(request, sitemaps, section=None, template_name='sitemap.xml', content_type='application/xml')¶

Чтобы активировать создание карты сайта на вашем сайте Django, добавьте эту строку в свой URLconf:

from django.contrib.sitemaps.views import sitemap

path('sitemap.xml', sitemap, {'sitemaps': sitemaps},
     name='django.contrib.sitemaps.views.sitemap')

Это указывает Django создавать карту сайта, когда клиент обращается к /sitemap.xml.

Имя файла карты сайта не имеет значения, важно его местоположение. Поисковые системы будут индексировать ссылки в вашей карте сайта только для текущего уровня URL и ниже. Например, если sitemap.xml находится в вашем корневом каталоге, он может ссылаться на любой URL-адрес вашего сайта. Однако если ваша карта сайта находится по адресу /content/sitemap.xml, она может ссылаться только на URL-адреса, начинающиеся с /content/.

Представление карты сайта принимает дополнительный обязательный аргумент: {'sitemaps': sitemaps}. sitemaps должен быть словарем, который сопоставляет короткую метку раздела (например, blog или news) с его Sitemap классом (например, BlogSitemap или NewsSitemap). Он также может сопоставляться с экземпляром класса Sitemap (например, BlogSitemap(some_var)).

Классы Sitemap¶

A Sitemap class is a Python class that represents a «section» of entries in your sitemap. For example, one Sitemap class could represent all the entries of your Weblog, while another could represent all of the events in your events calendar.

В простейшем случае все эти разделы объединяются в один файл sitemap.xml, но также можно использовать платформу для создания индекса карты сайта, который ссылается на отдельные файлы карты сайта, по одному на каждый раздел. (См. «Создание индекса карты сайта» ниже.)

Sitemap Классы должны быть подклассом django.contrib.sitemaps.Sitemap. Они могут жить где угодно в вашей кодовой базе.

Пример¶

Предположим, у вас есть система блогов с моделью «Запись», и вы хотите, чтобы ваша карта сайта включала все ссылки на отдельные записи вашего блога. Вот как может выглядеть ваш класс карты сайта:

from django.contrib.sitemaps import Sitemap
from blog.models import Entry

class BlogSitemap(Sitemap):
    changefreq = "never"
    priority = 0.5

    def items(self):
        return Entry.objects.filter(is_draft=False)

    def lastmod(self, obj):
        return obj.pub_date

Примечание:

• changefreq и priority — это атрибуты класса, соответствующие элементам <changefreq> и <priority> соответственно. Их можно сделать вызываемыми как функции, как это было в примере с lastmod.

• items() — это метод, который возвращает последовательность или QuerySet объектов. Возвращенные объекты будут переданы любым вызываемым методам, соответствующим свойству карты сайта (location, lastmod, changefreq и priority).

• lastmod должен возвращать datetime.

• В этом примере нет метода location, но вы можете предоставить его, чтобы указать URL-адрес вашего объекта. По умолчанию location() вызывает get_absolute_url() для каждого объекта и возвращает результат.

Ссылка на класс Sitemap¶

class Sitemap¶

Класс Sitemap может определять следующие методы/атрибуты:

items¶

Обязательный. Метод, возвращающий последовательность или QuerySet объектов. Среду не волнует, какой тип объектов они представляют; все, что имеет значение, это то, что эти объекты передаются методам location(), lastmod(), changefreq() и priority().

location¶

Необязательно. Либо метод, либо атрибут.

Если это метод, он должен возвращать абсолютный путь к данному объекту, возвращаемый items().

Если это атрибут, его значение должно быть строкой, представляющей абсолютный путь, используемый для каждого объекта, возвращаемого items().

В обоих случаях «абсолютный путь» означает URL-адрес, который не включает протокол или домен. Примеры:

• Good: '/foo/bar/'

• Bad: 'example.com/foo/bar/'

• Bad: 'https://example.com/foo/bar/'

Если location не указан, платформа вызовет метод get_absolute_url() для каждого объекта, возвращаемого items().

Чтобы указать протокол, отличный от http, используйте protocol.

lastmod¶

Необязательно. Либо метод, либо атрибут.

Если это метод, он должен принимать один аргумент — объект, возвращаемый items() - и возвращать дату/время последнего изменения этого объекта в виде datetime.

Если это атрибут, его значением должно быть datetime, представляющее дату/время последнего изменения для каждого объекта, возвращаемого items().

Если все элементы в карте сайта имеют lastmod, карта сайта, сгенерированная views.sitemap(), будет иметь заголовок Last-Modified, равный последнему lastmod. Вы можете активировать ConditionalGetMiddleware, чтобы Django соответствующим образом отвечал на запросы с заголовком If-Modified-Since, который предотвратит отправку карты сайта, если она не изменилась.

paginator¶

Необязательный.

Это свойство возвращает Paginator для items(). Если вы создаете карты сайта в пакетном режиме, вы можете переопределить это свойство как кэшированное, чтобы избежать множественных вызовов items().

changefreq¶

Необязательно. Либо метод, либо атрибут.

Если это метод, он должен принимать один аргумент — объект, возвращаемый items() — и возвращать частоту изменения этого объекта в виде строки.

Если это атрибут, его значение должно быть строкой, представляющей частоту изменения каждого объекта, возвращаемого items().

Возможные значения changefreq, независимо от того, используете ли вы метод или атрибут:

• 'всегда'

• 'почасово'

• 'ежедневно'

• 'еженедельно'

• 'ежемесячно'

• 'ежегодно'

• 'никогда'

priority¶

Необязательно. Либо метод, либо атрибут.

Если это метод, он должен принимать один аргумент — объект, возвращаемый items() — и возвращать приоритет этого объекта в виде строки или числа с плавающей запятой.

Если это атрибут, его значение должно быть либо строкой, либо числом с плавающей точкой, представляющим приоритет каждого объекта, возвращаемого items().

Примеры значений priority: 0.4, 1.0. Приоритет страницы по умолчанию — «0,5». Дополнительную информацию см. в документации sitemaps.org.

protocol¶

Необязательный.

This attribute defines the protocol ('http' or 'https') of the URLs in the sitemap. If it isn’t set, the protocol with which the sitemap was requested is used. If the sitemap is built outside the context of a request, the default is 'http'.

limit¶

Необязательный.

Этот атрибут определяет максимальное количество URL-адресов, включенных в каждую страницу карты сайта. Его значение не должно превышать значение по умолчанию «50000», которое является верхним пределом, разрешенным в протоколе Sitemaps <https://www.sitemaps.org/protocol.html#index>`_.

i18n¶

Необязательный.

Логический атрибут, который определяет, должны ли URL-адреса этой карты сайта создаваться с использованием всех ваших LANGUAGES. По умолчанию установлено значение «Ложь».

languages¶

New in Django 3.2.

Необязательный.

последовательность кодов языка для использования для создания альтернативных ссылок, когда i18n включен. По умолчанию: LANGUAGES.

alternates¶

New in Django 3.2.

Необязательный.

Логический атрибут. При использовании в сочетании с i18n каждый сгенерированный URL-адрес будет иметь список альтернативных ссылок, указывающих на другие языковые версии с использованием атрибута hreflang. По умолчанию установлено значение «Ложь».

x_default¶

New in Django 3.2.

Необязательный.

Логический атрибут. Когда True, альтернативные ссылки, сгенерированные alternates, будут содержать резервную запись hreflang="x-default" со значением LANGUAGE_CODE. По умолчанию установлено значение «Ложь».

Ярлыки¶

Платформа карты сайта предоставляет удобный класс для обычного случая:

class GenericSitemap(info_dict, priority=None, changefreq=None, protocol=None)¶

The django.contrib.sitemaps.GenericSitemap class allows you to create a sitemap by passing it a dictionary which has to contain at least a queryset entry. This queryset will be used to generate the items of the sitemap. It may also have a date_field entry that specifies a date field for objects retrieved from the queryset. This will be used for the lastmod attribute in the generated sitemap.

Аргументы ключевых слов priority, changefreq и protocol позволяют указать эти атрибуты для всех URL-адресов.

from django.contrib.sitemaps import GenericSitemap
from django.contrib.sitemaps.views import sitemap
from django.urls import path
from blog.models import Entry

info_dict = {
    'queryset': Entry.objects.all(),
    'date_field': 'pub_date',
}

urlpatterns = [
    # some generic view using info_dict
    # ...

    # the sitemap
    path('sitemap.xml', sitemap,
         {'sitemaps': {'blog': GenericSitemap(info_dict, priority=0.6)}},
         name='django.contrib.sitemaps.views.sitemap'),
]

Карта сайта для статических просмотров¶

Часто вы хотите, чтобы сканеры поисковых систем индексировали представления, которые не являются ни страницами с подробными сведениями об объекте, ни плоскими страницами. Решение состоит в том, чтобы явно указать имена URL-адресов для этих представлений в items и вызвать reverse() в методе location карты сайта. Например:

# sitemaps.py
from django.contrib import sitemaps
from django.urls import reverse

class StaticViewSitemap(sitemaps.Sitemap):
    priority = 0.5
    changefreq = 'daily'

    def items(self):
        return ['main', 'about', 'license']

    def location(self, item):
        return reverse(item)

# urls.py
from django.contrib.sitemaps.views import sitemap
from django.urls import path

from .sitemaps import StaticViewSitemap
from . import views

sitemaps = {
    'static': StaticViewSitemap,
}

urlpatterns = [
    path('', views.main, name='main'),
    path('about/', views.about, name='about'),
    path('license/', views.license, name='license'),
    # ...
    path('sitemap.xml', sitemap, {'sitemaps': sitemaps},
         name='django.contrib.sitemaps.views.sitemap')
]

Создание индекса карты сайта¶

views.index(request, sitemaps, template_name='sitemap_index.xml', content_type='application/xml', sitemap_url_name='django.contrib.sitemaps.views.sitemap')¶

Платформа карты сайта также имеет возможность создавать индекс карты сайта, который ссылается на отдельные файлы карты сайта, по одному на каждый раздел, определенный в вашем словаре карты сайта. Единственные различия в использовании:

• В конфигурации URL вы используете два представления: django.contrib.sitemaps.views.index() и django.contrib.sitemaps.views.sitemap().

• Представление django.contrib.sitemaps.views.sitemap() должно принимать ключевой аргумент section.

Вот как будут выглядеть соответствующие строки URLconf для приведенного выше примера:

from django.contrib.sitemaps import views

urlpatterns = [
    path('sitemap.xml', views.index, {'sitemaps': sitemaps}),
    path('sitemap-<section>.xml', views.sitemap, {'sitemaps': sitemaps},
         name='django.contrib.sitemaps.views.sitemap'),
]

Это автоматически создаст файл sitemap.xml, который ссылается как на sitemap-flatpages.xml, так и на sitemap-blog.xml. Классы Sitemap и атрибут sitemaps вообще не изменяются.

Вам следует создать индексный файл, если одна из ваших карт сайта содержит более 50 000 URL-адресов. В этом случае Django автоматически разбивает карту сайта на страницы, и это отразится в индексе.

Если вы не используете стандартное представление карты сайта (например, если оно обернуто декоратором кэширования), вы должны назвать свое представление карты сайта и передать sitemap_url_name в представление индекса:

from django.contrib.sitemaps import views as sitemaps_views
from django.views.decorators.cache import cache_page

urlpatterns = [
    path('sitemap.xml',
         cache_page(86400)(sitemaps_views.index),
         {'sitemaps': sitemaps, 'sitemap_url_name': 'sitemaps'}),
    path('sitemap-<section>.xml',
         cache_page(86400)(sitemaps_views.sitemap),
         {'sitemaps': sitemaps}, name='sitemaps'),
]

Настройка шаблона¶

Если вы хотите использовать разные шаблоны для каждой карты сайта или индекса карты сайта, доступного на вашем сайте, вы можете указать его, передав параметр «template_name» в представления «sitemap» и «index» через URLconf:

from django.contrib.sitemaps import views

urlpatterns = [
    path('custom-sitemap.xml', views.index, {
        'sitemaps': sitemaps,
        'template_name': 'custom_sitemap.html'
    }),
    path('custom-sitemap-<section>.xml', views.sitemap, {
        'sitemaps': sitemaps,
        'template_name': 'custom_sitemap.html'
    }, name='django.contrib.sitemaps.views.sitemap'),
]

Эти представления возвращают объект TemplateResponse, что позволяет легко изменить данные ответа перед выполнением шаблона. Подробности смотрите в разделе о TemplateResponse.

<?xml version="1.0" encoding="UTF-8"?>
<urlset
  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"
  xmlns:news="http://www.google.com/schemas/sitemap-news/0.9">
{% spaceless %}
{% for url in urlset %}
  <url>
    <loc>{{ url.location }}</loc>
    {% if url.lastmod %}<lastmod>{{ url.lastmod|date:"Y-m-d" }}</lastmod>{% endif %}
    {% if url.changefreq %}<changefreq>{{ url.changefreq }}</changefreq>{% endif %}
    {% if url.priority %}<priority>{{ url.priority }}</priority>{% endif %}
    <news:news>
      {% if url.item.publication_date %}<news:publication_date>{{ url.item.publication_date|date:"Y-m-d" }}</news:publication_date>{% endif %}
      {% if url.item.tags %}<news:keywords>{{ url.item.tags }}</news:keywords>{% endif %}
    </news:news>
   </url>
{% endfor %}
{% endspaceless %}
</urlset>

Pinging Google¶

You may want to «ping» Google when your sitemap changes, to let it know to reindex your site. The sitemaps framework provides a function to do just that: django.contrib.sitemaps.ping_google().

ping_google(sitemap_url=None, ping_url=PING_URL, sitemap_uses_https=True)¶

ping_google takes these optional arguments:

• sitemap_url - The absolute path to your site’s sitemap (e.g., '/sitemap.xml'). If this argument isn’t provided, ping_google will attempt to figure out your sitemap by performing a reverse lookup in your URLconf.

• ping_url - Defaults to Google’s Ping Tool: https://www.google.com/webmasters/tools/ping.

• sitemap_uses_https - Set to False if your site uses http rather than https.

ping_google() raises the exception django.contrib.sitemaps.SitemapNotFound if it cannot determine your sitemap URL.

One useful way to call ping_google() is from a model’s save() method:

from django.contrib.sitemaps import ping_google

class Entry(models.Model):
    # ...
    def save(self, force_insert=False, force_update=False):
        super().save(force_insert, force_update)
        try:
            ping_google()
        except Exception:
            # Bare 'except' because we could get a variety
            # of HTTP-related exceptions.
            pass

A more efficient solution, however, would be to call ping_google() from a cron script, or some other scheduled task. The function makes an HTTP request to Google’s servers, so you may not want to introduce that network overhead each time you call save().

python manage.py ping_google [/sitemap.xml]