Mercurial > libervia-backend
view sat/bridge/bridge_constructor/constructors/pb/constructor.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 | 7550ae9cfbac |
children |
line wrap: on
line source
#!/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 sat.bridge.bridge_constructor import base_constructor class pbConstructor(base_constructor.Constructor): NAME = "pb" CORE_TEMPLATE = "pb_core_template.py" CORE_DEST = "pb.py" CORE_FORMATS = { "signals": """\ def {name}(self, {args}): {debug}self.send_signal("{name}", {args_no_def})\n""" } FRONTEND_TEMPLATE = "pb_frontend_template.py" FRONTEND_DEST = CORE_DEST FRONTEND_FORMATS = { "methods": """\ def {name}(self{args_comma}{args}, callback=None, errback=None): {debug}d = self.root.callRemote("{name}"{args_comma}{args_no_def}) if callback is not None: d.addCallback({callback}) if errback is None: d.addErrback(self._generic_errback) else: d.addErrback(self._errback, ori_errback=errback)\n""", "async_methods": """\ def {name}(self{args_comma}{args}): {debug}d = self.root.callRemote("{name}"{args_comma}{args_no_def}) d.addErrback(self._errback) return d.asFuture(asyncio.get_event_loop())\n""", } def core_completion_signal(self, completion, function, default, arg_doc, async_): completion["args_no_def"] = self.get_arguments(function["sig_in"], name=arg_doc) completion["debug"] = ( "" if not self.args.debug else 'log.debug ("%s")\n%s' % (completion["name"], 8 * " ") ) def frontend_completion_method(self, completion, function, default, arg_doc, async_): completion.update( { "args_comma": ", " if function["sig_in"] else "", "args_no_def": self.get_arguments(function["sig_in"], name=arg_doc), "callback": "callback" if function["sig_out"] else "lambda __: callback()", "debug": "" if not self.args.debug else 'log.debug ("%s")\n%s' % (completion["name"], 8 * " "), } )