kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft: small improvements to the todo module

Browse Source 
Small ammeds to the docstrings and the use of `App` and `Gui`
namespaces, and the explicit use of the `ToDo` class
in `PascalCase`.
This commit is contained in:
vocx-fc
2020-05-01 18:04:26 -05:00
committed by Yorik van Havre
parent 14423df83c
commit da413bd2c2
1 changed files with 41 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
src/Mod/Draft/draftutils/todo.py
View File

@@ -23,10 +23,11 @@
# ***************************************************************************
"""Provides the ToDo class for the Draft Workbench.
The ToDo class is used to delay the commit of commands for later execution.
The `ToDo` class is used to delay the commit of commands for later execution.
This is necessary when a GUI command needs to manipulate the 3D view
in such a way that a callback would crash Coin.
The ToDo class essentially calls `QtCore.QTimer.singleShot`
in such a way that a callback would crash `Coin`.
The `ToDo` class essentially calls `QtCore.QTimer.singleShot`
to execute the instructions stored in internal lists.
"""
## @package todo
@@ -38,8 +39,8 @@ import sys
import traceback
from PySide import QtCore
import FreeCAD
import FreeCADGui
import FreeCAD as App
import FreeCADGui as Gui
from draftutils.messages import _msg, _wrn, _err, _log
__title__ = "FreeCAD Draft Workbench, Todo class"
@@ -59,7 +60,7 @@ class ToDo:
Attributes
----------
itinerary : list of tuples
itinerary: list of tuples
Each tuple is of the form `(name, arg)`.
The `name` is a reference (pointer) to a function,
and `arg` is the corresponding argument that is passed
@@ -70,7 +71,7 @@ class ToDo:
name(arg)
name()
commitlist : list of tuples
commitlist: list of tuples
Each tuple is of the form `(name, command_list)`.
The `name` is a string identifier or description of the commands
that will be run, and `command_list` is a list of strings
@@ -82,21 +83,21 @@ class ToDo:
and finally commits the transaction.
::
command_list = ["command1", "command2", "..."]
FreeCAD.ActiveDocument.openTransaction(name)
FreeCADGui.doCommand("command1")
FreeCADGui.doCommand("command2")
FreeCADGui.doCommand("...")
FreeCAD.ActiveDocument.commitTransaction()
App.activeDocument().openTransaction(name)
Gui.doCommand("command1")
Gui.doCommand("command2")
Gui.doCommand("...")
App.activeDocument().commitTransaction()
If `command_list` is a reference to a function
the function is executed directly.
::
command_list = function
FreeCAD.ActiveDocument.openTransaction(name)
App.activeDocument().openTransaction(name)
function()
FreeCAD.ActiveDocument.commitTransaction()
App.activeDocument().commitTransaction()
afteritinerary : list of tuples
afteritinerary: list of tuples
Each tuple is of the form `(name, arg)`.
This list is used just like `itinerary`.
@@ -125,7 +126,7 @@ class ToDo:
todo.commitlist,
todo.afteritinerary))
try:
for f, arg in todo.itinerary:
for f, arg in ToDo.itinerary:
try:
if _DEBUG_inner:
_msg("Debug: executing.\n"
@@ -144,10 +145,10 @@ class ToDo:
except ReferenceError:
_wrn("Debug: ToDo.doTasks: "
"queue contains a deleted object, skipping")
todo.itinerary = []
ToDo.itinerary = []
if todo.commitlist:
for name, func in todo.commitlist:
if ToDo.commitlist:
for name, func in ToDo.commitlist:
if six.PY2:
if isinstance(name, six.text_type):
name = name.encode("utf8")
@@ -156,13 +157,13 @@ class ToDo:
"name: {}\n".format(name))
try:
name = str(name)
FreeCAD.ActiveDocument.openTransaction(name)
App.activeDocument().openTransaction(name)
if isinstance(func, list):
for string in func:
FreeCADGui.doCommand(string)
Gui.doCommand(string)
else:
func()
FreeCAD.ActiveDocument.commitTransaction()
App.activeDocument().commitTransaction()
except Exception:
_log(traceback.format_exc())
_err(traceback.format_exc())
@@ -171,11 +172,11 @@ class ToDo:
"in {1}".format(sys.exc_info()[0], func))
_wrn(wrn)
# Restack Draft screen widgets after creation
if hasattr(FreeCADGui, "Snapper"):
FreeCADGui.Snapper.restack()
todo.commitlist = []
if hasattr(Gui, "Snapper"):
Gui.Snapper.restack()
ToDo.commitlist = []
for f, arg in todo.afteritinerary:
for f, arg in ToDo.afteritinerary:
try:
if _DEBUG_inner:
_msg("Debug: executing after.\n"
@@ -191,7 +192,7 @@ class ToDo:
"{0}\n"
"in {1}({2})".format(sys.exc_info()[0], f, arg))
_wrn(wrn)
todo.afteritinerary = []
ToDo.afteritinerary = []
@staticmethod
def delay(f, arg):
@@ -209,13 +210,13 @@ class ToDo:
Parameters
----------
f : function reference
f: function reference
A reference (pointer) to a Python command
which can be executed directly.
::
f()
arg : argument reference
arg: argument reference
A reference (pointer) to the argument to the `f` function.
::
f(arg)
@@ -223,9 +224,9 @@ class ToDo:
if _DEBUG:
_msg("Debug: delaying.\n"
"function: {}\n".format(f))
if todo.itinerary == []:
QtCore.QTimer.singleShot(0, todo.doTasks)
todo.itinerary.append((f, arg))
if ToDo.itinerary == []:
QtCore.QTimer.singleShot(0, ToDo.doTasks)
ToDo.itinerary.append((f, arg))
@staticmethod
def delayCommit(cl):
@@ -242,7 +243,7 @@ class ToDo:
Parameters
----------
cl : list of tuples
cl: list of tuples
Each tuple is of the form `(name, command_list)`.
The `name` is a string identifier or description of the commands
that will be run, and `command_list` is a list of strings
@@ -253,8 +254,8 @@ class ToDo:
if _DEBUG:
_msg("Debug: delaying commit.\n"
"commitlist: {}\n".format(cl))
QtCore.QTimer.singleShot(0, todo.doTasks)
todo.commitlist = cl
QtCore.QTimer.singleShot(0, ToDo.doTasks)
ToDo.commitlist = cl
@staticmethod
def delayAfter(f, arg):
@@ -275,9 +276,11 @@ class ToDo:
if _DEBUG:
_msg("Debug: delaying after.\n"
"function: {}\n".format(f))
if todo.afteritinerary == []:
QtCore.QTimer.singleShot(0, todo.doTasks)
todo.afteritinerary.append((f, arg))
if ToDo.afteritinerary == []:
QtCore.QTimer.singleShot(0, ToDo.doTasks)
ToDo.afteritinerary.append((f, arg))
# In the past, the class was in lowercase, so we provide a reference
# to it in lowercase, to satisfy the usage of older modules.
todo = ToDo