10677baa40
Fixes #2506 ``XDG_CACHE_HOME`` does not work on Windows. To allow for users to set a custom cache directory on all systems I added a new environment variable ``BLACK_CACHE_DIR`` to set the cache directory. The default remains the same so users will only notice a change if that environment variable is set. The specific use case I have for this is I need to run black on in different processes at the same time. There is a race condition with the cache pickle file that made this rather difficult. A custom cache directory will remove the race condition. I created ``get_cache_dir`` function in order to test the logic. This is only used to set the ``CACHE_DIR`` constant.
1.8 KiB
File collection and discovery
You can directly pass Black files, but you can also pass directories and Black will walk them, collecting files to format. It determines what files to format or skip automatically using the inclusion and exclusion regexes and as well their modification time.
Ignoring unmodified files
Black remembers files it has already formatted, unless the --diff flag is used or
code is passed via standard input. This information is stored per-user. The exact
location of the file depends on the Black version and the system on which Black is
run. The file is non-portable. The standard location on common operating systems is:
- Windows:
C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle - macOS:
/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle - Linux:
/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle
file-mode is an int flag that determines whether the file was formatted as 3.6+ only,
as .pyi, and whether string normalization was omitted.
To override the location of these files on all systems, set the environment variable
BLACK_CACHE_DIR to the preferred location. Alternatively on macOS and Linux, set
XDG_CACHE_HOME to you your preferred location. For example, if you want to put the
cache in the directory you're running Black from, set BLACK_CACHE_DIR=.cache/black.
Black will then write the above files to .cache/black. Note that BLACK_CACHE_DIR
will take precedence over XDG_CACHE_HOME if both are set.
.gitignore
If --exclude is not set, Black will automatically ignore files and directories in
.gitignore file(s), if present.
If you want Black to continue using .gitignore while also configuring the exclusion
rules, please use --extend-exclude.