【Django】サイトマップでページを複数作成する際に見やすく表示する方法

Djangoでホームページを作成し、Googleに認識してもらうように「サイトマップ」を作成します。

ホームページでも10ページ程度であればもんだいないですが、100ページも作るとなると結構大変です。
サイトマップ作成も醜くなってしまいます。

今回はサイトマップ作成時の見やすい書き方をメモしておきます。

「Django」でサイトマップを作成する際に見やすくコードを表記する

Djangoでのサイトマップ作成方法は以下の記事を参考にしてください。

Djangoのサイトマップは「sitemaps.py」というファイルで作成します。
通常は10行目のように新規でページを追加した際にサイトマップに登録する場合は、カンマ区切りで追加していきます。

※ mysite/sitemaps.py

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

class StaticViewSitemap(sitemaps.Sitemap):
    priority = 0.5
    changefreq = 'weekly'
    protocol = 'https'

    def items(self):
        return ['sitemap:index', 'sitemap:linux_command_top', 'sitemap:linux_network', 'sitemap:linux_ping']

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

ただし、ページが数十ページ、数百ページと増えるとカンマ区切りで横並びで書いていくのはかなりコードが見にくくなります。

これを見やすく、管理しやすくするために以下の書き方を実施します。

バックスラッシュ（\）で改行してコードを見やすくする

結果的に言うと一列に長くなるようなコードは「バックスラッシュ（\）」を使用して改行し見た目をわかりやすくします。

以下は、サイトマップのファイルにバックスラッシュ（キーボードの￥マーク）を使用した例なります。

※10-13行目でバックスラッシュを利用する。

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

class StaticViewSitemap(sitemaps.Sitemap):
    priority = 0.5
    changefreq = 'weekly'
    protocol = 'https'

    def items(self):
        return ['sitemap:index', \
                'sitemap:linux_command_top', \
                'sitemap:linux_network', \
                'sitemap:linux_ping']

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

これだけでコードが見やすくなります。