call_report.core.default_download_dir#

call_report.core.default_download_dir() → Path[source]#

Return the folder call_report keeps downloaded files in.

The CALL_REPORT_DOWNLOAD_DIR environment variable is used if it is set. Otherwise the folder is call-report inside the platform’s user data folder.

  • Windows: %LOCALAPPDATA%\call-report

  • macOS: ~/Library/Application Support/call-report

  • Other platforms: $XDG_DATA_HOME/call-report, or ~/.local/share/call-report when XDG_DATA_HOME is not set.

Each source keeps its files in its own subfolder. The folder is not created here.

Returns:
pathlib.Path

The download folder, with any ~ expanded.

Examples

>>> import os
>>> from unittest import mock
>>> with mock.patch.dict(os.environ, {"CALL_REPORT_DOWNLOAD_DIR": "/data/calls"}):
...     default_download_dir().as_posix()
'/data/calls'
On this page