Privacy plugin breaks on files stored in memory

[landmaj]

Context

The bug was encountered by a user of mkdocs-d2-plugin. Relevant issue: landmaj/mkdocs-d2-plugin#21

Bug description

The privacy plugin passes abs_src_path to open() without checking for None, which results in an error:

TypeError: expected str, bytes or os.PathLike object, not NoneType

None is a valid value since MkDocs 1.6, as described here:

Since MkDocs 1.6 a file may alternatively be stored in memory - content_string/content_bytes.

Then src_dir and abs_src_path will remain None. content_bytes/content_string need to be written to, or populated through the content argument in the constructor.

The (valid) code in my plugin which causes privacy plugin to crash is this:

  def on_files(self, files: Files, config):
      content = importlib_files("d2.css").joinpath("mkdocs_d2_plugin.css").read_text()
      file = File(
          "assets/stylesheets/mkdocs_d2_plugin.css",
          None,
          config["site_dir"],
          config["use_directory_urls"],
      )
      file.content_string = content

      files.append(file)

Related links

• Reporting a bug

Reproduction

9.5.48-privacy-plugin-crash.zip

Steps to reproduce

1. Run mkdocs build with privacy and d2 plugins enabled.

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.

[squidfunk]

Thanks for reporting. Fixed in 968fbe1. To be honest, a fundamental change like this to MkDocs' plugin API would actually mandate a major release, IMHO. We're probably not the only plugin that is impacted by this breaking change.

[squidfunk]

Released as part of 9.5.49.