e78f74b01a
Added a "User parameter:BaseApp/Preferences/PythonConsole/ProfilerInterval" int property which sets how often (in milliseconds) the Python profiler runs while Python code is running. Setting this value to zero will totally disable it. Also added a preference in the Python console screen which allows the user to set the value of this property to between 0 (disabled) and 5000 (once every 5 seconds). (+1 squashed commits) Squashed commits: [cca88ac633] Made the Python profiler only run when the console is running code This has two purposes. First, it prevents a performance impact from running the profiler whenever Python code is running. Second, it prevents crashes caused by Qt's process events function being called too frequently. When the Python code is running in the console, it monopolizes the main thread and prevents events from being processed. Therefore, causing events to be processed in the callback should not force events to be processed too frequently, because the normal loop is being prevented by the Python code. (+1 squashed commits) Squashed commits: [45f86917e6] Made long-running Python code not freeze the GUI without multithreading Removed the background thread running Python code and replaced it with a custom profiler which the Python interpreter runs frequently (at every Python opcode I believe) on the main thread whenever Python code is running. The profiler will make Qt process any new events every 200 ms, preventing "App not responding" messages and making sure any Ctrl+C keypresses will be processed. This prevents the previous issue where running anything GUI-related from Python would crash the program (because Qt isn't thread-safe). (+1 squashed commits) Squashed commits: [0ef7d810b3] Made the process of getting thread IDs cross-platform compatible Instead of using <threads.h>, now the standard <thread> header from C++ 11 is used to find the thread ID, since <threads.h> is apparently not available on Windows. (+1 squashed commits) Squashed commits: [74c7b867f2] # This is a combination of 2 commits. Python from the console now runs in the background In a nutshell, all Python code which is input from the interactive console now runs in a seperate QThread which runs in the background, instead of on the UI thread. This means that long operates operations will no longer cause the app to display an "App not responding" message, because the UI thread is now free to keep running unencumbered. However, it is still not possible to run multiple Python statements at the same time. If the user tries to run some Python while a previous statement is still being processed, instead it will display an error message in the console stating that the previous command is still being processed. I also added a seperate QTimer which runs once every 100ms to flush any output from the Python code back to the console. I can't flush the output to the console from the background thread because the relevant Qt5 code is not thread-safe (it causes random segfaults). So I added this timer as a work-around, since it runs in the main UI thread. Implemented Ctrl+C keyboard interrupts in the console This is implemented by detecting a Ctrl+C key event in the Python console in the main Qt UI thread, and sending a keyboard interrupt to the background thread that runs the Python code.
119 lines
3.8 KiB
C++
119 lines
3.8 KiB
C++
// SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
/***************************************************************************
|
|
* Copyright (c) 2023 Werner Mayer <wmayer[at]users.sourceforge.net> *
|
|
* *
|
|
* This file is part of FreeCAD. *
|
|
* *
|
|
* FreeCAD is free software: you can redistribute it and/or modify it *
|
|
* under the terms of the GNU Lesser General Public License as *
|
|
* published by the Free Software Foundation, either version 2.1 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* FreeCAD is distributed in the hope that it will be useful, but *
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
* Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public *
|
|
* License along with FreeCAD. If not, see *
|
|
* <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
**************************************************************************/
|
|
|
|
#ifndef GUI_PYTHONTRACING_H
|
|
#define GUI_PYTHONTRACING_H
|
|
|
|
#include <Python.h>
|
|
#include <frameobject.h>
|
|
#include <memory>
|
|
#include <FCGlobal.h>
|
|
|
|
|
|
namespace Gui {
|
|
|
|
class GuiExport PythonTracing
|
|
{
|
|
public:
|
|
PythonTracing();
|
|
~PythonTracing();
|
|
|
|
PythonTracing(const PythonTracing&) = delete;
|
|
PythonTracing(PythonTracing&&) = delete;
|
|
PythonTracing& operator = (const PythonTracing&) = delete;
|
|
PythonTracing& operator = (PythonTracing&&) = delete;
|
|
|
|
/*!
|
|
* \brief isActive
|
|
* Returns true if the tracing is active, false otherwise.
|
|
* \return
|
|
*/
|
|
bool isActive() const;
|
|
/*!
|
|
* \brief activate
|
|
* Activates the Python tracing.
|
|
*/
|
|
void activate();
|
|
/*!
|
|
* \brief deactivate
|
|
* Deactivates the Python tracing.
|
|
*/
|
|
void deactivate();
|
|
/*!
|
|
* \brief fetchFromSettings
|
|
* Fetch parameters from user settings.
|
|
*/
|
|
void fetchFromSettings();
|
|
/*!
|
|
* \brief interrupt
|
|
* If the tracing is enabled it interrupts the Python interpreter.
|
|
* True is returned if the tracing is active, false otherwise.
|
|
*/
|
|
bool interrupt() const;
|
|
/*!
|
|
* \brief setTimeout
|
|
* Sets the interval after which the Qt event loop will be processed.
|
|
*/
|
|
void setTimeout(int ms);
|
|
/*!
|
|
* \brief timeout
|
|
* \return the timeout of processing the event loop.
|
|
*/
|
|
int timeout() const;
|
|
|
|
private:
|
|
void setPythonTraceEnabled(bool enabled) const;
|
|
static int tracer_callback(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg);
|
|
|
|
private:
|
|
struct Private;
|
|
std::unique_ptr<Private> d;
|
|
};
|
|
|
|
class GuiExport PythonTracingLocker
|
|
{
|
|
public:
|
|
/*!
|
|
* \brief PythonTracingLocker
|
|
* Activates the passed tracing object.
|
|
* \param trace
|
|
*/
|
|
explicit PythonTracingLocker(PythonTracing& trace);
|
|
/*!
|
|
* Deactivates the tracing object.
|
|
*/
|
|
~PythonTracingLocker();
|
|
|
|
PythonTracingLocker(const PythonTracingLocker&) = delete;
|
|
PythonTracingLocker(PythonTracingLocker&&) = delete;
|
|
PythonTracingLocker& operator = (const PythonTracingLocker&) = delete;
|
|
PythonTracingLocker& operator = (PythonTracingLocker&&) = delete;
|
|
|
|
private:
|
|
PythonTracing& trace;
|
|
};
|
|
|
|
} // namespace Gui
|
|
|
|
#endif // GUI_PYTHONTRACING_H
|