comparison sat/plugins/plugin_xep_0215.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
comparison
equal deleted inserted replaced
4036:c4464d7ae97b 4037:524856bd7b19
56 56
57 class XEP_0215: 57 class XEP_0215:
58 def __init__(self, host): 58 def __init__(self, host):
59 log.info(_("External Service Discovery plugin initialization")) 59 log.info(_("External Service Discovery plugin initialization"))
60 self.host = host 60 self.host = host
61 host.bridge.addMethod( 61 host.bridge.add_method(
62 "external_disco_get", 62 "external_disco_get",
63 ".plugin", 63 ".plugin",
64 in_sign="ss", 64 in_sign="ss",
65 out_sign="s", 65 out_sign="s",
66 method=self._external_disco_get, 66 method=self._external_disco_get,
67 async_=True, 67 async_=True,
68 ) 68 )
69 host.bridge.addMethod( 69 host.bridge.add_method(
70 "external_disco_credentials_get", 70 "external_disco_credentials_get",
71 ".plugin", 71 ".plugin",
72 in_sign="ssis", 72 in_sign="ssis",
73 out_sign="s", 73 out_sign="s",
74 method=self._external_disco_credentials_get, 74 method=self._external_disco_credentials_get,
75 async_=True, 75 async_=True,
76 ) 76 )
77 77
78 def getHandler(self, client): 78 def get_handler(self, client):
79 return XEP_0215_handler(self) 79 return XEP_0215_handler(self)
80 80
81 async def profileConnecting(self, client: SatXMPPEntity) -> None: 81 async def profile_connecting(self, client: SatXMPPEntity) -> None:
82 client._xep_0215_services = {} 82 client._xep_0215_services = {}
83 83
84 def parse_services( 84 def parse_services(
85 self, element: domish.Element, parent_elt_name: str = "services" 85 self, element: domish.Element, parent_elt_name: str = "services"
86 ) -> List[dict]: 86 ) -> List[dict]:
145 ) 145 )
146 continue 146 continue
147 for x_elt in service_elt.elements(data_form.NS_X_DATA, "x"): 147 for x_elt in service_elt.elements(data_form.NS_X_DATA, "x"):
148 form = data_form.Form.fromElement(x_elt) 148 form = data_form.Form.fromElement(x_elt)
149 extended = service.setdefault("extended", []) 149 extended = service.setdefault("extended", [])
150 extended.append(xml_tools.dataForm2dataDict(form)) 150 extended.append(xml_tools.data_form_2_data_dict(form))
151 services.append(service) 151 services.append(service)
152 152
153 return services 153 return services
154 154
155 def _external_disco_get(self, entity: str, profile_key: str) -> defer.Deferred: 155 def _external_disco_get(self, entity: str, profile_key: str) -> defer.Deferred:
156 client = self.host.getClient(profile_key) 156 client = self.host.get_client(profile_key)
157 d = defer.ensureDeferred( 157 d = defer.ensureDeferred(
158 self.get_external_services(client, jid.JID(entity) if entity else None) 158 self.get_external_services(client, jid.JID(entity) if entity else None)
159 ) 159 )
160 d.addCallback(data_format.serialise) 160 d.addCallback(data_format.serialise)
161 return d 161 return d
202 host: str, 202 host: str,
203 type_: str, 203 type_: str,
204 port: int = 0, 204 port: int = 0,
205 profile_key=C.PROF_KEY_NONE, 205 profile_key=C.PROF_KEY_NONE,
206 ) -> defer.Deferred: 206 ) -> defer.Deferred:
207 client = self.host.getClient(profile_key) 207 client = self.host.get_client(profile_key)
208 d = defer.ensureDeferred( 208 d = defer.ensureDeferred(
209 self.request_credentials( 209 self.request_credentials(
210 client, host, type_, port or None, jid.JID(entity) if entity else None 210 client, host, type_, port or None, jid.JID(entity) if entity else None
211 ) 211 )
212 ) 212 )