Prepare release 22.3.0 (#2968)

[etc/vim.git] / src / black / cache.py

diff --git a/src/black/cache.py b/src/black/cache.py
index bca7279f990bd222259fa9d362c1c18a60b38075..552c248d2ad0644f4855df562b9265ad6b649dd6 100644 (file)
--- a/src/black/cache.py
+++ b/src/black/cache.py
@@ -20,7 +20,23 @@ CacheInfo = Tuple[Timestamp, FileSize]
 Cache = Dict[str, CacheInfo]
 
 
 Cache = Dict[str, CacheInfo]
 
 

-CACHE_DIR = Path(user_cache_dir("black", version=__version__))
+def get_cache_dir() -> Path:
+    """Get the cache directory used by black.
+
+    Users can customize this directory on all systems using `BLACK_CACHE_DIR`
+    environment variable. By default, the cache directory is the user cache directory
+    under the black application.
+
+    This result is immediately set to a constant `black.cache.CACHE_DIR` as to avoid
+    repeated calls.
+    """
+    # NOTE: Function mostly exists as a clean way to test getting the cache directory.
+    default_cache_dir = user_cache_dir("black", version=__version__)
+    cache_dir = Path(os.environ.get("BLACK_CACHE_DIR", default_cache_dir))
+    return cache_dir
+
+
+CACHE_DIR = get_cache_dir()

 
 
 def read_cache(mode: Mode) -> Cache:
 
 
 def read_cache(mode: Mode) -> Cache: