DeprecationWarning 'contextfilter' is renamed to 'pass_context', the old name will be removed in Jinja 3.1

[lyz-code]

I'm trying to load a mkdocs.yaml in a fixture for the mkdocs-newsletter library with the next code:

from mkdocs import config
from mkdocs.config.base import Config

mkdocs_config = config.load_config("mkdocs.yml")

With the next "mkdocs.yml"

---
site_name: The Blue Book
site_description: My second brain
site_author: Lyz
site_url: https://lyz-code.github.io/blue-book
site_dir: site
nav:
  - Introduction: index.md
  - DevOps:
      - devops/devops.md
      - Infrastructure as Code:
          - Helm:
              - devops/helm/helm.md
  - Coding:
      - TDD: coding/tdd.md
      - Python:
          - Libraries:
              - GitPython: coding/python/gitpython.md
  - Botany:
      - Trees: botany/trees.md
  - Emojis: emojis.md

plugins:
  - git-revision-date-localized:
      type: timeago
  - autolinks
  - section-index
  - mkdocs-newsletter

markdown_extensions:
  - toc:
      baselevel: 2
theme:
  name: material
  logo: img/logo.bmp

And I get the next error:

tests/conftest.py:166: in config_
    mkdocs_config = config.load_config(
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/mkdocs/config/base.py:216: in load_config
    from mkdocs.config.defaults import get_schema
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/mkdocs/config/defaults.py:1: in <module>
    from mkdocs.config import config_options
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/mkdocs/config/config_options.py:8: in <module>
    from mkdocs import utils, theme, plugins
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/mkdocs/theme.py:6: in <module>
    from mkdocs.utils import filters
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/mkdocs/utils/filters.py:14: in <module>
    def url_filter(context, value):
../../.venvs/mkdocs-newsletter/lib/python3.9/site-packages/jinja2/filters.py:54: in contextfilter
    warnings.warn(
E   DeprecationWarning: 'contextfilter' is renamed to 'pass_context', the old name will be removed in Jinja 3.1.

I'm using the next versions:

• Python 3.9.10
• Mkdocs 1.2.3
• Jinja2 3.0.3

[frankie567]

Jinja2 3.1.0 has just been released and Mkdocs fails to start/build.

Temporary fix: fix the Jinja2 version to 3.0.3.

# requirements.txt
jinja2==3.0.3

[keawade]

That workaround resolved the issue for now, thanks!

Here is the error I was receiving to help anyone searching for this issue:

AttributeError: module 'jinja2' has no attribute 'contextfilter'

[squidfunk]

I can confirm that (temporarily?) limiting the version range to <3.1 fixes the issue. I just pushed out mkdocs-material-8.2.7 which contains the limited range, so users of Material for MkDocs should not encounter any interruptions.

[daxm]

I can confirm that (temporarily?) limiting the version range to <3.1 fixes the issue. I just pushed out mkdocs-material-8.2.7 which contains the limited range, so users of Material for MkDocs should not encounter any interruptions.

I'm using 'material' theme in mkdocs and I had to pin jinja2 to 3.0.3 just today to get my Docker container to re-build. FYI.

[frankie567]

Sounds like mkdocs-material-8.2.7 release on PyPi has been delayed: GitHub Actions is having issues (again).

[squidfunk]

Sounds like mkdocs-material-8.2.7 release on PyPi has been delayed: GitHub Actions is having issues (again).

Argh. I'll keep trying. Update: 8.2.7 is out.

[daxm]

It looks like mkdocs-material-8.2.7 is "pinning" to jinja2==3.0.3? Is this the case? If/when will it use the "current", 3.1.0, jinja2?

[frankie567]

It looks like mkdocs-material-8.2.7 is "pinning" to jinja2==3.0.3? Is this the case? If/when will it use the "current", 3.1.0, jinja2?

Yes, it is. The goal is to workaround the bug between mkdocs and jinja2==3.1.0: this latest version removed the deprecated contextfilter function, but mkdocs is still using it. That's actually the subject of the current issue.

This workaround will probably be necessary until mkdocs use the new renamed function of jinja2. There's the PR #2795 (or #2800) doing this, but not merged yet.

[daxm]

Works for me.  Just was trying to understand.  :-)

…

On 3/25/22 07:50, François Voron wrote: It looks like mkdocs-material-8.2.7 is "pinning" to jinja2==3.0.3? Is this the case? If/when will it use the "current", 3.1.0, jinja2? Yes, it is. The goal is to workaround the bug between |mkdocs| and |jinja2==3.1.0|: this latest version removed the deprecated |contextfilter| function, but |mkdocs| is still using it. That's actually the subject of the current issue. This workaround will probably be necessary until |mkdocs| use the new renamed function of |jinja2|. There's the PR #2795 <#2795> doing this, but not merged yet. — Reply to this email directly, view it on GitHub <#2794 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZOMZ5AJMA46YXMQHD3EITVBXABRANCNFSM5QNS6OAA>. You are receiving this because you commented.Message ID: ***@***.***>

[oprypin]

MkDocs version 1.2.4 was just released with only a fix for this, as well as version 1.3.0 with more new features.

https://github.com/mkdocs/mkdocs/releases