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.
This commit is contained in:
Goffi 2023-04-08 13:54:42 +02:00
commit 6a6f15707a

View file

@ -45,21 +45,21 @@ class XEP_0049(object):
log.info(_("Plugin XEP-0049 initialization"))
self.host = host
def privateXMLStore(self, element, profile_key):
def private_xml_store(self, element, profile_key):
"""Store private data
@param element: domish.Element to store (must have a namespace)
@param profile_key: %(doc_profile_key)s
"""
assert isinstance(element, domish.Element)
client = self.host.getClient(profile_key)
client = self.host.get_client(profile_key)
# XXX: feature announcement in disco#info is not mandatory in XEP-0049, so we have to try to use private XML, and react according to the answer
iq_elt = compat.IQ(client.xmlstream)
query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
query_elt.addChild(element)
return iq_elt.send()
def privateXMLGet(self, node_name, namespace, profile_key):
def private_xml_get(self, node_name, namespace, profile_key):
"""Store private data
@param node_name: name of the node to get
@param namespace: namespace of the node to get
@ -67,16 +67,16 @@ class XEP_0049(object):
@return (domish.Element): a deferred which fire the stored data
"""
client = self.host.getClient(profile_key)
# XXX: see privateXMLStore note about feature checking
client = self.host.get_client(profile_key)
# XXX: see private_xml_store note about feature checking
iq_elt = compat.IQ(client.xmlstream, "get")
query_elt = iq_elt.addElement("query", XEP_0049.NS_PRIVATE)
query_elt.addElement(node_name, namespace)
def getCb(answer_iq_elt):
def get_cb(answer_iq_elt):
answer_query_elt = next(answer_iq_elt.elements(XEP_0049.NS_PRIVATE, "query"))
return answer_query_elt.firstChildElement()
d = iq_elt.send()
d.addCallback(getCb)
d.addCallback(get_cb)
return d