**NOTE: ** This is a pre-release, bugs are expected. Additionally, this version's update checker is bugged and will always notify you that there is an update at startup. Once on this release, feel free to check the "Don't remind me again for this release" checkbox before clicking the "Close" button on the update window. :)
Finally! After years of requests, undo/redo functionality is coming to pyfa!
The goal of this release is to get the current progress in the hands of users so that they can hopefully provide feedback and any error reports that might happen.
What has changed? (user facing)
Hopefully, if everything goes smoothly, the only thing that should have changed is the ability to CTRL+Z to undo an action (and CTRL+SHIFT+Z to redo an undone action). Each fit maintains it's own history of actions, and the action that is undone depends on the currently active fit in the fitting window. It is important to note that actions are stored in memory and aren't persisted - this mean that if you add a module, close pyfa then reopen, you will not be able to "undo" (you could of course remove the module as per usual).
The vast majority of fitting modifications have been converted over to action commands, such as module manipulation, adding fighters, toggling Command fits, etc; however, due to time and generally wanting to get this out the door, I have postponed undo/redo support of certain things for the first iteration (such as fighter ability, booster side effects, mutaplasmid attributes). I will soon create issues on the tracker for conversions that are planned.
Drone split / merge removed. Due to the complexity of this particular functionality (and me being lazy), I've decided to remove the ability to split a drone stack into two stack, or merge two stacks together. The alternative that has been implemented is an option to "Change Quantity" (just like you would change cargo quantity), easily allowing one to reduce / increase the number of drones in a stack. If this is a sorely missed feature, I can certainly revisit adding back to the codebase
What has changed? (technical)
A lot! Basically, the entire system of how the GUI communicated with the backend with regards to fitting changes had to be refactored into a new design pattern. After a bit of research, I decided on using the Command pattern. As a happy surprise, turns out wxPython supports this pattern via wx.Command and wx.CommandProcessor.
If you're familiar with pyfa development, you would know that most of the functions that relate to fit modifications happen int he Fit service - the GUI calls a function on this service, which then does what it needs to do (ie: adds module), commits the change to the database, and then recalculates the fit.
I've broken this out into two different types of commands: Fit and Gui. Fit commands perform the actual work (usually one command does one specific thing to a fit), whereas Gui commands usually act as a proxy to the Fit commands, but can also acts as a context processor, depending on the use case. This was done for two reasons: there are instances where a user action should actually do more than one Fit command, but the GUI should group these as one "command". This is achieved by having the Gui commands incorporate an internal CommandProcessor where we can submit multiple Fit commands. On undo, we loop through the Fit commands and undo each one of those. The second reason is due to the eventual removal of wx.Command dependency on Fit commands, so the Gui command would effectively act as a wrapper for the Fit commands and their custom processor.
I use pyfa code for my project, what do I need to know
Although pyfa has never really officially supported the use case of folks using it's codebase for their own projects, I am aware that there are a few folks out there that do this. You need to know the following:
- If you only use the
eosdirectory (fitting engine), you shouldn't have any issues. Nothing in the engine proper has changed - If you use
service/fit.pyfor it's various helper functions in your project (for adding modules, toggling state, etc), you should know that much of this code has moved toservice/fitDeprecated.pyand will be removed eventually. The Fit service inherits from deprecated, so theoretically you should still be able to access all the functions within your application, but there will be a deprecated warning when using them. It's highly recommended to start migrating over to the fitting commands ingui/fitCommands/calc/- most off these are literally 1:1 matches with the things that were inservice/fit.py
Reporting issues
As always, all issues should be reported on our tracker: https://github.com/pyfa-org/Pyfa/issues. As stated, there's still a few actions that aren't really considered critical that haven't been ported over to the new design pattern. if you have a request for something to be "undoable", please keep in mind that, as of right now, only fit-specific things are supported