QCoreApplication

The QCoreApplication class provides an event loop for Qt applications without UI. More

Inheritance diagram of PySide2.QtCore.QCoreApplication

Inherited by: QGuiApplication, QApplication

Synopsis

Functions

Virtual functions

Static functions

Detailed Description

This class is used by non-GUI applications to provide their event loop. For non-GUI application that uses Qt, there should be exactly one QCoreApplication object. For GUI applications, see QGuiApplication . For applications that use the Qt Widgets module, see QApplication .

QCoreApplication contains the main event loop, where all events from the operating system (e.g., timer and network events) and other sources are processed and dispatched. It also handles the application’s initialization and finalization, as well as system-wide and application-wide settings.

The Event Loop and Event Handling

The event loop is started with a call to exec() . Long-running operations can call processEvents() to keep the application responsive.

In general, we recommend that you create a QCoreApplication , QGuiApplication or a QApplication object in your main() function as early as possible. exec() will not return until the event loop exits; e.g., when quit() is called.

Several static convenience functions are also provided. The QCoreApplication object is available from instance() . Events can be sent with sendEvent() or posted to an event queue with postEvent() . Pending events can be removed with removePostedEvents() or dispatched with sendPostedEvents() .

The class provides a quit() slot and an aboutToQuit() signal.

Application and Library Paths

An application has an applicationDirPath() and an applicationFilePath() . Library paths (see QLibrary ) can be retrieved with libraryPaths() and manipulated by setLibraryPaths() , addLibraryPath() , and removeLibraryPath() .

Internationalization and Translations

Translation files can be added or removed using installTranslator() and removeTranslator() . Application strings can be translated using translate() . The tr() and trUtf8() functions are implemented in terms of translate() .

Accessing Command Line Arguments

The command line arguments which are passed to QCoreApplication ‘s constructor should be accessed using the arguments() function.

Note

QCoreApplication removes option -qmljsdebugger="..." . It parses the argument of qmljsdebugger , and then removes this option plus its argument.

For more advanced command line option handling, create a QCommandLineParser .

Locale Settings

On Unix/Linux Qt is configured to use the system locale settings by default. This can cause a conflict when using POSIX functions, for instance, when converting between data types such as floats and strings, since the notation may differ between locales. To get around this problem, call the POSIX function setlocale(LC_NUMERIC,"C") right after initializing QApplication , QGuiApplication or QCoreApplication to reset the locale that is used for number formatting to “C”-locale.

See also

QGuiApplication QAbstractEventDispatcher QEventLoop Semaphores Example Wait Conditions Example

class QCoreApplication

QCoreApplication(arg__1)

Parameters

arg__1 – list of strings

PySide2.QtCore.QCoreApplication.ApplicationFlags

New in version 4.8.

static PySide2.QtCore.QCoreApplication.addLibraryPath(arg__1)
Parameters

arg__1 – unicode

Prepends path to the beginning of the library path list, ensuring that it is searched for libraries first. If path is empty or already in the path list, the path list is not changed.

The default path list consists of a single entry, the installation directory for plugins. The default installation directory for plugins is INSTALL/plugins , where INSTALL is the directory where Qt was installed.

The library paths are reset to the default when an instance of QCoreApplication is destructed.

static PySide2.QtCore.QCoreApplication.applicationDirPath()
Return type

unicode

Returns the directory that contains the application executable.

For example, if you have installed Qt in the C:\Qt directory, and you run the regexp example, this function will return “C:/Qt/examples/tools/regexp”.

On macOS and iOS this will point to the directory actually containing the executable, which may be inside an application bundle (if the application is bundled).

Warning

On Linux, this function will try to get the path from the /proc file system. If that fails, it assumes that argv[0] contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.

static PySide2.QtCore.QCoreApplication.applicationFilePath()
Return type

unicode

Returns the file path of the application executable.

For example, if you have installed Qt in the /usr/local/qt directory, and you run the regexp example, this function will return “/usr/local/qt/examples/tools/regexp/regexp”.

Warning

On Linux, this function will try to get the path from the /proc file system. If that fails, it assumes that argv[0] contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.

static PySide2.QtCore.QCoreApplication.applicationName()
Return type

unicode

PySide2.QtCore.QCoreApplication.applicationNameChanged()
static PySide2.QtCore.QCoreApplication.applicationPid()
Return type

qint64

Returns the current process ID for the application.

