moment/src/backend/models/__init__.py

# SPDX-License-Identifier: LGPL-3.0-or-later

"""Provide classes related to data models shared between Python and QML."""

from typing import Tuple, Union

SyncId = Union[str, Tuple[str, ...]]
Add SPDX ID LGPL v3+ license headers 2019-12-19 22:46:16 +11:00			`# SPDX-License-Identifier: LGPL-3.0-or-later`

Document model items 2019-12-19 06:00:34 +11:00			`"""Provide classes related to data models shared between Python and QML."""`

Begin yet another model refactor Use native ListModel which require a lot of changes, but should be much faster than the old way which exponentially slowed down to a crawl. Also fix some popup bugs (leave/forget). Not working yet: side pane keyboard controls, proper highlight, room & member filtering, local echo replacement 2019-12-03 07:29:29 +11:00			`from typing import Tuple, Union`
Big performance refactoring & various improvements Instead of passing all sorts of events for the JS to handle and manually add to different data models, we now handle everything we can in Python. For any change, the python models send a sync event with their contents (no more than 4 times per second) to JS, and the QSyncable library's JsonListModel takes care of converting it to a QML ListModel and sending the appropriate signals. The SortFilterProxyModel library is not used anymore, the only case where we need to filter/sort something now is when the user interacts with the "Filter rooms" or "Filter members" fields. These cases are handled by a simple JS function. We now keep separated room and timeline models for different accounts, the previous approach of sharing all the data we could between accounts created a lot of complications (local echoes, decrypted messages replacing others, etc). The users's own account profile changes are now hidden in the timeline. On startup, if all events for a room were only own profile changes, more events will be loaded. Any kind of image format supported by Qt is now handled by the pyotherside image provider, instead of just PNG/JPG. SVGs which previously caused errors are supported as well. The typing members bar paddings/margins are fixed. The behavior of the avatar/"upload a profile picture" overlay is fixed. Config files read from disk are now cached (TODO: make them reloadable again). Pylint is not used anymore because of all its annoying false warnings and lack of understanding for dataclasses, it is replaced by flake8 with a custom config and various plugins. Debug mode is now considered on if the program was compiled with the right option, instead of taking an argument from CLI. When on, C++ will set a flag in the Window QML component. The loading screen is now unloaded after the UI is ready, where previously it just stayed in the background invisible and wasted CPU. The overall refactoring and improvements make us now able to handle rooms with thousand of members and no lazy-loading, where previously everything would freeze and simply scrolling up to load past events in any room would block the UI for a few seconds. 2019-08-11 22:01:22 +10:00
Fix SyncId type hint & remove debug prints 2020-05-11 05:07:21 +10:00			`SyncId = Union[str, Tuple[str, ...]]`