Скачать или смотреть How to Ensure User Input Persistence in Your Tkinter App with PyInstaller

Learn how to effectively save user input in your Tkinter application using PyInstaller by writing to the App Data directory instead of temporary directories.
---
This video is based on the question https://stackoverflow.com/q/73457935/ asked by the user 'Rami Hassan' ( https://stackoverflow.com/u/6424190/ ) and on the answer https://stackoverflow.com/a/73458493/ provided by the user 'GordonAitchJay' ( https://stackoverflow.com/u/3589122/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: pyinstaller adding editable file

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Ensuring User Input Persistence in Your Tkinter App with PyInstaller

Creating applications that remember user inputs can greatly enhance user experience. If you’re developing a Tkinter application that utilizes an SSH tunnel and want to save user inputs for future launches, you might encounter some challenges when using PyInstaller. This guide will walk you through the issue and provide a clear solution to ensure that your application saves and retrieves user inputs effectively.

The Problem

When packaging Python applications with PyInstaller, you might notice that the inputs you save before closing the application do not persist the next time you launch it. Instead, your application appears to revert to its initial default values. This problem typically occurs due to how the --onefile option in PyInstaller works.

Why the Input Isn’t Saved

When using the --onefile flag, PyInstaller compiles your application into a single executable. This executable unpacks itself to a temporary directory when run. Any changes made to files in this directory are lost after the application closes because a new temporary directory is created every time the executable is launched. As a result, files written during one session do not exist during the next run, leading to the reversion of your application’s default settings.

The Solution: Using the App Data Directory

The key to resolving this issue is to save your settings to the App Data directory instead of the temporary directory created by PyInstaller. The App Data directory is persistent and will store your user input between application launches.

Step-By-Step Guide to Implementing the Solution

Import Required Libraries:
First, make sure to import the necessary libraries in your Python script.

[[See Video to Reveal this Text or Code Snippet]]

Define the Settings Directory:
Set the path for your settings directory using the environment variable APPDATA, which allows you to write to a platform-specific location.

[[See Video to Reveal this Text or Code Snippet]]

Specify the Settings File Path:
Create a path for your settings JSON file where the inputs will be saved.

[[See Video to Reveal this Text or Code Snippet]]

Load Settings on Start-Up:
When your application starts, attempt to load the saved settings. If the file does not exist, fall back to default values.

[[See Video to Reveal this Text or Code Snippet]]

Save Settings on Application Exit:
Before your application exits, make sure to write the current settings back to the JSON file. Ensure that the directory exists before trying to write the file.

[[See Video to Reveal this Text or Code Snippet]]

Conclusion

By saving your application's settings in the App Data directory, you ensure that user inputs remain intact across sessions, improving the overall user experience. This approach allows your Tkinter application to remember configurations like SSH addresses, usernames, and passwords, thus eliminating the inconvenience of re-entering information every time the app is launched.

Final Note

Implementing this solution can be done quickly, and it can resolve the frustrations encountered when using PyInstaller's --onefile option. Try it out in your Tkinter application and enhance its functionality today!