mpremote: Allow user configuration on Windows #9573

Josverl · 2022-10-11T08:01:56Z

Simplifies the use of mpremote's user configuration on Windows, by also considering the Windows standard environment variable APPDATA, which is the OS default for storing any user/application related file-based configuration. ( changed from USERPROFILE)

This avoids the need for a Windows user to set the HOME or XDG_CONFIG_HOME environment variable, both of which are non-standard on Windows.

Per Microsoft documentation:

The recommended location for a Windows application to store user settings is in the %APPDATA% folder. This folder is a hidden folder in the user's profile directory that is designed to store application-specific data, including user settings.

However Windows users also are used to %USERPROFILE%, which was established as a location in a previous century.
in order to adhere to both recommended usage ( $XDG_CONFIG_HOME and %APPDATA%) as well as common user practices ($HOME and %USERPROFILE%) , all variables used in a scan for a valid configuration file, and this first config file is used.

Simply stated : newer standards are preferred over the older standards, and Linux environment variables take precidence.

#	ENV_VAR	env_value	Path_checked	platform.system()
1	XDG_CONFIG_HOME	$HOME/.config	/home/foo/.config/mpremote	Linux, Windows(MSYS32), Darwin
2	HOME	/home/boo	/home/foo/.config/mpremote	Linux, Windows(MSYS32), Darwin
3	APPDATA	C:\Users\foo\AppData\Roaming	C:\Users\foo\AppData\Roaming\mpremote	Windows
4	USERPROFILE	C:\Users\foo	C:\Users\foo\mpremote	Windows

tools/mpremote/mpremote/main.py

codecov-commenter · 2022-11-05T21:31:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.38%. Comparing base (907c5e9) to head (a9dd741).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #9573   +/-   ##
=======================================
  Coverage   98.38%   98.38%           
=======================================
  Files         171      171           
  Lines       22283    22283           
=======================================
  Hits        21924    21924           
  Misses        359      359

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2023-03-11T21:46:58Z

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

Josverl · 2023-03-11T22:13:00Z

As this was not yet merged I made a change:

For *nix / Mac - leave the original logic and behaviour
for Windows : use %APPDATA%/mpremote/config.py

tools/mpremote/mpremote/main.py

micropython/micropython#9573 Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

docs/reference/mpremote.rst

tools/mpremote/mpremote/main.py

Josverl · 2023-11-27T18:17:59Z

Rebased again to simplify a merge.
Apparent Errors in CI/CD seem to be grounded into errors thrown by untouched parts the repo

Josverl · 2025-04-10T23:05:24Z

This has been in the Que for more than a few releases now, and I would like this functionality to work on my main Windows platform .
However since the original PR I have have been using the platformdirs module in some of my own tooling to solve the question on where to store what across platforms.

I think the implementation could be much simplified , and made more consistent using this module.
But it will add an additional dependency. Is that something that can be accepted , or steered away from ?
Update:
I have heard no objections, So I went ahead and was able to update the code to just 2 lines, that could be folded into one:

    path = platformdirs.user_config_dir(appname=_PROG, appauthor=False)
    config_file = os.path.join(path, "config.py")

Josverl · 2025-07-08T14:05:34Z

rebased and textual updates to commit messages.

dpgeorge

This is a really nice simplification and enhancement. I usually don't like dependencies, but in this case IMO it's worth it, platformdirs brings in a lot of useful (and tricky) functionality.

Tested it locally (on Arch Linux) and it works well. Arch has a python-platformdirs package (which I already had installed), and it continues to find my config in $(HOME)/.config/mpremote/config.py.

Very good!

Needed to easily find the user configuration file. Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