static PySide2.QtCore.QCoreApplication.applicationVersion()
Return type

unicode

PySide2.QtCore.QCoreApplication.applicationVersionChanged()
static PySide2.QtCore.QCoreApplication.arguments()
Return type

list of strings

Returns the list of command-line arguments.

Usually .at(0) is the program name, .at(1) is the first argument, and .last() is the last argument. See the note below about Windows.

Calling this function is slow - you should store the result in a variable when parsing the command line.

Warning

On Unix, this list is built from the argc and argv parameters passed to the constructor in the main() function. The string-data in argv is interpreted using fromLocal8Bit() ; hence it is not possible to pass, for example, Japanese command line arguments on a system that runs in a Latin1 locale. Most modern Unix systems do not have this limitation, as they are Unicode-based.

On Windows, the list is built from the argc and argv parameters only if modified argv/argc parameters are passed to the constructor. In that case, encoding problems might occur.

Otherwise, the are constructed from the return value of GetCommandLine(). As a result of this, the string given by .at(0) might not be the program name on Windows, depending on how the application was started.

static PySide2.QtCore.QCoreApplication.closingDown()
Return type

bool

Returns true if the application objects are being destroyed; otherwise returns false .

See also

startingUp()

static PySide2.QtCore.QCoreApplication.eventDispatcher()
Return type

QAbstractEventDispatcher

Returns a pointer to the event dispatcher object for the main thread. If no event dispatcher exists for the thread, this function returns None .

static PySide2.QtCore.QCoreApplication.exec_()
Return type

int

Enters the main event loop and waits until exit() is called. Returns the value that was passed to exit() (which is 0 if exit() is called via quit() ).

It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets.

To make your application perform idle processing (by executing a special function whenever there are no pending events), use a QTimer with 0 timeout. More advanced idle processing schemes can be achieved using processEvents() .

We recommend that you connect clean-up code to the aboutToQuit() signal, instead of putting it in your application’s main() function because on some platforms the call may not return. For example, on Windows when the user logs off, the system terminates the process after Qt closes all top-level windows. Hence, there is no guarantee that the application will have time to exit its event loop and execute code at the end of the main() function after the call.

See also

quit() exit() processEvents() exec()

static PySide2.QtCore.QCoreApplication.exit([retcode=0])
Parameters

retcodeint

Tells the application to exit with a return code.

After this function has been called, the application leaves the main event loop and returns from the call to exec() . The exec() function returns returnCode . If the event loop is not running, this function does nothing.

By convention, a returnCode of 0 means success, and any non-zero value indicates an error.

It’s good practice to always connect signals to this slot using a QueuedConnection . If a signal connected (non-queued) to this slot is emitted before control enters the main event loop (such as before “int main” calls exec() ), the slot has no effect and the application never exits. Using a queued connection ensures that the slot will not be invoked until after control enters the main event loop.

Note that unlike the C library function of the same name, this function does return to the caller – it is event processing that stops.

See also

quit() exec()

static PySide2.QtCore.QCoreApplication.flush()

Note

This function is deprecated.

This function is equivalent to calling QCoreApplication::eventDispatcher()->flush() , which also is deprecated, see flush() . Use sendPostedEvents() and processEvents() for more fine-grained control of the event loop instead.

Historically this functions was used to flush the platform-specific native event queues.

static PySide2.QtCore.QCoreApplication.hasPendingEvents()
Return type

bool

Note

This function is deprecated.

This function returns true if there are pending events; otherwise returns false . Pending events can be either from the window system or posted events using postEvent() .

Note

this function is not thread-safe. It may only be called in the main thread and only if there are no other threads running in the application (including threads Qt starts for its own purposes).

PySide2.QtCore.QCoreApplication.installNativeEventFilter(filterObj)
Parameters

filterObjQAbstractNativeEventFilter

Installs an event filter filterObj for all native events received by the application in the main thread.

The event filter filterObj receives events via its nativeEventFilter() function, which is called for all native events received in the main thread.

The nativeEventFilter() function should return true if the event should be filtered, i.e. stopped. It should return false to allow normal Qt processing to continue: the native event can then be translated into a QEvent and handled by the standard Qt event filtering, e.g. installEventFilter() .

If multiple event filters are installed, the filter that was installed last is activated first.

Note

The filter function set here receives native messages, i.e. MSG or XCB event structs.

Note

Native event filters will be disabled in the application when the AA_PluginApplication attribute is set.

For maximum portability, you should always try to use QEvent and installEventFilter() whenever possible.

static PySide2.QtCore.QCoreApplication.installTranslator(messageFile)
Parameters

messageFileQTranslator

Return type

bool

Adds the translation file translationFile to the list of translation files to be used for translations.

Multiple translation files can be installed. Translations are searched for in the reverse order in which they were installed, so the most recently installed translation file is searched first and the first translation file installed is searched last. The search stops as soon as a translation containing a matching string is found.

Installing or removing a QTranslator , or changing an installed QTranslator generates a LanguageChange event for the QCoreApplication instance. A QApplication instance will propagate the event to all toplevel widgets, where a reimplementation of changeEvent can re-translate the user interface by passing user-visible strings via the function to the respective property setters. User-interface classes generated by Qt Designer provide a retranslateUi() function that can be called.

The function returns true on success and false on failure.

See also

removeTranslator() translate() load() Dynamic Translation

static PySide2.QtCore.QCoreApplication.instance()
Return type

QCoreApplication

Returns a pointer to the application’s QCoreApplication (or QGuiApplication / QApplication ) instance.

If no instance has been allocated, null is returned.

static PySide2.QtCore.QCoreApplication.isQuitLockEnabled()
Return type

bool

static PySide2.QtCore.QCoreApplication.isSetuidAllowed()
Return type

bool

Returns true if the application is allowed to run setuid on UNIX platforms.

static PySide2.QtCore.QCoreApplication.libraryPaths()
Return type

list of strings

Returns a list of paths that the application will search when dynamically loading libraries.

The return value of this function may change when a QCoreApplication is created. It is not recommended to call it before creating a QCoreApplication . The directory of the application executable (not the working directory) is part of the list if it is known. In order to make it known a QCoreApplication has to be constructed as it will use argv[0] to find it.

Qt provides default library paths, but they can also be set using a qt.conf file. Paths specified in this file will override default values. Note that if the qt.conf file is in the directory of the application executable, it may not be found until a QCoreApplication is created. If it is not found when calling this function, the default library paths will be used.

The list will include the installation directory for plugins if it exists (the default installation directory for plugins is INSTALL/plugins , where INSTALL is the directory where Qt was installed). The colon separated entries of the QT_PLUGIN_PATH environment variable are always added. The plugin installation directory (and its existence) may change when the directory of the application executable becomes known.

If you want to iterate over the list, you can use the foreach pseudo-keyword:

for path in app.libraryPaths():
    do_something(path)

See also

setLibraryPaths() addLibraryPath() removeLibraryPath() QLibrary How to Create Qt Plugins

PySide2.QtCore.QCoreApplication.notify(arg__1, arg__2)
Parameters
Return type

bool

Sends event to receiver : receiver ->event(event ). Returns the value that is returned from the receiver’s event handler. Note that this function is called for all events sent to any object in any thread.

For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver’s parent and so on up to the top-level object if the receiver is not interested in the event (i.e., it returns false ).

There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five approaches are listed below:

  1. Reimplementing paintEvent() , mousePressEvent() and so on. This is the most common, easiest, and least powerful way.

  2. Reimplementing this function. This is very powerful, providing complete control; but only one subclass can be active at a time.

  3. Installing an event filter on instance() . Such an event filter is able to process all events for all widgets, so it’s just as powerful as reimplementing ; furthermore, it’s possible to have more than one application-global event filter. Global event filters even see mouse events for disabled widgets . Note that application event filters are only called for objects that live in the main thread.

  4. Reimplementing event() (as QWidget does). If you do this you get Tab key presses, and you get to see the events before any widget-specific event filters.

  5. Installing an event filter on the object. Such an event filter gets all the events, including Tab and Shift+Tab key press events, as long as they do not change the focus widget.

Future direction: This function will not be called for objects that live outside the main thread in Qt 6. Applications that need that functionality should find other solutions for their event inspection needs in the meantime. The change may be extended to the main thread, causing this function to be deprecated.

Warning

If you override this function, you must ensure all threads that process events stop doing so before your application object begins destruction. This includes threads started by other libraries that you may be using, but does not apply to Qt’s own threads.

static PySide2.QtCore.QCoreApplication.organizationDomain()
Return type

unicode

