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

typing: add to tostring

Browse source
This commit is contained in:
mathieui 2021-04-21 23:22:38 +02:00
parent fed55d3dda
commit 00d38c1b29
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
slixmpp/xmlstream/tostring.py
View file

@ -1,4 +1,3 @@
# slixmpp.xmlstream.tostring # slixmpp.xmlstream.tostring
# ~~~~~~~~~~~~~~~~~~~~~~~~~~ # ~~~~~~~~~~~~~~~~~~~~~~~~~~
# This module converts XML objects into Unicode strings and # This module converts XML objects into Unicode strings and
@ -7,11 +6,20 @@
# Part of Slixmpp: The Slick XMPP Library # Part of Slixmpp: The Slick XMPP Library
# :copyright: (c) 2011 Nathanael C. Fritz # :copyright: (c) 2011 Nathanael C. Fritz
# :license: MIT, see LICENSE for more details # :license: MIT, see LICENSE for more details
from __future__ import annotations
from typing import Optional, Set, TYPE_CHECKING
from xml.etree.ElementTree import Element
if TYPE_CHECKING:
from slixmpp.xmlstream import XMLStream
XML_NS = 'http://www.w3.org/XML/1998/namespace' XML_NS = 'http://www.w3.org/XML/1998/namespace'
def tostring(xml=None, xmlns='', stream=None, outbuffer='', def tostring(xml: Optional[Element] = None, xmlns: str = '',
top_level=False, open_only=False, namespaces=None): stream: Optional[XMLStream] = None, outbuffer: str = '',
top_level: bool = False, open_only: bool = False,
namespaces: Optional[Set[str]] = None) -> str:
"""Serialize an XML object to a Unicode string. """Serialize an XML object to a Unicode string.
If an outer xmlns is provided using ``xmlns``, then the current element's If an outer xmlns is provided using ``xmlns``, then the current element's
@ -35,6 +43,8 @@ def tostring(xml=None, xmlns='', stream=None, outbuffer='',
:rtype: Unicode string :rtype: Unicode string
""" """
if xml is None:
return ''
# Add previous results to the start of the output. # Add previous results to the start of the output.
output = [outbuffer] output = [outbuffer]
@ -123,11 +133,12 @@ def tostring(xml=None, xmlns='', stream=None, outbuffer='',
# Remove namespaces introduced in this context. This is necessary # Remove namespaces introduced in this context. This is necessary
# because the namespaces object continues to be shared with other # because the namespaces object continues to be shared with other
# contexts. # contexts.
namespaces.remove(ns) if namespaces is not None:
namespaces.remove(ns)
return ''.join(output) return ''.join(output)
def escape(text, use_cdata=False): def escape(text: str, use_cdata: bool = False) -> str:
"""Convert special characters in XML to escape sequences. """Convert special characters in XML to escape sequences.
:param string text: The XML text to convert. :param string text: The XML text to convert.