-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Python API - Refactor Commonly Used Functions #104
Comments
Moved mmSolver.tools.selection.filternodes into mmSolver API, and changed function names. Moved mmSolver.tools.selection.convert into mmSolver API, and changed function names. Moved functions into mmSolver.utils.
Bug fix Collection progress and status logging. Issue #104.
The modules have been refactored. |
…han deprecated 'mmSolver.tools.selection.filternodes' module. Issue #104.
Special effort should be made to ensure this refactor maintains the exact same mmSolver API and, where possible, the same selection helper utility modules. Of course, these moved functions should be marked as deprecated and will be removed at a later date. The biggest offenders will likely be:
|
I don't think this is a big problem, I'm going to close this again, unless a user brings it up as a problem. |
Description
Since the Python API for mmSolver has been designed many new tools have been written. Some of these tools contain duplicate functions (to avoid adding code into the API). Since the initial Python API we have also created a new utilities sub-package.
We should refactor these duplicate functions into either the API (
mmSolver.api
) or utilities (mmSolver.utils
).However, we also want to avoid bloating the API too much, it should be minimalist.
mmSolver.utils
should not have dependencies onmmSolver.api
.mmSolver.api
should not have dependencies onmmSolver.tools
.mmSolver.api
may have dependencies onmmSolver.utils
.mmSolver.tools
may have dependencies onmmSolver.api
andmmSolver.utils
.For example;
Move
mmSolver.tools.selection.convert
tommSolver.api
Move
mmSolver.tools.selection.filternodes
tommSolver.api
All of these changes should be backwards compatible, but with a deprecation warning printed (using Python standard library "warnings" module), if the original function is called.
The text was updated successfully, but these errors were encountered: