async def test_sitemap_scope() -> None:
"""
Sitemaps can use `self.scope` to access the ASGI scope.
"""
class Sitemap(asgi_sitemaps.Sitemap[str]):
def items(self) -> List[str]:
return ["home"]
def location(self, name: str) -> str:
request = Request(self.scope)
return URL(request.url_for(name)).path
sitemap = asgi_sitemaps.SitemapApp(Sitemap(), domain="example.io")
async def home() -> Any:
... # pragma: no cover
routes = [Route("/", home, name="home"), Route("/sitemap.xml", sitemap)]
app = Starlette(routes=routes)
async with httpx.AsyncClient(app=app) as client:
r = await client.get("http://testserver/sitemap.xml")
content = dedent("""
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://example.io/</loc>
<priority>0.5</priority>
</url>
</urlset>
""").lstrip()
assert r.text == content
async def test_sitemap_async_iterable_items() -> None:
"""
`.items()` supports returning async iterables.
"""
class Sitemap(asgi_sitemaps.Sitemap[str]):
async def items(self) -> AsyncIterator[str]:
for item in ["/", "/about"]:
yield item
def location(self, item: str) -> str:
return item
app = asgi_sitemaps.SitemapApp(Sitemap(), domain="example.io")
async with httpx.AsyncClient(app=app) as client:
r = await client.get("http://testserver")
content = dedent("""
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://example.io/</loc>
<priority>0.5</priority>
</url>
<url>
<loc>http://example.io/about</loc>
<priority>0.5</priority>
</url>
</urlset>
""").lstrip()
assert r.status_code == 200
assert r.text == content
assert r.headers["content-type"] == "application/xml"
assert r.headers["content-length"] == str(len(content))
async def test_sitemap_sections() -> None:
"""
Multiple sitemap sections can be provided.
"""
class StaticSitemap(asgi_sitemaps.Sitemap[str]):
def items(self) -> List[str]:
return ["/", "/about"]
def location(self, item: str) -> str:
return item
class BlogSitemap(asgi_sitemaps.Sitemap[str]):
def items(self) -> List[str]:
return ["/blog/articles/"]
def location(self, item: str) -> str:
return item
app = asgi_sitemaps.SitemapApp(
[StaticSitemap(), BlogSitemap()], domain="example.io")
async with httpx.AsyncClient(app=app) as client:
r = await client.get("http://testserver")
content = dedent("""
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://example.io/</loc>
<priority>0.5</priority>
</url>
<url>
<loc>http://example.io/about</loc>
<priority>0.5</priority>
</url>
<url>
<loc>http://example.io/blog/articles/</loc>
<priority>0.5</priority>
</url>
</urlset>
""").lstrip()
assert r.status_code == 200
assert r.text == content
assert r.headers["content-type"] == "application/xml"
assert r.headers["content-length"] == str(len(content))
protocol = "https"
def items(self) -> List[str]:
return ["/"]
def location(self, path: str) -> str:
return path
def changefreq(self, path: str) -> str:
return "weekly"
class PagesSitemap(asgi_sitemaps.Sitemap):
protocol = "https"
def items(self) -> List[Page]:
pages = []
for language in settings.LANGUAGES:
pages.extend(index.get_i18n_aware_pages(language))
return pages
def location(self, page: Page) -> str:
return page.permalink
def changefreq(self, path: str) -> str:
return "weekly"
sitemap = asgi_sitemaps.SitemapApp(
[StaticSitemap(), PagesSitemap()], domain="florimond.dev")
import asgi_sitemaps
from starlette.datastructures import URL
from starlette.requests import Request
from urllib.parse import quote
from data import get_countries
class StaticSitemap(asgi_sitemaps.Sitemap):
def items(self):
return ["main", "about", "stats", "copyright"]
def location(self, item):
request = Request(scope=self.scope)
url = request.url_for(item)
return URL(url).path
class CountryPageSitemap(asgi_sitemaps.Sitemap):
async def items(self):
return [row[0] for row in await get_countries()]
def location(self, item):
request = Request(scope=self.scope)
url = request.url_for("country", country=quote(item))
return URL(url).path
sitemap = asgi_sitemaps.SitemapApp(
[StaticSitemap(), CountryPageSitemap()], domain="openinframap.org")
async def test_sitemap_fields() -> None:
"""
Custom sitemap fields behave as expected.
"""
class Sitemap(asgi_sitemaps.Sitemap[int]):
protocol = "https"
def items(self) -> List[int]:
return list(range(3))
def location(self, k: int) -> str:
return f"/page{k + 1}"
def lastmod(self, k: int) -> Optional[dt.datetime]:
if k % 3 == 0:
return dt.datetime(2020, 1, 1)
elif k % 3 == 1:
return None
else:
return dt.datetime(2018, 3, 14)
def changefreq(self, k: int) -> Optional[str]:
if k % 3 == 0:
return "daily"
elif k % 3 == 1:
return "monthly"
else:
return None
def priority(self, k: int) -> float:
return 0.7
app = asgi_sitemaps.SitemapApp(Sitemap(), domain="example.io")
async with httpx.AsyncClient(app=app) as client:
r = await client.get("http://testserver")
content = dedent("""
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://example.io/page1</loc>
<lastmod>2020-01-01</lastmod>
<changefreq>daily</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://example.io/page2</loc>
<changefreq>monthly</changefreq>
<priority>0.7</priority>
</url>
<url>
<loc>https://example.io/page3</loc>
<lastmod>2018-03-14</lastmod>
<priority>0.7</priority>
</url>
</urlset>
""").lstrip()
assert r.status_code == 200
assert r.text == content
assert r.headers["content-type"] == "application/xml"
assert r.headers["content-length"] == str(len(content))