Use `platformdirs.user_config_dir()` (see https://platformdirs.readthedocs.io/en/latest/api.html#user-config-directory) to provide portability across many different OSes and configuration styles. Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

dpgeorge · 2025-08-01T14:34:09Z

Now merged.

Sorry @Josverl this took so long to get through, but good that it's now much simpler with platformdirs.

Josverl marked this pull request as ready for review October 11, 2022 08:03

Josverl force-pushed the mpremote-win-config branch from 43a896b to b774a7e Compare October 11, 2022 09:11

stinos reviewed Oct 11, 2022

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

Josverl force-pushed the mpremote-win-config branch from b774a7e to 8a54028 Compare October 11, 2022 09:39

stinos reviewed Oct 11, 2022

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

Josverl force-pushed the mpremote-win-config branch 3 times, most recently from dce2f76 to 0fbc081 Compare October 11, 2022 11:26

stinos mentioned this pull request Oct 21, 2022

mpremote utility doesn't find config.py in Windows #9689

Closed

dpgeorge added the tools Relates to tools/ directory in source, or other tooling label Oct 25, 2022

dpgeorge reviewed Oct 31, 2022

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

Josverl force-pushed the mpremote-win-config branch 4 times, most recently from ed59b5b to bf90175 Compare November 5, 2022 20:52

Josverl force-pushed the mpremote-win-config branch from 8630963 to dcc0173 Compare March 11, 2023 21:40

Josverl force-pushed the mpremote-win-config branch from dcc0173 to 7f1c380 Compare March 11, 2023 22:01

Josverl force-pushed the mpremote-win-config branch 2 times, most recently from 4226369 to 0ae37a4 Compare March 11, 2023 22:39

stinos reviewed Mar 12, 2023

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

Josverl added a commit to Josverl/mpremote that referenced this pull request Mar 12, 2023

mpremote: Allow user configuration on Windows

8492145

micropython/micropython#9573 Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

Josverl force-pushed the mpremote-win-config branch from 0ae37a4 to 7d51239 Compare March 12, 2023 22:18

Josverl force-pushed the mpremote-win-config branch 2 times, most recently from b832e8b to 8dabeb8 Compare July 19, 2023 20:16

stinos reviewed Jul 20, 2023

View reviewed changes

docs/reference/mpremote.rst Outdated Show resolved Hide resolved

stinos reviewed Jul 20, 2023

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

stinos reviewed Jul 20, 2023

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

stinos reviewed Jul 20, 2023

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

stinos reviewed Jul 21, 2023

View reviewed changes

tools/mpremote/mpremote/main.py Outdated Show resolved Hide resolved

Josverl force-pushed the mpremote-win-config branch 3 times, most recently from 3185a00 to db2a4bb Compare August 2, 2023 07:59

Josverl requested a review from dpgeorge August 22, 2023 20:48

Josverl force-pushed the mpremote-win-config branch from db2a4bb to 3af2879 Compare August 22, 2023 21:28

Josverl force-pushed the mpremote-win-config branch from 3af2879 to b52cf9e Compare November 27, 2023 17:08

Josverl force-pushed the mpremote-win-config branch from b52cf9e to 493b932 Compare April 10, 2025 22:57

Josverl force-pushed the mpremote-win-config branch from 493b932 to ea8fc9f Compare May 1, 2025 15:25

Josverl requested a review from stinos May 1, 2025 15:34

Josverl mentioned this pull request May 19, 2025

mpremote: Add automatic reconnect feature. #17322

Open

Josverl mentioned this pull request Jul 6, 2025

tools/mpremote: Make resume behavior the default, remove resume command #17485

Draft

dpgeorge added this to the release-1.26.0 milestone Jul 7, 2025

Josverl force-pushed the mpremote-win-config branch 2 times, most recently from 668a415 to 2988268 Compare July 8, 2025 13:46

AJMansfield mentioned this pull request Jul 11, 2025

tools/mpremote/config: Add environment-variable and .env-style config options. #17662

Draft

dpgeorge approved these changes Aug 1, 2025

View reviewed changes

Josverl added 3 commits August 2, 2025 00:20

tools/mpremote: Add platformdirs dependency to requirements.txt.

026a20d

Needed to easily find the user configuration file. Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

docs/reference/mpremote: Document location of config file.

a9dd741

Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>

dpgeorge force-pushed the mpremote-win-config branch from 2988268 to a9dd741 Compare August 1, 2025 14:25

dpgeorge merged commit a9dd741 into micropython:master Aug 1, 2025
69 of 70 checks passed

Josverl deleted the mpremote-win-config branch August 1, 2025 20:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

mpremote: Allow user configuration on Windows #9573

mpremote: Allow user configuration on Windows #9573

Uh oh!

Josverl commented Oct 11, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Nov 5, 2022 •

edited by codecov bot

Loading

Uh oh!

github-actions bot commented Mar 11, 2023 •

edited

Loading

Uh oh!

Josverl commented Mar 11, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Josverl commented Nov 27, 2023

Uh oh!

Josverl commented Apr 10, 2025 •

edited

Loading

Uh oh!

Josverl commented Jul 8, 2025

Uh oh!

dpgeorge left a comment

Uh oh!

Uh oh!

dpgeorge commented Aug 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

mpremote: Allow user configuration on Windows #9573

mpremote: Allow user configuration on Windows #9573

Uh oh!

Conversation

Josverl commented Oct 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Nov 5, 2022 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Mar 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Josverl commented Mar 11, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Josverl commented Nov 27, 2023

Uh oh!

Josverl commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Josverl commented Jul 8, 2025

Uh oh!

dpgeorge left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dpgeorge commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Josverl commented Oct 11, 2022 •

edited

Loading

codecov-commenter commented Nov 5, 2022 •

edited by codecov bot

Loading

github-actions bot commented Mar 11, 2023 •

edited

Loading

Josverl commented Apr 10, 2025 •

edited

Loading

dpgeorge commented Aug 1, 2025 •

edited

Loading