Mercurial > libervia-backend
diff libervia/backend/plugins/plugin_pubsub_cache.py @ 4249:ba46d6a0ff3a
doc: style/typos/URL fixes
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 31 May 2024 11:08:20 +0200 |
parents | 2b000790b197 |
children | 0d7bb4df2343 |
line wrap: on
line diff
--- a/libervia/backend/plugins/plugin_pubsub_cache.py Fri May 31 11:08:18 2024 +0200 +++ b/libervia/backend/plugins/plugin_pubsub_cache.py Fri May 31 11:08:20 2024 +0200 @@ -136,33 +136,33 @@ (keys with a ``*`` are mandatory, at least one of ``node`` or ``namespace`` keys must be used): - :name (str)*: + name (str)* a unique name for this analyser. This name will be stored in database to retrieve the analyser when necessary (notably to get the parsing method), thus it is recommended to use a stable name such as the source plugin name instead of a name which may change with standard evolution, such as the feature namespace. - :type (str)*: + type (str)* indicates what kind of items we are dealing with. Type must be a human readable word, as it may be used in searches. Good types examples are **blog** or **event**. - :node (str): + node (str) prefix of a node name which may be used to identify its type. Example: - *urn:xmpp:microblog:0* (a node starting with this name will be identified as + *urnxmpp:microblog0* (a node starting with this name will be identified as *blog* node). - :namespace (str): + namespace (str) root namespace of items. When analysing a node, the first item will be retrieved. The analyser will be chosen its given namespace match the namespace of the first child element of ``<item>`` element. - :to_sync (bool): + to_sync (bool) if True, the node must be synchronised in cache. The default False value means that the pubsub service will always be requested. - :parser (callable): + parser (callable) method (which may be sync, a coroutine or a method returning a "Deferred") to call to parse the ``domish.Element`` of the item. The result must be dictionary which can be serialised to JSON. @@ -174,7 +174,7 @@ -> dict :noindex: - :match_cb (callable): + match_cb (callable) method (which may be sync, a coroutine or a method returning a "Deferred") called when the analyser matches. The method is called with the curreny analyse which is can modify **in-place**.