Python API - Refactor Commonly Used Functions #104
Assignees
Labels
maya tool
A user tool inside Maya.
maya utility
Python modules to be used across the mmSolver project.
python api
The Python API for mmSolver
Milestone
Comments
david-cattermole
added
maya tool
david-cattermole
added a commit
that referenced
this issue
Jun 2, 2019
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.
david-cattermole
added a commit
that referenced
this issue
Jun 2, 2019
Bug fix Collection progress and status logging. Issue #104.
david-cattermole
added a commit
that referenced
this issue
Jun 2, 2019
|
The modules have been refactored. |
david-cattermole
added a commit
that referenced
this issue
Jun 23, 2019
…han deprecated 'mmSolver.tools.selection.filternodes' module. Issue #104.
david-cattermole
added a commit
that referenced
this issue
Jun 30, 2019
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.utilsshould not have dependencies onmmSolver.api.mmSolver.apishould not have dependencies onmmSolver.tools.mmSolver.apimay have dependencies onmmSolver.utils.mmSolver.toolsmay have dependencies onmmSolver.apiandmmSolver.utils.For example;
Move
mmSolver.tools.selection.converttommSolver.apiMove
mmSolver.tools.selection.filternodestommSolver.apiAll 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: