erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

massive refactoring to switch from camelCase to snake_case:

Browse source 
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.
This commit is contained in:
Goffi 2023-04-08 13:54:42 +02:00
commit 6a6f15707a
1 changed files with 9945 additions and 9945 deletions
Download patch file Download diff file Expand all files Collapse all files

24
sat/plugins/plugin_misc_xmllog.py
View file

@ -54,29 +54,29 @@ class XmlLog(object):
def __init__(self, host):
log.info(_("Plugin XML Log initialization"))
self.host = host
host.memory.updateParams(self.params)
host.bridge.addSignal(
"xmlLog", ".plugin", signature="sss"
host.memory.update_params(self.params)
host.bridge.add_signal(
"xml_log", ".plugin", signature="sss"
) # args: direction("IN" or "OUT"), xml_data, profile
host.trigger.add("stream_hooks", self.addHooks)
host.trigger.add("stream_hooks", self.add_hooks)
def addHooks(self, client, receive_hooks, send_hooks):
self.do_log = self.host.memory.getParamA("Xml log", "Debug")
def add_hooks(self, client, receive_hooks, send_hooks):
self.do_log = self.host.memory.param_get_a("Xml log", "Debug")
if self.do_log:
receive_hooks.append(partial(self.onReceive, client=client))
send_hooks.append(partial(self.onSend, client=client))
receive_hooks.append(partial(self.on_receive, client=client))
send_hooks.append(partial(self.on_send, client=client))
log.info(_("XML log activated"))
return True
def onReceive(self, element, client):
self.host.bridge.xmlLog("IN", element.toXml(), client.profile)
def on_receive(self, element, client):
self.host.bridge.xml_log("IN", element.toXml(), client.profile)
def onSend(self, obj, client):
def on_send(self, obj, client):
if isinstance(obj, str):
xml_log = obj
elif isinstance(obj, domish.Element):
xml_log = obj.toXml()
else:
log.error(_("INTERNAL ERROR: Unmanaged XML type"))
self.host.bridge.xmlLog("OUT", xml_log, client.profile)
self.host.bridge.xml_log("OUT", xml_log, client.profile)