Repository navigation
🐛 fix(api): accept roaming in user_log_dir and user_log_path - #572
Merged
Merged
Conversation
gaborbernat
force-pushed
the
fix/log-roaming
branch
2 times, most recently
from
September 25, 2026 14:55
79f20f6 to
93bacb4
Compare
On Windows user_log_dir is a subdirectory of user_data_dir, which a caller moves from AppData\Local to AppData\Roaming with roaming=True. PlatformDirs(roaming=True) returns the Roaming log directory, but user_log_dir() and user_log_path() had no roaming argument. Passing it raised TypeError, and function callers got the Local directory. Add roaming as a keyword-only argument after use_site_for_root, the placement tox-dev#537 and tox-dev#544 used, so positional callers see no change.
gaborbernat
force-pushed
the
fix/log-roaming
branch
from
September 25, 2026 16:50
93bacb4 to
acfc9a3
Compare
gaborbernat
enabled auto-merge (squash)
September 25, 2026 17:03
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On Windows
user_log_diris a subdirectory ofuser_data_dir, which a caller moves fromAppData\LocaltoAppData\Roamingwithroaming=True.PlatformDirs(roaming=True)returns the Roaming log directory. The module functionsuser_log_dir()anduser_log_path()rejectedroamingwith aTypeError, so function callers could not reach it. 🪟Both functions accept
roamingby keyword alone, afteruse_site_for_root, the slot where #544 and #537 placedmultipathanduse_site_for_root. Positional callers see no change.Outside Windows the flag has no effect, as with
user_data_dir.