Mercurial > libervia-backend
annotate doc/_ext/docstring.py @ 3914:4cb38c8312a1
plugin XEP-0384, xml_tools: avoid `getItems` timeout + fix empty node crash + parsing:
- use `max_items` in `getItems` calls for bundles, as otherwise some pubsub service may
return full nodes, which may be huge is `max_items=1` is not set on the node, possibly
resulting in timeouts.
- the plugin was crashing when TWOMEMO devices list node has no items at all. This is not
the case anymore.
- a naive parsing method has been implemented in `xml_tools` to replace the
serialisation/deserialisation method. This should be more efficient and will avoid
annoying `ns0:` prefixes in XML logs.
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 24 Sep 2022 16:37:46 +0200 |
parents | 62e81b1058f8 |
children |
rev | line source |
---|---|
3605
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
1 #!/usr/bin/env python3 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 """Adapt Libervia docstring style to autodoc""" |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 def process_docstring(app, what, name, obj, options, lines): |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 lines[:] = [ |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 l.replace("@param", ":param").replace("@raise", ":raises") |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 for l in lines |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 ] |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 def setup(app): |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 app.connect("autodoc-process-docstring", process_docstring) |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 return { |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 'version': '0.1', |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 'parallel_read_safe': True, |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 'parallel_write_safe': True, |
62e81b1058f8
doc: activate `autodoc` extension + extension to adapt Libervia docstring style to autodoc
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 } |