Mercurial > libervia-backend
view sat/core/core_types.py @ 4037:524856bd7b19
massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.
However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.
To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.
This is a massive change, and may result in some bugs.
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 08 Apr 2023 13:54:42 +0200 |
parents | 5a42c7842556 |
children | 3900626bc100 |
line wrap: on
line source
#!/usr/bin/env python3 # Libervia types # Copyright (C) 2011 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program 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 Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. from collections import namedtuple from typing import Dict, Callable, Optional from typing_extensions import TypedDict from twisted.words.protocols.jabber import jid as t_jid from twisted.words.protocols.jabber import xmlstream from twisted.words.xish import domish class SatXMPPEntity: jid: t_jid.JID is_component: bool server_jid: t_jid.JID IQ: Callable[[Optional[str], Optional[int]], xmlstream.IQ] EncryptionPlugin = namedtuple("EncryptionPlugin", ("instance", "name", "namespace", "priority", "directed")) class EncryptionSession(TypedDict): plugin: EncryptionPlugin # Incomplete types built through observation rather than code inspection. MessageDataExtra = TypedDict( "MessageDataExtra", { "encrypted": bool, "origin_id": str }, total=False ) MessageData = TypedDict("MessageData", { "from": t_jid.JID, "to": t_jid.JID, "uid": str, "message": Dict[str, str], "subject": Dict[str, str], "type": str, "timestamp": float, "extra": MessageDataExtra, "ENCRYPTION": EncryptionSession, "xml": domish.Element }, total=False)