PySide2.QtCore.QCoreApplication.organizationDomainChanged()
static PySide2.QtCore.QCoreApplication.organizationName()
Return type

unicode

PySide2.QtCore.QCoreApplication.organizationNameChanged()
static PySide2.QtCore.QCoreApplication.postEvent(receiver, event[, priority=Qt.NormalEventPriority])
Parameters

Adds the event event , with the object receiver as the receiver of the event, to an event queue and returns immediately.

The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. It is not safe to access the event after it has been posted.

When control returns to the main event loop, all events that are stored in the queue will be sent using the notify() function.

Events are sorted in descending priority order, i.e. events with a high priority are queued before events with a lower priority . The priority can be any integer value, i.e. between INT_MAX and INT_MIN, inclusive; see EventPriority for more details. Events with equal priority will be processed in the order posted.

See also

sendEvent() notify() sendPostedEvents() EventPriority

static PySide2.QtCore.QCoreApplication.processEvents([flags=QEventLoop.AllEvents])
Parameters

flagsProcessEventsFlags

Processes all pending events for the calling thread according to the specified flags until there are no more events to process.

You can call this function occasionally when your program is busy performing a long operation (e.g. copying a file).

In the event that you are running a local loop which calls this function continuously, without an event loop, the DeferredDelete events will not be processed. This can affect the behaviour of widgets, e.g. QToolTip , that rely on DeferredDelete events to function properly. An alternative would be to call sendPostedEvents() from within that local loop.

Calling this function processes events only for the calling thread, and returns after all available events have been processed. Available events are events queued before the function call. This means that events that are posted while the function runs will be queued until a later round of event processing.

static PySide2.QtCore.QCoreApplication.processEvents(flags, maxtime)
Parameters
  • flagsProcessEventsFlags

  • maxtimeint

This function overloads processEvents() .

Processes pending events for the calling thread for ms milliseconds or until there are no more events to process, whichever is shorter.

You can call this function occasionally when your program is busy doing a long operation (e.g. copying a file).

Calling this function processes events only for the calling thread.

Note

Unlike the processEvents() overload, this function also processes events that are posted while the function runs.

See also

exec() QTimer processEvents()

static PySide2.QtCore.QCoreApplication.quit()

Tells the application to exit with return code 0 (success). Equivalent to calling exit (0).

It’s common to connect the lastWindowClosed() signal to , and you also often connect e.g. clicked() or signals in QAction , QMenu , or QMenuBar to it.

It’s good practice to always connect signals to this slot using a QueuedConnection . If a signal connected (non-queued) to this slot is emitted before control enters the main event loop (such as before “int main” calls exec() ), the slot has no effect and the application never exits. Using a queued connection ensures that the slot will not be invoked until after control enters the main event loop.

Example:

quitButton = QPushButton("Quit")
quitButton.clicked.connect(app.quit)

See also

exit() aboutToQuit() lastWindowClosed()

static PySide2.QtCore.QCoreApplication.removeLibraryPath(arg__1)
Parameters

arg__1 – unicode

Removes path from the library path list. If path is empty or not in the path list, the list is not changed.

The library paths are reset to the default when an instance of QCoreApplication is destructed.

PySide2.QtCore.QCoreApplication.removeNativeEventFilter(filterObj)
Parameters

filterObjQAbstractNativeEventFilter

Removes an event filterObject from this object. The request is ignored if such an event filter has not been installed.

All event filters for this object are automatically removed when this object is destroyed.

It is always safe to remove an event filter, even during event filter activation (i.e. from the nativeEventFilter() function).

static PySide2.QtCore.QCoreApplication.removePostedEvents(receiver[, eventType=0])
Parameters
  • receiverQObject

  • eventTypeint

Removes all events of the given eventType that were posted using postEvent() for receiver .

The events are not dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause receiver to break one or more invariants.

If receiver is None , the events of eventType are removed for all objects. If eventType is 0, all the events are removed for receiver . You should never call this function with eventType of 0.

static PySide2.QtCore.QCoreApplication.removeTranslator(messageFile)
Parameters

messageFileQTranslator

Return type

bool

Removes the translation file translationFile from the list of translation files used by this application. (It does not delete the translation file from the file system.)

The function returns true on success and false on failure.

static PySide2.QtCore.QCoreApplication.sendEvent(receiver, event)
Parameters
Return type

bool

Sends event event directly to receiver receiver , using the notify() function. Returns the value that was returned from the event handler.

