Mercurial > libervia-backend

comparison doc/developer.rst @ 4037:524856bd7b19

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 432aaba0d7fe
children d6837db456fd
comparison
equal deleted inserted replaced
4036:c4464d7ae97b 4037:524856bd7b19
58 58
59 To save resources, not all nodes are fully cached. When a node is checked, a series of 59 To save resources, not all nodes are fully cached. When a node is checked, a series of
60 analysers are checked, and the first one matching is used to determine if the node must be 60 analysers are checked, and the first one matching is used to determine if the node must be
61 synchronised or not. 61 synchronised or not.
62 62
63 Analysers can be registered by any plugins using ``registerAnalyser`` method: 63 Analysers can be registered by any plugins using ``register_analyser`` method:
64 64
65 .. automethod:: sat.plugins.plugin_pubsub_cache.PubsubCache.registerAnalyser 65 .. automethod:: sat.plugins.plugin_pubsub_cache.PubsubCache.register_analyser
66 66
67 If no analyser is found, ``to_sync`` is false, or an error happens during the caching, 67 If no analyser is found, ``to_sync`` is false, or an error happens during the caching,
68 the node won't be synchronised and the pubsub service will always be requested. 68 the node won't be synchronised and the pubsub service will always be requested.
69 69
70 Specifying an optional **parser** will store parsed data in addition to the raw XML of the 70 Specifying an optional **parser** will store parsed data in addition to the raw XML of the