DeprecationWarning on a fresh install on CI

[mgeier]

When invoking nbconvert on CI with warnings turned into errors (e.g. https://github.com/mgeier/nbsphinx/actions/runs/8581467203/job/23518524054), I'm getting this warning/error:

Exception occurred:
  File "/Library/Frameworks/Python.framework/Versions/3.12/lib/python3.12/site-packages/jupyter_core/utils/__init__.py", line 90, in deprecation
    warnings.warn(message, DeprecationWarning, stacklevel=stacklevel + 1)
DeprecationWarning: Jupyter is migrating its paths to use standard platformdirs
given by the platformdirs library.  To remove this warning and
see the appropriate new directories, set the environment variable
`JUPYTER_PLATFORM_DIRS=1` and then run `jupyter --paths`.
The use of platformdirs will be the default in `jupyter_core` v6

I would expect the module to work out-of-the-box if freshly installed.
Am I supposed to run jupyter --paths each time in CI?

[liquidcarbon]

I got this stuff showing up in pytests, in a package I'm building from scratch.
Oddly, it first appeared on adding from loguru import logger.

Here is a decent workaround, allowing the test files to import stuff from main package without the nuisance warning.

# tests/__init__.py

import os

# disable DeprecationWarning https://github.com/jupyter/jupyter_core/issues/398
os.environ["JUPYTER_PLATFORM_DIRS"] = "1"

[sglbl]

If you got this error while using pytest you can also create a pytest.ini file where conftest or tester script is located:
Content:

[pytest]
filterwarnings =  
    ignore::DeprecationWarning
    ignore::FutureWarning

[Pitrified]

sglbl got me on the right path but I prefer to avoid a blanket filter on all DeprecationWarnings, so I put this in my pyproject.toml

[tool.pytest.ini_options]
filterwarnings = [
    "ignore:.*Jupyter is migrating.*:DeprecationWarning",
]

A very similar syntax should work for pytest.ini

Cheers!