The event is not deleted when the event has been sent. The normal approach is to create the event on the stack, for example:

event = QMouseEvent(QEvent.MouseButtonPress, pos, 0, 0, 0)
QApplication.sendEvent(mainWindow, event)
static PySide2.QtCore.QCoreApplication.sendPostedEvents([receiver=None[, event_type=0]])
Parameters
  • receiverQObject

  • event_typeint

Immediately dispatches all events which have been previously queued with postEvent() and which are for the object receiver and have the event type event_type .

Events from the window system are not dispatched by this function, but by processEvents() .

If receiver is None , the events of event_type are sent for all objects. If event_type is 0, all the events are sent for receiver .

Note

This method must be called from the thread in which its QObject parameter, receiver , lives.

See also

flush() postEvent()

static PySide2.QtCore.QCoreApplication.setApplicationName(application)
Parameters

application – unicode

static PySide2.QtCore.QCoreApplication.setApplicationVersion(version)
Parameters

version – unicode

static PySide2.QtCore.QCoreApplication.setAttribute(attribute[, on=true])
Parameters
  • attributeApplicationAttribute

  • onbool

Sets the attribute attribute if on is true; otherwise clears the attribute.

See also

testAttribute()

static PySide2.QtCore.QCoreApplication.setEventDispatcher(eventDispatcher)
Parameters

eventDispatcherQAbstractEventDispatcher

Sets the event dispatcher for the main thread to eventDispatcher . This is only possible as long as there is no event dispatcher installed yet. That is, before QCoreApplication has been instantiated. This method takes ownership of the object.

static PySide2.QtCore.QCoreApplication.setLibraryPaths(arg__1)
Parameters

arg__1 – list of strings

Sets the list of directories to search when loading libraries to paths . All existing paths will be deleted and the path list will consist of the paths given in paths .

The library paths are reset to the default when an instance of QCoreApplication is destructed.

static PySide2.QtCore.QCoreApplication.setOrganizationDomain(orgDomain)
Parameters

orgDomain – unicode

static PySide2.QtCore.QCoreApplication.setOrganizationName(orgName)
Parameters

orgName – unicode

static PySide2.QtCore.QCoreApplication.setQuitLockEnabled(enabled)
Parameters

enabledbool

static PySide2.QtCore.QCoreApplication.setSetuidAllowed(allow)
Parameters

allowbool

Allows the application to run setuid on UNIX platforms if allow is true.

If allow is false (the default) and Qt detects the application is running with an effective user id different than the real user id, the application will be aborted when a QCoreApplication instance is created.

Qt is not an appropriate solution for setuid programs due to its large attack surface. However some applications may be required to run in this manner for historical reasons. This flag will prevent Qt from aborting the application when this is detected, and must be set before a QCoreApplication instance is created.

Note

It is strongly recommended not to enable this option since it introduces security risks.

static PySide2.QtCore.QCoreApplication.startingUp()
Return type

bool

Returns true if an application object has not been created yet; otherwise returns false .

See also

closingDown()

static PySide2.QtCore.QCoreApplication.testAttribute(attribute)
Parameters

attributeApplicationAttribute

Return type

bool

Returns true if attribute attribute is set; otherwise returns false .

See also

setAttribute()

static PySide2.QtCore.QCoreApplication.translate(context, key[, disambiguation=None[, n=-1]])
Parameters
  • context – str

  • key – str

  • disambiguation – str

  • nint

Return type

unicode

Returns the translation text for sourceText , by querying the installed translation files. The translation files are searched from the most recently installed file back to the first installed file.

tr() provides this functionality more conveniently.

context is typically a class name (e.g., “MyDialog”) and sourceText is either English text or a short identifying text.

disambiguation is an identifying string, for when the same sourceText is used in different roles within the same context. By default, it is None .

See the QTranslator and tr() documentation for more information about contexts, disambiguations and comments.

n is used in conjunction with %n to support plural forms. See tr() for details.

If none of the translation files contain a translation for sourceText in context , this function returns a QString equivalent of sourceText .

This function is not virtual. You can use alternative translation techniques by subclassing QTranslator .

class QCoreApplication(args)

Constructs a Qt kernel application. Kernel applications are applications without a graphical user interface. These type of applications are used at the console or as server processes.

The args argument is processed by the application, and made available in a more convenient form by the arguments() method.