Deprecation warning in tags plugin after upgrading MkDocs to 1.6

[Thiti517]

Context

When using the Tags plugin i got an exception when i set the tags index (tags_file option in mkdocs.yml). during mkdocs build or mkdocs serve It generate an INFO entry in the logger about a DeprecationWarning exception.

Here are the used packages :

• mkdocs==1.6.0
• mkdocs-material==9.5.19

Bug description

At the beggining of the build/serve process it give the exception : "DeprecationWarning: To replace an existing file, call remove before append.".

Here is the exact exception :

$ mkdocs build
INFO - Cleaning site directory
INFO - Building documentation to directory: /mnt/f/projects/mkdocs-plugins/testing-ground/site
INFO - DeprecationWarning: To replace an existing file, call remove before append.
File ".../material/plugins/tags/plugin.py", line 132, in _get_tags_file
files.append(file)
File ".../mkdocs/structure/files.py", line 100, in append
warnings.warn(
INFO - Documentation built in 0.71 seconds
$

without the tags_file option set in mkdocs.yml there is no such exception

Related links

• Reporting a bug
• Seeting up tags —> Adding a tags index

Reproduction

9.5.19-tags-plugin-deprecationwarning-exception.zip

Steps to reproduce

1. Setup tags with the tags_file option in an mkdocs project with mkdocs-material
2. use mkdocs build or mkdocs serve

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[perpil]

I'm also seeing similar warnings on mkdocs_git_revision_date_localized_plugin and the privacy plugins. If you'd like a separate issue for these, let me know and I'll cut one.

INFO    -  DeprecationWarning: Do not access Theme._vars, instead access the keys of Theme directly.
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs_git_revision_date_localized_plugin/plugin.py", line 82, in on_config
               theme_locale = custom_theme._vars.get("locale")
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs/theme.py", line 87, in _vars
               warnings.warn(
INFO    -  DeprecationWarning: To replace an existing file, call `remove` before `append`.
             File "<snip>/mkdocs-material/material/plugins/privacy/plugin.py", line 445, in _queue
               self.assets.append(file)
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs/structure/files.py", line 100, in append
               warnings.warn(

[squidfunk]

Thanks for reporting. Yes, those deprecation warnings are from MkDocs 1.6. It's a good idea to report the warning for the git-revision-date-localized-plugin upstream, if you can spare some time. I'll take care of the other warnings. Note that they do not impact the build, so you can just ignore them for now.

[squidfunk]

Fixed in cff4a75. I checked the release notes of 1.6, and either I'm not seeing it, or there was no mention of the fact that the files collection seems to have undergone a refactoring, inducing those deprecations. I'll check if I can reproduce the problem with the privacy plugin, or if we need a reproduction for that.

[squidfunk]

The privacy plugin should also be fixed in ff49d74. If not, please create a new issue with a minimal reproduction ✌️

[squidfunk]

Released as part of 9.5.20.

[HotCakeX]

I'm also seeing similar warnings on mkdocs_git_revision_date_localized_plugin and the privacy plugins. If you'd like a separate issue for these, let me know and I'll cut one.

INFO    -  DeprecationWarning: Do not access Theme._vars, instead access the keys of Theme directly.
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs_git_revision_date_localized_plugin/plugin.py", line 82, in on_config
               theme_locale = custom_theme._vars.get("locale")
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs/theme.py", line 87, in _vars
               warnings.warn(
INFO    -  DeprecationWarning: To replace an existing file, call `remove` before `append`.
             File "<snip>/mkdocs-material/material/plugins/privacy/plugin.py", line 445, in _queue
               self.assets.append(file)
             File "/opt/homebrew/lib/python3.10/site-packages/mkdocs/structure/files.py", line 100, in append
               warnings.warn(

Hi,
I'm still seeing this on version 9.5.20, i personally don't know the technical details behind this warning message to report it to their repo in a proper detailed issue, because to me they're just abnormal warnings.

[squidfunk]

Reading the stack trace, this comes from the git-revision-date-localized-plugin. Please report it upstream.

[timvink]

FYI, new release is now on pypi https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases/tag/v1.2.5

[HotCakeX]

Thank you ^^
updating!

[squidfunk]

Awesome, thanks for fixing this so quickly, Tim!