libervia-backend/twisted/plugins/sat_plugin.py
Goffi 6a6f15707a 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.
2023-04-08 13:54:42 +02:00

76 lines
2.4 KiB
Python

#!/usr/bin/env python3
# Libervia: an XMPP client
# Copyright (C) 2009-2021 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 zope.interface import implementer
from twisted.python import usage
from twisted.plugin import IPlugin
from twisted.application.service import IServiceMaker
# XXX: We need to configure logs before any log method is used, so here is the best place.
from sat.core.constants import Const as C
from sat.core.i18n import _
from sat_tmp.wokkel import install as install_wokkel_patches
install_wokkel_patches()
def initialise(options):
"""Method to initialise global modules"""
# XXX: We need to configure logs before any log method is used, so here is the best place.
from sat.core import log_config
log_config.sat_configure(C.LOG_BACKEND_TWISTED, C, backend_data=options)
class Options(usage.Options):
optParameters = []
@implementer(IPlugin, IServiceMaker)
class SatMaker:
tapname = C.APP_NAME_FILE
description = _("%s XMPP client backend") % C.APP_NAME_FULL
options = Options
def set_debugger(self):
from twisted.internet import defer
if defer.Deferred.debug:
# if we are in debug mode, we want to use ipdb instead of pdb
try:
import ipdb
import pdb
pdb.set_trace = ipdb.set_trace
pdb.post_mortem = ipdb.post_mortem
except ImportError:
pass
def makeService(self, options):
from twisted.internet import asyncioreactor
asyncioreactor.install()
self.set_debugger()
# XXX: Libervia must be imported after log configuration,
# because it write stuff to logs
initialise(options.parent)
from sat.core.sat_main import SAT
return SAT()
serviceMaker = SatMaker()