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

@ -57,28 +57,28 @@ class UploadPlugin(object):
def __init__(self, host):
log.info(_("plugin Upload initialization"))
self.host = host
host.bridge.addMethod(
"fileUpload",
host.bridge.add_method(
"file_upload",
".plugin",
in_sign="sssss",
out_sign="a{ss}",
method=self._fileUpload,
method=self._file_upload,
async_=True,
)
self._upload_callbacks = []
def _fileUpload(
def _file_upload(
self, filepath, filename, upload_jid_s="", options='', profile=C.PROF_KEY_NONE
):
client = self.host.getClient(profile)
client = self.host.get_client(profile)
upload_jid = jid.JID(upload_jid_s) if upload_jid_s else None
options = data_format.deserialise(options)
return defer.ensureDeferred(self.fileUpload(
return defer.ensureDeferred(self.file_upload(
client, filepath, filename or None, upload_jid, options
))
async def fileUpload(self, client, filepath, filename, upload_jid, options):
async def file_upload(self, client, filepath, filename, upload_jid, options):
"""Send a file using best available method
parameters are the same as for [upload]
@ -159,7 +159,7 @@ class UploadPlugin(object):
components)
exceptions.NotFound must be raised if no entity has been found
@param upload_cb(callable): method to upload a file
must have the same signature as [fileUpload]
must have the same signature as [file_upload]
must return a tuple with progress_id and a Deferred which fire download URL
when upload is finished
@param priority(int): pririoty of this method, the higher available will be used