pep/slixmpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: fix rest issues

Browse source
This commit is contained in:
mathieui 2020-12-10 19:17:11 +01:00
parent 9d61655215
commit 010bf6dd70
9 changed files with 173 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/api/stanza/iq.rst
View file

@ -2,6 +2,7 @@ IQ Stanza
=========
.. module:: slixmpp.stanza
:noindex:
.. autoclass:: Iq
:members:

1
docs/api/stanza/message.rst
View file

@ -2,6 +2,7 @@ Message Stanza
==============
.. module:: slixmpp.stanza
:noindex:
.. autoclass:: Message
:members:

1
docs/api/xmlstream/tostring.rst
View file

@ -1,4 +1,5 @@
.. module:: slixmpp.xmlstream.tostring
:noindex:
.. _tostring:

8
docs/event_index.rst
View file

@ -309,10 +309,6 @@ Event Index
- **Data:** :py:class:`~slixmpp.Message`
- **Source:** :py:class:`~slixmpp.plugins.xep_0333.XEP_0333`
message_correction
- **Data:** :py:class:`~slixmpp.Message`
- **Source:** :py:class:`~slixmpp.plugins.xep_0308.XEP_0308`
attention
- **Data:** :py:class:`~slixmpp.Message`
- **Source:** :py:class:`~slixmpp.plugins.xep_0224.XEP_0224`
@ -408,7 +404,3 @@ Event Index
pubsub_subscription
- **Data:** :py:class:`~slixmpp.Message`
- **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060`
pubsub_retract
- **Data:** :py:class:`~slixmpp.Message`
- **Source:** :py:class:`~slixmpp.plugins.xep_0060.XEP_0060`

8
docs/glossary.rst
View file

@ -32,3 +32,11 @@ Glossary
substanza
See :term:`stanza plugin`
interfaces
A set of keys defined on a :term:`stanza plugin`.
stanza
An XML payload sent over the XML stream, which is the root of XMPP.
A stanza is either ``<iq/>``, ``<message/>`` or ``<presence/>``. Other
elements are called nonzas.

144
docs/howto/make_plugin_extension_for_message_and_iq.pl.rst
View file

@ -76,49 +76,49 @@ Plik zawiera prostą strukturę, która pozwoli nam zapisać dane logowania.
.. code-block:: python
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
import subprocess
import time
import subprocess
import time
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Osobny terminal dla kazdego klienta, może być zastąpiony inną konsolą.
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
example_file = "./test_example_tag.xml"
example_file = "./test_example_tag.xml"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
Skrypt uruchamiający powinien być dostosowany do potrzeb urzytkownika: można w nim pobierać ścieżki do projektu z linii komend (przez `'sys.argv[...]'` lub `'os.getcwd()'`), wybierać z jaką flagą mają zostać uruchomione programy oraz wiele innych. Jego należyte przygotowanie pozwoli zaoszczędzić czas i nerwy podczas późniejszych prac.
@ -1263,49 +1263,49 @@ W poniższym kodzie zostały pozostawione oryginalne komentarze w języku angiel
.. code-block:: python
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
import subprocess
import time
import subprocess
import time
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
example_file = "./test_example_tag.xml"
example_file = "./test_example_tag.xml"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
.. code-block:: python

144
docs/howto/make_plugin_extension_for_message_and_iq.rst
View file

@ -76,49 +76,49 @@ This file contains a simple structure for logging credentials:
.. code-block:: python
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
import subprocess
import time
import subprocess
import time
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
example_file = "./test_example_tag.xml"
example_file = "./test_example_tag.xml"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
The launch script should be convenient in use and easy to reconfigure again. The proper preparation of it now, can help saving time in the future. Logging credentials, the project paths (from `'sys.argv[...]'` or `'os.getcwd()'`), set the parameters for the debugging purposes, mock the testing xml file and many more things can be defined inside. Whichever parameters are used, the script testing itself should be fast and effortless. The proper preparation of it now, can help saving time in the future.
@ -1260,49 +1260,49 @@ Complete code from tutorial
.. code-block:: python
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
#!/usr/bin/python3
#File: /usr/bin/test_slixmpp & permissions rwx--x--x (711)
import subprocess
import time
import subprocess
import time
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
if __name__ == "__main__":
#~ prefix = ["x-terminal-emulator", "-e"] # Separate terminal for every client; can be replaced with other terminal
#~ prefix = ["xterm", "-e"]
prefix = []
#~ suffix = ["-d"] # Debug
#~ suffix = ["-q"] # Quiet
suffix = []
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
sender_path = "./example/sender.py"
sender_jid = "SENDER_JID"
sender_password = "SENDER_PASSWORD"
example_file = "./test_example_tag.xml"
example_file = "./test_example_tag.xml"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
responder_path = "./example/responder.py"
responder_jid = "RESPONDER_JID"
responder_password = "RESPONDER_PASSWORD"
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
# Remember about the executable permission. (`chmod +x ./file.py`)
SENDER_TEST = prefix + [sender_path, "-j", sender_jid, "-p", sender_password, "-t", responder_jid, "--path", example_file] + suffix
RESPON_TEST = prefix + [responder_path, "-j", responder_jid, "-p", responder_password] + suffix
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
try:
responder = subprocess.Popen(RESPON_TEST)
sender = subprocess.Popen(SENDER_TEST)
responder.wait()
sender.wait()
except:
try:
responder.terminate()
except NameError:
pass
try:
sender.terminate()
except NameError:
pass
raise
.. code-block:: python

3
docs/license.rst
View file

@ -2,4 +2,5 @@
License (MIT)
=============
.. include:: ../LICENSE
.. literalinclude:: ../LICENSE

24
docs/xmpp_tdg.rst
View file

@ -38,8 +38,8 @@ Updated Code
def handleIncomingMessage(self, message):
self.xmpp.send_message(message["from"], message["body"])
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_
`View full source (1) <http://github.com/legastero/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_ |
`View original code (1) <http://github.com/remko/xmpp-tdg/blob/master/code/EchoBot/EchoBot.py>`_
Example 14-1. (Page 215)
------------------------
@ -88,8 +88,8 @@ Updated Code
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
self.xmpp.send_message(subscriberJID, body, mhtml=htmlBody)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_
`View full source (2) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_ |
`View original code (2) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Bot.py>`_
Example 14-3. (Page 217)
@ -131,8 +131,8 @@ Updated Code
if self.backend.getShouldMonitorPresenceFromUser(user):
self.handleIncomingXMPPEvent(event)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_
`View full source (3) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_ |
`View original code (3) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/ConfigurableBot.py>`_
Example 14-4. (Page 220)
@ -176,8 +176,8 @@ Updated Code
for subscriberJID in self.backend.getSubscriberJIDs(message.user) :
self.xmpp.send_message(subscriberJID, body, mfrom=self.xmpp.jid)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_
`View full source (4) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_ |
`View original code (4) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/SimpleComponent.py>`_
Example 14-6. (Page 223)
@ -195,8 +195,8 @@ implementation should work correctly.
To see how to implement in-band registration as a Slixmpp plugin,
see the tutorial :ref:`tutorial-create-plugin`.
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_
`View full source (5) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_ |
`View original code (5) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/RegistrableComponent.py>`_
Example 14-7. (Page 225)
------------------------
@ -245,5 +245,5 @@ Updated Code
if contactJID == self.componentDomain :
self.sendAllContactSubscriptionRequestsToUser(userJID)
`View full source <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ |
`View original code <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_
`View full source (6) <http://github.com/legastero/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_ |
`View original code (6) <http://github.com/remko/xmpp-tdg/blob/master/code/CheshiR/Component.py>`_