libervia-backend: sat/bridge/bridge_constructor/constructors/pb/pb_core

comparison sat/bridge/bridge_constructor/constructors/pb/pb_core_template.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	3c7a64d6f49f
children

comparison

equal deleted inserted replaced

-:c4464d7ae97b
+:524856bd7b19
 class PBRoot(pb.Root):
 def __init__(self):
 self.signals_handlers = []
-def remote_initBridge(self, signals_handler):
+def remote_init_bridge(self, signals_handler):
 self.signals_handlers.append(HandlerWrapper(signals_handler))
 log.info("registered signal handler")
-def sendSignalEb(self, failure_, signal_name):
+def send_signal_eb(self, failure_, signal_name):
 if not failure_.check(pb.PBConnectionLost):
 log.error(
 f"Error while sending signal {signal_name}: {failure_}",
 )
-def sendSignal(self, name, args, kwargs):
+def send_signal(self, name, args, kwargs):
 to_remove = []
 for wrapper in self.signals_handlers:
 handler = wrapper.handler
 try:
 d = handler.callRemote(name, *args, **kwargs)
 except pb.DeadReferenceError:
 to_remove.append(wrapper)
 else:
-d.addErrback(self.sendSignalEb, name)
+d.addErrback(self.send_signal_eb, name)
 if to_remove:
 for wrapper in to_remove:
 log.debug("Removing signal handler for dead frontend")
 self.signals_handlers.remove(wrapper)
-def _bridgeDeactivateSignals(self):
+def _bridge_deactivate_signals(self):
 if hasattr(self, "signals_paused"):
 log.warning("bridge signals already deactivated")
 if self.signals_handler:
 self.signals_paused.extend(self.signals_handler)
 else:
 self.signals_paused = self.signals_handlers
 self.signals_handlers = []
 log.debug("bridge signals have been deactivated")
-def _bridgeReactivateSignals(self):
+def _bridge_reactivate_signals(self):
 try:
 self.signals_handlers = self.signals_paused
 except AttributeError:
 log.debug("signals were already activated")
 else:
 log.debug("bridge signals have been reactivated")
 ##METHODS_PART##
-class Bridge(object):
+class bridge(object):
 def __init__(self):
 log.info("Init Perspective Broker...")
 self.root = PBRoot()
-conf = config.parseMainConf()
+conf = config.parse_main_conf()
-getConf = partial(config.getConf, conf, "bridge_pb", "")
+get_conf = partial(config.get_conf, conf, "bridge_pb", "")
-conn_type = getConf("connection_type", "unix_socket")
+conn_type = get_conf("connection_type", "unix_socket")
 if conn_type == "unix_socket":
-local_dir = Path(config.getConfig(conf, "", "local_dir")).resolve()
+local_dir = Path(config.config_get(conf, "", "local_dir")).resolve()
 socket_path = local_dir / "bridge_pb"
 log.info(f"using UNIX Socket at {socket_path}")
 reactor.listenUNIX(
 str(socket_path), pb.PBServerFactory(self.root), mode=0o600
 )
 elif conn_type == "socket":
-port = int(getConf("port", 8789))
+port = int(get_conf("port", 8789))
 log.info(f"using TCP Socket at port {port}")
 reactor.listenTCP(port, pb.PBServerFactory(self.root))
 else:
 raise ValueError(f"Unknown pb connection type: {conn_type!r}")
-def sendSignal(self, name, *args, **kwargs):
+def send_signal(self, name, *args, **kwargs):
-self.root.sendSignal(name, args, kwargs)
+self.root.send_signal(name, args, kwargs)
-def remote_initBridge(self, signals_handler):
+def remote_init_bridge(self, signals_handler):
 self.signals_handlers.append(signals_handler)
 log.info("registered signal handler")
 def register_method(self, name, callback):
 log.debug("registering PB bridge method [%s]" % name)
 setattr(self.root, "remote_" + name, callback)
 #  self.root.register_method(name, callback)
-def addMethod(
+def add_method(
 self, name, int_suffix, in_sign, out_sign, method, async_=False, doc={}
 ):
-"""Dynamically add a method to PB Bridge"""
+"""Dynamically add a method to PB bridge"""
 # FIXME: doc parameter is kept only temporary, the time to remove it from calls
 log.debug("Adding method {name} to PB bridge".format(name=name))
 self.register_method(name, method)
-def addSignal(self, name, int_suffix, signature, doc={}):
+def add_signal(self, name, int_suffix, signature, doc={}):
 log.debug("Adding signal {name} to PB bridge".format(name=name))
 setattr(
-self, name, lambda *args, **kwargs: self.sendSignal(name, *args, **kwargs)
+self, name, lambda *args, **kwargs: self.send_signal(name, *args, **kwargs)
 )
-def bridgeDeactivateSignals(self):
+def bridge_deactivate_signals(self):
 """Stop sending signals to bridge
 Mainly used for mobile frontends, when the frontend is paused
 """
-self.root._bridgeDeactivateSignals()
+self.root._bridge_deactivate_signals()
-def bridgeReactivateSignals(self):
+def bridge_reactivate_signals(self):
 """Send again signals to bridge
-Should only be used after bridgeDeactivateSignals has been called
+Should only be used after bridge_deactivate_signals has been called
 """
-self.root._bridgeReactivateSignals()
+self.root._bridge_reactivate_signals()
 ##SIGNALS_PART##

Mercurial > libervia-backend

comparison sat/bridge/bridge_constructor/constructors/pb/pb_core_template.py @ 4037:524856bd7b19