I have a Flask stack that I reuse with a Vue frontend. Since most of my HTML templates don't use Jinja syntax much but have a lot of Vue syntax, I've changed the default delimiter options (http://svn.python.org/projects/external/Jinja-1.2/docs/html/altsyntax.html) to be based on [ instead.

However, this is a problem because this extension has embedded Jinja-based XML templates that use the default delimiters based on {. As a result, no actual Jinja rendering of the XML template occurs.

I don't think this is really a bug in flask-sitemap, but do you have any suggestions on how to deal with this? I've been source code diving on Flask and Jinja and Flask seems to only support one Jinja environment for the entire app. Jinja's Environment has a nice .overlay() method that I think would be useful in this case, but I can't find any way of using this without monkey-patching Flask which I would like to avoid.

Am I missing some more obvious way of dealing with this situation? Any other suggestions of where to look or what to try?

Using the following sitemap generator:

from flask import Flask
from flask_sitemap import Sitemap

app = Flask(__name__)
sitemap = Sitemap(app=app)


@app.route('/<int:some_number>')
def show_number(some_number):
    # Do stuff

@sitemap.register_generator
def sitemap():
    max_number = 100000
    for some_number in range(max_number * -1, max_number * 2):
        yield ('show_number', {'some_number': some_number})

/sitemap.xml works just fine:

$ curl http://localhost:5000/sitemap.xml
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>http://localhost/sitemap1.xml</loc>
  </sitemap>
  <sitemap>
    <loc>http://localhost/sitemap2.xml</loc>
  </sitemap>
  …
  <sitemap>
    <loc>http://localhost/sitemap30.xml</loc>
  </sitemap>
</sitemapindex>

/sitemap1.xml, on the other hand, raises AssertionError: Popped wrong request context.

Debugging middleware caught exception in streamed response at a point where response headers were already sent.
Traceback (most recent call last):
  File "/path/to/venv/lib/python3.5/site-packages/flask/app.py", line 1994, in __call__
    return self.wsgi_app(environ, start_response)
  File "/path/to/venv/lib/python3.5/site-packages/flask/app.py", line 1990, in wsgi_app
    ctx.auto_pop(error)
  File "/path/to/venv/lib/python3.5/site-packages/flask/ctx.py", line 387, in auto_pop
    self.pop(exc)
  File "/path/to/venv/lib/python3.5/site-packages/flask/ctx.py", line 379, in pop
    '(%r instead of %r)' % (rv, self)
AssertionError: Popped wrong request context.  (<RequestContext 'http://localhost/' [GET] of number_shower> instead of <RequestContext 'http://localhost:5000/sitemap1.xml' [HEAD] of number_shower>)
127.0.0.1 - - [30/Dec/2016 10:50:34] "HEAD /sitemap1.xml HTTP/1.1" 200 -

Usage

• caching
• rate limiting
• authorization

• optionally include all endpoints without parameters
• blacklist endpoints

• Fix the version of dependencies in setup.py (https://github.com/inveniosoftware/flask-sitemap/runs/1524913978?check_suite_focus=true)

• Update the tests.yml with automation-tools

• Fix pydocstyle issues

Create command line interface (flask_sitemap/cli.py:Sitemap) to generate static sitemap. (see #12 (comment) by @nikhilkalige)

• use Flask-Script or click

With #48 landed, can someone please make a new release of flask-sitemap to PyPI? I believe the new release would be v0.3.1.

I have found the option "app.config['SITEMAP_INCLUDE_RULES_WITHOUT_PARAMS'] = True" which will cause all urls to be added to the sitemap, but is there an option to set this to True then just label a few that should be excluded?

Hi,
After installing python 3.10 following error occurred:
ImportError: cannot import name 'Mapping' from 'collections' (/usr/local/lib/python3.10/collections/init.py)

Dear,

I'm running a flask application using nginx and uwsgi. Even though flask SERVER_NAME is set to our url the sitemap.xml is generated using localhost.

Kind rgds,

Henrik

I am having some issues running the tests... I cant install the right packages.. Can you please consider adding requirements.txt. I am not familiar with setup.py, so not sure whether you need it.

I am also getting a error as Theme Error. So getting a versionconflict for coverage

First off, thank you very much for this package. You have done something truly wonderful here.

I'm always frustrated when I can't change the base URL to what I want. For example, all the location URLs are created on localhost:5000 when the flask app runs on port 5000 on my localhost. I would like to be able to change that URL to what I want it to be.

Couldnt install package with pip.

Hi,
with flask 0.10.1 an UnicodeDecodeError happens if you try to get a gezipped sitemap.
gzip_response() function does not set the application/octet-stream content type

Probably, the problem can be fixed by adding
response.headers["Content-Type"] = "application/octet-stream"

Regards,
Chris

Hi. Can't beat this exception. Can you please help?

This is the simple code:

from flask import Flask, render_template
from flask_sitemap import Sitemap

app = Flask(__name__)
ext = Sitemap(app=app)

@app.route('/')
def home():
    return render_template('home.html')

This is the traceback:

  File "venv\lib\site-packages\flask_sitemap\__init__.py", line 130, in wrapper
    return response(new_view(*args, **kwargs))
  File "venv\lib\site-packages\flask_sitemap\__init__.py", line 138, in sitemap
    urlset = next(run)
StopIteration

I want to use SITEMAP_IGNORE_ENDPOINTS with multiple endpoints how do i implement this whil having SITEMAP_INCLUDE_RULES_WITHOUT_PARAMS set to true please assist

• create new template sitemapindex for http://www.sitemaps.org/protocol.html#sitemapIndex_sitemapindex
• add support splitting and gzipping of sitemaps

Package version (if known):

Describe the bug

'datetime.date' object has no attribute 'update'

Steps to Reproduce

use python 3.10
genrate the function
an try /sitemap

Expected behavior

Screenshots (if applicable)

Additional context

I think some issues are because of context problems: #18 and #33.

You don't need a new request context if you are already in a request.

https://github.com/inveniosoftware/flask-sitemap/blob/master/flask_sitemap/__init__.py#L209

It is using test_request_context probably to support CLI generation, but it is not always necessary.