Editing Python Desk Top Applications
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | This | + | This will be a page about how I write my desktop applications, and so naturally, how I would recommend they be writtern. It also documents the structure of most of the applications that I have documented on this wiki. Try them and let me know how you think they might be better. |
− | + | [[Python Smart Plug Technical]] | |
= Overview = | = Overview = | ||
== General Information == | == General Information == | ||
− | These notes are here so you can more easily modify my code and build your own. | + | These notes are here so you can more easily modify my code and build your own. |
− | + | Here is an overview of the general plan, details can be filled out by reading the example code in my projects ( see category ..... below). | |
+ | |||
+ | The overall architecture is called the model view controller or MVC. | ||
− | + | The main program is the controller. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The view component is called GUI ( typically gui.py with the class name GUI ). It creates all the visible components, and relays user input to the controller. | |
+ | You can unplug the GUI object from the application and plug in new components. Don't like the GUI? You could modify mine, or you could make a modification and choose which one to use. This is sort of like a skin for an application. | ||
− | + | == Other Important Components == | |
+ | |||
+ | ==== Logger ==== | ||
+ | Logger ( in logger.py ) and Parameters ( in parameters.py ). The controller creates one of each, and make them available to the other components. The other components can interact with them, and uses them respectively for logging events, and getting access to parameters ( those aspects of the application that are particularly easy to change ). I describe more of this in [[My Python Coding Conventions]] | ||
+ | |||
+ | ==== Parameters ==== | ||
+ | |||
+ | This is a fairly big topic. It is how you or your user easily controls some aspect of the program. See '''[[Configuration Files For Python]]'''. | ||
+ | |||
+ | ==== AppGlobal ==== | ||
− | + | Global Values: Yes I know that globals are bad, but they can be useful. For example many class instances need to access the parameter file. This can be done using the singleton class AppGlobal. | |
+ | It has values at the class level ( not instance ) that are available simply by importing the class. Many values are originally defaulted to None, and are set to valid values as the application initializes and runs, starting, default values often come from parameters. | ||
− | + | ==== Helper Tread ==== | |
− | |||
− | |||
− | |||
+ | The application has a main thread running in a Tkinter mainloop. There is also a second thread called a "helper" running which makes some processing much easier. To make GUI mainloop responsive to both the GUI and its own processing it uses a pseudo event loop or a polling subroutine that is implemented in xxxxx. The frequency which polling occurs is set in parameters, the relatively low rate of 100 ms between calls ( .1 sec ) seems to give a perfectly responsive application in most cases. I have run it as fast as once every 10 ms. Have not tried to find a limit. | ||
− | + | === Database === | |
− | |||
− | |||
− | |||
== Development Environment == | == Development Environment == | ||
*Windows 10 64bit | *Windows 10 64bit | ||
− | *Anaconda Spyder | + | *Anaconda Spyder 3.x |
*Python 3.7 | *Python 3.7 | ||
Line 53: | Line 51: | ||
*Python 3.6 up. | *Python 3.6 up. | ||
− | I | + | I have run in: |
− | + | Windows 10, Python 3.7 | |
− | * | + | *more coming, or let me know. |
− | + | ||
− | + | = Components and Functions = | |
− | |||
− | |||
* Tkinter for the GUI | * Tkinter for the GUI | ||
* pyLogging for logging | * pyLogging for logging | ||
+ | * SmartTerminal a model-view-controller controller with some modifications ( '''[https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller - Wikipedia ]''' or perhaps closer to '''[https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93presenter Model–view–presenter - Wikipedia ]''' ) | ||
* Second thread for processing without being blocked by/blocking the GUI | * Second thread for processing without being blocked by/blocking the GUI | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
* Global Singleton for app cohesion. | * Global Singleton for app cohesion. | ||
* Parameter file for easy customization. | * Parameter file for easy customization. | ||
− | * | + | * Mathplotlib for graphing. |
− | * | + | * SQLLite for the database. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | == The Controllers for Smart Plug == | |
− | == The Controllers for | ||
The class for the MVC controller is also the class you create to run the application: see the code at the bottom of the file, just run the file. Similar code is at the bottom of some of the other source files to make it convenient to run from those files, this is just to make it easier in development, the code in smart_plug.py is the model for what should be used. Sometimes the code at the bottom of other file may have code for testing objects in the file, it may not be maintained, may not work as intended. | The class for the MVC controller is also the class you create to run the application: see the code at the bottom of the file, just run the file. Similar code is at the bottom of some of the other source files to make it convenient to run from those files, this is just to make it easier in development, the code in smart_plug.py is the model for what should be used. Sometimes the code at the bottom of other file may have code for testing objects in the file, it may not be maintained, may not work as intended. | ||
The __init__ method is the initialization and "run" method for the application. Much of the code that would normally be in it has been moved to .restart which is used to restart the application when just the parameters have been changed. See the docstring there. | The __init__ method is the initialization and "run" method for the application. Much of the code that would normally be in it has been moved to .restart which is used to restart the application when just the parameters have been changed. See the docstring there. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Threads == | == Threads == | ||
Line 139: | Line 82: | ||
=== HelperThread === | === HelperThread === | ||
− | + | Refers to similar but different program !! Will update for this program soon. | |
− | + | HelperThread in smart_terminal_helper.py This class provides the support for a second thread of execution that does not block the main thread being run by Tinker. I call the two threads the GUI Thread (gt) and the Helper Thread ( ht ). It can get confusing keeping track of which method is running in which thread, I sometimes annotate them with gt and ht. The helper thread is started by running HelperThread.run() which pretty much just runs a polling task in HelperThread.polling(). HelperThread.polling() is an infinite loop, it uses sleep to set the polling rate. When used with the green house processing module, it may call a function there that is its own infinite loop. There are a lot of details here, I should write some more about it. | |
− | |||
− | |||
− | |||
− | |||
== Parameters == | == Parameters == | ||
− | |||
− | |||
Parameters ( in parameters.py ) this is pretty much a structure ( that is all instance variables ) that is instantiated early in the life of the application. It passes values, strings, numbers, objects to application elements that need them. The instance of parameters is made globally available thru the AppGlobal class. Values in Parameters are treated as constants, read only. Much of the appearance and behavior of the application is controlled here. | Parameters ( in parameters.py ) this is pretty much a structure ( that is all instance variables ) that is instantiated early in the life of the application. It passes values, strings, numbers, objects to application elements that need them. The instance of parameters is made globally available thru the AppGlobal class. Values in Parameters are treated as constants, read only. Much of the appearance and behavior of the application is controlled here. | ||
Line 164: | Line 101: | ||
== DataBase == | == DataBase == | ||
− | + | ||
+ | The database is SQLLite. So far it seems adequate to the task. Access is via string of SQL and variables bound to those statements. Look for the code in ....... | ||
+ | |||
+ | == Polling == | ||
+ | Both threads have method that perform polling for events often for items in their queue that may have been sent from the other thread. Info on a similar app in [[Python Smart Terminal Technical Details]]. | ||
== Logging == | == Logging == | ||
− | This uses the standard Python logging class. Logging level and other logging details are controlled using the parameter file | + | This uses the standard Python logging class. Logging level and other logging details are controlled using the parameter file. |
− | |||
− | |||
− | |||
− | |||
== Other Classes == | == Other Classes == | ||
For now the documentation, as far as it exists is in the source code. This probably will not change. | For now the documentation, as far as it exists is in the source code. This probably will not change. | ||
+ | |||
= Coding Conventions = | = Coding Conventions = | ||
Line 191: | Line 129: | ||
− | [[Category:Python]] [[Category:Python Projects]] [[Category:SmartTerminal]][[Category:Python SmartPlug]] [[Category:Python Easy | + | [[Category:Python]] [[Category:Python Projects]] [[Category:SmartTerminal]][[Category:Python SmartPlug]] [[Category:Python Easy DB]] |