MINI MINI MANI MO
ó
i:Oc @ sí d Z y d d l m Z m Z Wn' e k
rI d d l m Z m Z n Xd d l Z d d l Z d d l Z d d l
Z d d l m
Z
e
j ƒ d d l m Z m Z d d l m Z m Z m Z e dF ƒ Z e dG ƒ Z d d d d d! „ Z d d d d d" „ Z d# „ Z d d$ d% „ Z d& „ Z d' „ d( „ f Z d) „ e f Z e d* „ Z! e d+ „ Z" d e# d d, „ Z$ d d d- „ Z% d d d e# d d. „ Z& d d d d/ „ Z' d0 „ Z( d1 „ Z) d e# d d2 „ Z* d e# d3 d4 „ Z+ dH Z, d S(I s!
Functions to handle conversion of byte :class:`str` and :class:`unicode`
strings.
.. versionchanged:: kitchen 0.2a2 ; API kitchen.text 2.0.0
Added :func:`~kitchen.text.converters.getwriter`
.. versionchanged:: kitchen 0.2.2 ; API kitchen.text 2.1.0
Added :func:`~kitchen.text.converters.exception_to_unicode`,
:func:`~kitchen.text.converters.exception_to_bytes`,
:data:`~kitchen.text.converters.EXCEPTION_CONVERTERS`,
and :data:`~kitchen.text.converters.BYTE_EXCEPTION_CONVERTERS`
.. versionchanged:: kitchen 1.0.1 ; API kitchen.text 2.1.1
Deprecated :data:`~kitchen.text.converters.BYTE_EXCEPTION_CONVERTERS` as
we've simplified :func:`~kitchen.text.converters.exception_to_unicode` and
:func:`~kitchen.text.converters.exception_to_bytes` to make it unnecessary
iÿÿÿÿ( t b64encodet b64decodeN( t sets( t ControlCharErrort XmlEncodeError( t guess_encodingt html_entities_unescapet process_control_charss utf-8s UTF-8t utf8t UTF8t utf_8t UTF_8t utft UTFt u8t U8s latin-1s LATIN-1t latin1t LATIN1t latint LATINt l1t L1t cp819t CP819t 8859s iso8859-1s ISO8859-1s
iso-8859-1s
ISO-8859-1t replacec C s+ t | t ƒ rj t | t ƒ r" | S| t k r> t | d | ƒ S| t k rZ t | d | ƒ S| j | | ƒ S| r¡ t j t j d ƒ t
d d ƒ| s¡ | } q¡ n | s° d } n | d k rÀ d S| d k rÐ | S| d k rŒy | j ƒ } Wn t t
f k
r d } n X| siy t | ƒ } Wqit
k
rey | j ƒ } Wqft
t f k
rad } qfXqiXn t | t ƒ sˆt | | | ƒ S| S| d k rt | ƒ } t | t ƒ sÈt | | | ƒ } n | d
k rØ| St t j d ƒ i | j | d
ƒ d 6ƒ ‚ n t t j d ƒ i | d 6ƒ ‚ d S( s} Convert an object into a :class:`unicode` string
:arg obj: Object to convert to a :class:`unicode` string. This should
normally be a byte :class:`str`
:kwarg encoding: What encoding to try converting the byte :class:`str` as.
Defaults to :term:`utf-8`
:kwarg errors: If errors are found while decoding, perform this action.
Defaults to ``replace`` which replaces the invalid bytes with
a character that means the bytes were unable to be decoded. Other
values are the same as the error handling schemes in the `codec base
classes
<http://docs.python.org/library/codecs.html#codec-base-classes>`_.
For instance ``strict`` which raises an exception and ``ignore`` which
simply omits the non-decodable characters.
:kwarg nonstring: How to treat nonstring values. Possible values are:
:simplerepr: Attempt to call the object's "simple representation"
method and return that value. Python-2.3+ has two methods that
try to return a simple representation: :meth:`object.__unicode__`
and :meth:`object.__str__`. We first try to get a usable value
from :meth:`object.__unicode__`. If that fails we try the same
with :meth:`object.__str__`.
:empty: Return an empty :class:`unicode` string
:strict: Raise a :exc:`TypeError`
:passthru: Return the object unchanged
:repr: Attempt to return a :class:`unicode` string of the repr of the
object
Default is ``simplerepr``
:kwarg non_string: *Deprecated* Use :attr:`nonstring` instead
:raises TypeError: if :attr:`nonstring` is ``strict`` and
a non-:class:`basestring` object is passed in or if :attr:`nonstring`
is set to an unknown value
:raises UnicodeDecodeError: if :attr:`errors` is ``strict`` and
:attr:`obj` is not decodable using the given encoding
:returns: :class:`unicode` string or the original object depending on the
value of :attr:`nonstring`.
Usually this should be used on a byte :class:`str` but it can take both
byte :class:`str` and :class:`unicode` strings intelligently. Nonstring
objects are handled in different ways depending on the setting of the
:attr:`nonstring` parameter.
The default values of this function are set so as to always return
a :class:`unicode` string and never raise an error when converting from
a byte :class:`str` to a :class:`unicode` string. However, when you do
not pass validly encoded text (or a nonstring object), you may end up with
output that you don't expect. Be sure you understand the requirements of
your data, not just ignore errors by passing it through this function.
.. versionchanged:: 0.2.1a2
Deprecated :attr:`non_string` in favor of :attr:`nonstring` parameter and changed
default value to ``simplerepr``
s utf-8s latin-1sL non_string is a deprecated parameter of to_unicode(). Use nonstring insteadt
stackleveli t
simplereprt emptyu t passthrut reprt strictsW to_unicode was given "%(obj)s" which is neither a byte string (str) or a unicode stringR t objs8 nonstring value, %(param)s, is not set to a valid actiont paramN( s reprs strict( t
isinstancet
basestringt unicodet
_UTF8_ALIASESt _LATIN1_ALIASESt decodet warningst warnt kt b_t DeprecationWarningt __unicode__t AttributeErrort UnicodeErrort Nonet strt __str__R t TypeErrort encode( R t encodingt errorst nonstringt
non_stringt simplet obj_repr( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt
to_unicodeI s\ 9
c C s t | t ƒ r2 t | t ƒ r" | S| j | | ƒ S| ri t j t j d ƒ t d d ƒ| si | } qi n | sx d } n | d k rˆ d S| d k r˜ | S| d k rYy t | ƒ } WnA t k
r÷ y | j
ƒ } Wqø t t f k
ró d } qø Xn X| s1y | j
ƒ } Wq1t t f k
r-d } q1Xn t | t ƒ rU| j | d ƒ } n | S| d k røy | j ƒ } Wn t t f k
r”d } n Xt | t ƒ r¹| j | | ƒ } n t | ƒ } | d k rÕ| St t j d ƒ i | d 6ƒ ‚ n t t j d
ƒ i | d 6ƒ ‚ d S( s˜
Convert an object into a byte :class:`str`
:arg obj: Object to convert to a byte :class:`str`. This should normally
be a :class:`unicode` string.
:kwarg encoding: Encoding to use to convert the :class:`unicode` string
into a byte :class:`str`. Defaults to :term:`utf-8`.
:kwarg errors: If errors are found while encoding, perform this action.
Defaults to ``replace`` which replaces the invalid bytes with
a character that means the bytes were unable to be encoded. Other
values are the same as the error handling schemes in the `codec base
classes
<http://docs.python.org/library/codecs.html#codec-base-classes>`_.
For instance ``strict`` which raises an exception and ``ignore`` which
simply omits the non-encodable characters.
:kwarg nonstring: How to treat nonstring values. Possible values are:
:simplerepr: Attempt to call the object's "simple representation"
method and return that value. Python-2.3+ has two methods that
try to return a simple representation: :meth:`object.__unicode__`
and :meth:`object.__str__`. We first try to get a usable value
from :meth:`object.__str__`. If that fails we try the same
with :meth:`object.__unicode__`.
:empty: Return an empty byte :class:`str`
:strict: Raise a :exc:`TypeError`
:passthru: Return the object unchanged
:repr: Attempt to return a byte :class:`str` of the :func:`repr` of the
object
Default is ``simplerepr``.
:kwarg non_string: *Deprecated* Use :attr:`nonstring` instead.
:raises TypeError: if :attr:`nonstring` is ``strict`` and
a non-:class:`basestring` object is passed in or if :attr:`nonstring`
is set to an unknown value.
:raises UnicodeEncodeError: if :attr:`errors` is ``strict`` and all of the
bytes of :attr:`obj` are unable to be encoded using :attr:`encoding`.
:returns: byte :class:`str` or the original object depending on the value
of :attr:`nonstring`.
.. warning::
If you pass a byte :class:`str` into this function the byte
:class:`str` is returned unmodified. It is **not** re-encoded with
the specified :attr:`encoding`. The easiest way to achieve that is::
to_bytes(to_unicode(text), encoding='utf-8')
The initial :func:`to_unicode` call will ensure text is
a :class:`unicode` string. Then, :func:`to_bytes` will turn that into
a byte :class:`str` with the specified encoding.
Usually, this should be used on a :class:`unicode` string but it can take
either a byte :class:`str` or a :class:`unicode` string intelligently.
Nonstring objects are handled in different ways depending on the setting
of the :attr:`nonstring` parameter.
The default values of this function are set so as to always return a byte
:class:`str` and never raise an error when converting from unicode to
bytes. However, when you do not pass an encoding that can validly encode
the object (or a non-string object), you may end up with output that you
don't expect. Be sure you understand the requirements of your data, not
just ignore errors by passing it through this function.
.. versionchanged:: 0.2.1a2
Deprecated :attr:`non_string` in favor of :attr:`nonstring` parameter
and changed default value to ``simplerepr``
sJ non_string is a deprecated parameter of to_bytes(). Use nonstring insteadR i R R t R R R R sU to_bytes was given "%(obj)s" which is neither a unicode string or a byte string (str)R s8 nonstring value, %(param)s, is not set to a valid actionR! N( s reprs strict( R" R# R1 R4 R( R) R* R+ R, R/ R2 R. R0 R- R$ t __repr__R3 ( R R5 R6 R7 R8 R9 R: ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt to_bytesµ s\ E
c C s& d t j f d „ ƒ Y} | | _ | S( s• Return a :class:`codecs.StreamWriter` that resists tracing back.
:arg encoding: Encoding to use for transforming :class:`unicode` strings
into byte :class:`str`.
:rtype: :class:`codecs.StreamWriter`
:returns: :class:`~codecs.StreamWriter` that you can instantiate to wrap output
streams to automatically translate :class:`unicode` strings into :attr:`encoding`.
This is a reimplemetation of :func:`codecs.getwriter` that returns
a :class:`~codecs.StreamWriter` that resists issuing tracebacks. The
:class:`~codecs.StreamWriter` that is returned uses
:func:`kitchen.text.converters.to_bytes` to convert :class:`unicode`
strings into byte :class:`str`. The departures from
:func:`codecs.getwriter` are:
1) The :class:`~codecs.StreamWriter` that is returned will take byte
:class:`str` as well as :class:`unicode` strings. Any byte
:class:`str` will be passed through unmodified.
2) The default error handler for unknown bytes is to ``replace`` the bytes
with the unknown character (``?`` in most ascii-based encodings, ``�``
in the utf encodings) whereas :func:`codecs.getwriter` defaults to
``strict``. Like :class:`codecs.StreamWriter`, the returned
:class:`~codecs.StreamWriter` can have its error handler changed in
code by setting ``stream.errors = 'new_handler_name'``
Example usage::
$ LC_ALL=C python
>>> import sys
>>> from kitchen.text.converters import getwriter
>>> UTF8Writer = getwriter('utf-8')
>>> unwrapped_stdout = sys.stdout
>>> sys.stdout = UTF8Writer(unwrapped_stdout)
>>> print 'caf\xc3\xa9'
café
>>> print u'caf\xe9'
café
>>> ASCIIWriter = getwriter('ascii')
>>> sys.stdout = ASCIIWriter(unwrapped_stdout)
>>> print 'caf\xc3\xa9'
café
>>> print u'caf\xe9'
caf?
.. seealso::
API docs for :class:`codecs.StreamWriter` and :func:`codecs.getwriter`
and `Print Fails <http://wiki.python.org/moin/PrintFails>`_ on the
python wiki.
.. versionadded:: kitchen 0.2a2, API: kitchen.text 1.1.0
t
_StreamWriterc B s e Z d d „ Z d d „ Z RS( R c S s t j j | | | ƒ d S( N( t codecst StreamWritert __init__( t selft streamR6 ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyRB h s c S s% t | d | j d | ƒt | ƒ f S( NR5 R6 ( R> R5 t len( RC t msgR6 ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyR4 k s ( t __name__t
__module__RB R4 ( ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyR? a s ( R@ RA R5 ( R5 R? ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt getwriter, s 5 R c C s; t j t j d ƒ t d d ƒt | d d d | d | ƒS( sÑ *Deprecated*
Convert :class:`unicode` to an encoded :term:`utf-8` byte :class:`str`.
You should be using :func:`to_bytes` instead::
to_bytes(obj, encoding='utf-8', non_string='passthru')
s‰ kitchen.text.converters.to_utf8 is deprecated. Use kitchen.text.converters.to_bytes(obj, encoding="utf-8", nonstring="passthru" instead.R i R5 s utf-8R6 R7 ( R( R) R* R+ R, R> ( R R6 R8 ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt to_utf8r s
c C s/ t j t j d ƒ t d d ƒt | d d ƒS( s *Deprecated*
This function converts something to a byte :class:`str` if it isn't one.
It's used to call :func:`str` or :func:`unicode` on the object to get its
simple representation without danger of getting a :exc:`UnicodeError`.
You should be using :func:`to_unicode` or :func:`to_bytes` explicitly
instead.
If you need :class:`unicode` strings::
to_unicode(obj, nonstring='simplerepr')
If you need byte :class:`str`::
to_bytes(obj, nonstring='simplerepr')
sm to_str is deprecated. Use to_unicode or to_bytes instead. See the to_str docstring for porting information.R i R7 R ( R( R) R* R+ R, R> ( R ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt to_str‚ s
c C s | j d S( Ni ( t args( t e( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt <lambda>š s c C s | S( N( ( RM ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyRN š s c C s t | j d ƒ S( Ni ( R> RL ( RM ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyRN Ò s c C s< d } x) | D]! } y | | ƒ } Wn q
XPq
Wt | ƒ S( s¡ Convert an exception object into a unicode representation
:arg exc: Exception object to convert
:kwarg converters: List of functions to use to convert the exception into
a string. See :data:`EXCEPTION_CONVERTERS` for the default value and
an example of adding other converters to the defaults. The functions
in the list are tried one at a time to see if they can extract
a string from the exception. The first one to do so without raising
an exception is used.
:returns: :class:`unicode` string representation of the exception. The
value extracted by the :attr:`converters` will be converted into
:class:`unicode` before being returned using the :term:`utf-8`
encoding. If you know you need to use an alternate encoding add
a function that does that to the list of functions in
:attr:`converters`)
.. versionadded:: 0.2.2
u% <exception failed to convert to text>( R; ( t exct
convertersRF t func( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt exception_to_unicodeâ s
c C s< d } x) | D]! } y | | ƒ } Wn q
XPq
Wt | ƒ S( s; Convert an exception object into a str representation
:arg exc: Exception object to convert
:kwarg converters: List of functions to use to convert the exception into
a string. See :data:`EXCEPTION_CONVERTERS` for the default value and
an example of adding other converters to the defaults. The functions
in the list are tried one at a time to see if they can extract
a string from the exception. The first one to do so without raising
an exception is used.
:returns: byte :class:`str` representation of the exception. The value
extracted by the :attr:`converters` will be converted into
:class:`str` before being returned using the :term:`utf-8` encoding.
If you know you need to use an alternate encoding add a function that
does that to the list of functions in :attr:`converters`)
.. versionadded:: 0.2.2
.. versionchanged:: 1.0.1
Code simplification allowed us to switch to using
:data:`EXCEPTION_CONVERTERS` as the default value of
:attr:`converters`.
s% <exception failed to convert to text>( R> ( RO RP RF RQ ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt exception_to_bytesÿ s
c C sç | s
d Sy t | d | ƒWnp t k
rF t t j d ƒ ƒ ‚ nK t k
rk t t j d ƒ ƒ ‚ n& t k
r } t | j d ƒ ‚ n X| j | d ƒ } | rÎ t j
j j | d i d d 6ƒ} n t j
j j | ƒ } | S(
sd Take a :class:`unicode` string and turn it into a byte :class:`str`
suitable for xml
:arg string: :class:`unicode` string to encode into an XML compatible byte
:class:`str`
:kwarg encoding: encoding to use for the returned byte :class:`str`.
Default is to encode to :term:`UTF-8`. If some of the characters in
:attr:`string` are not encodable in this encoding, the unknown
characters will be entered into the output string using xml character
references.
:kwarg attrib: If :data:`True`, quote the string for use in an xml
attribute. If :data:`False` (default), quote for use in an xml text
field.
:kwarg control_chars: :term:`control characters` are not allowed in XML
documents. When we encounter those we need to know what to do. Valid
options are:
:replace: (default) Replace the control characters with ``?``
:ignore: Remove the characters altogether from the output
:strict: Raise an :exc:`~kitchen.text.exceptions.XmlEncodeError` when
we encounter a :term:`control character`
:raises kitchen.text.exceptions.XmlEncodeError: If :attr:`control_chars`
is set to ``strict`` and the string to be made suitable for output to
xml contains :term:`control characters` or if :attr:`string` is not
a :class:`unicode` string then we raise this exception.
:raises ValueError: If :attr:`control_chars` is set to something other than
``replace``, ``ignore``, or ``strict``.
:rtype: byte :class:`str`
:returns: representation of the :class:`unicode` string as a valid XML
byte :class:`str`
XML files consist mainly of text encoded using a particular charset. XML
also denies the use of certain bytes in the encoded text (example: ``ASCII
Null``). There are also special characters that must be escaped if they
are present in the input (example: ``<``). This function takes care of
all of those issues for you.
There are a few different ways to use this function depending on your
needs. The simplest invocation is like this::
unicode_to_xml(u'String with non-ASCII characters: <"á ã¨">')
This will return the following to you, encoded in :term:`utf-8`::
'String with non-ASCII characters: <"á ã¨">'
Pretty straightforward. Now, what if you need to encode your document in
something other than :term:`utf-8`? For instance, ``latin-1``? Let's
see::
unicode_to_xml(u'String with non-ASCII characters: <"á ã¨">', encoding='latin-1')
'String with non-ASCII characters: <"á と">'
Because the ``ã¨`` character is not available in the ``latin-1`` charset,
it is replaced with ``と`` in our output. This is an xml character
reference which represents the character at unicode codepoint ``12392``, the
``ã¨`` character.
When you want to reverse this, use :func:`xml_to_unicode` which will turn
a byte :class:`str` into a :class:`unicode` string and replace the xml
character references with the unicode characters.
XML also has the quirk of not allowing :term:`control characters` in its
output. The :attr:`control_chars` parameter allows us to specify what to
do with those. For use cases that don't need absolute character by
character fidelity (example: holding strings that will just be used for
display in a GUI app later), the default value of ``replace`` works well::
unicode_to_xml(u'String with disallowed control chars: \u0000\u0007')
'String with disallowed control chars: ??'
If you do need to be able to reproduce all of the characters at a later
date (examples: if the string is a key value in a database or a path on a
filesystem) you have many choices. Here are a few that rely on ``utf-7``,
a verbose encoding that encodes :term:`control characters` (as well as
non-:term:`ASCII` unicode values) to characters from within the
:term:`ASCII` printable characters. The good thing about doing this is
that the code is pretty simple. You just need to use ``utf-7`` both when
encoding the field for xml and when decoding it for use in your python
program::
unicode_to_xml(u'String with unicode: 㨠and control char: \u0007', encoding='utf7')
'String with unicode: +MGg and control char: +AAc-'
# [...]
xml_to_unicode('String with unicode: +MGg and control char: +AAc-', encoding='utf7')
u'String with unicode: 㨠and control char: \u0007'
As you can see, the ``utf-7`` encoding will transform even characters that
would be representable in :term:`utf-8`. This can be a drawback if you
want unicode characters in the file to be readable without being decoded
first. You can work around this with increased complexity in your
application code::
encoding = 'utf-8'
u_string = u'String with unicode: 㨠and control char: \u0007'
try:
# First attempt to encode to utf8
data = unicode_to_xml(u_string, encoding=encoding, errors='strict')
except XmlEncodeError:
# Fallback to utf-7
encoding = 'utf-7'
data = unicode_to_xml(u_string, encoding=encoding, errors='strict')
write_tag('<mytag encoding=%s>%s</mytag>' % (encoding, data))
# [...]
encoding = tag.attributes.encoding
u_string = xml_to_unicode(u_string, encoding=encoding)
Using code similar to that, you can have some fields encoded using your
default encoding and fallback to ``utf-7`` if there are :term:`control
characters` present.
.. note::
If your goal is to preserve the :term:`control characters` you cannot
save the entire file as ``utf-7`` and set the xml encoding parameter
to ``utf-7`` if your goal is to preserve the :term:`control
characters`. Because XML doesn't allow :term:`control characters`,
you have to encode those separate from any encoding work that the XML
parser itself knows about.
.. seealso::
:func:`bytes_to_xml`
if you're dealing with bytes that are non-text or of an unknown
encoding that you must preserve on a byte for byte level.
:func:`guess_encoding_to_xml`
if you're dealing with strings in unknown encodings that you don't
need to save with char-for-char fidelity.
R< t strategysi unicode_to_xml must have a unicode type as the first argument. Use bytes_string_to_xml for byte strings.sV The control_chars argument to unicode_to_xml must be one of ignore, replace, or stricti t xmlcharrefreplacet entitiess "t "(
R R3 R R* R+ t
ValueErrorR RL R4 t xmlt saxt saxutilst escape( t stringR5 t attribt
control_charsRO ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt unicode_to_xml# s „
%c C s( t | d | d | ƒ} t | ƒ } | S( s
Transform a byte :class:`str` from an xml file into a :class:`unicode`
string
:arg byte_string: byte :class:`str` to decode
:kwarg encoding: encoding that the byte :class:`str` is in
:kwarg errors: What to do if not every character is valid in
:attr:`encoding`. See the :func:`to_unicode` documentation for legal
values.
:rtype: :class:`unicode` string
:returns: string decoded from :attr:`byte_string`
This function attempts to reverse what :func:`unicode_to_xml` does. It
takes a byte :class:`str` (presumably read in from an xml file) and
expands all the html entities into unicode characters and decodes the byte
:class:`str` into a :class:`unicode` string. One thing it cannot do is
restore any :term:`control characters` that were removed prior to
inserting into the file. If you need to keep such characters you need to
use :func:`xml_to_bytes` and :func:`bytes_to_xml` or use on of the
strategies documented in :func:`unicode_to_xml` instead.
R5 R6 ( R; R ( t byte_stringR5 R6 R] ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt xml_to_unicode¿ s c C sU t | t ƒ s' t t j d ƒ ƒ ‚ n t | | | ƒ } t | d | d | d | ƒS( sÜ
Make sure a byte :class:`str` is validly encoded for xml output
:arg byte_string: Byte :class:`str` to turn into valid xml output
:kwarg input_encoding: Encoding of :attr:`byte_string`. Default ``utf-8``
:kwarg errors: How to handle errors encountered while decoding the
:attr:`byte_string` into :class:`unicode` at the beginning of the
process. Values are:
:replace: (default) Replace the invalid bytes with a ``?``
:ignore: Remove the characters altogether from the output
:strict: Raise an :exc:`UnicodeDecodeError` when we encounter
a non-decodable character
:kwarg output_encoding: Encoding for the xml file that this string will go
into. Default is ``utf-8``. If all the characters in
:attr:`byte_string` are not encodable in this encoding, the unknown
characters will be entered into the output string using xml character
references.
:kwarg attrib: If :data:`True`, quote the string for use in an xml
attribute. If :data:`False` (default), quote for use in an xml text
field.
:kwarg control_chars: XML does not allow :term:`control characters`. When
we encounter those we need to know what to do. Valid options are:
:replace: (default) Replace the :term:`control characters` with ``?``
:ignore: Remove the characters altogether from the output
:strict: Raise an error when we encounter a :term:`control character`
:raises XmlEncodeError: If :attr:`control_chars` is set to ``strict`` and
the string to be made suitable for output to xml contains
:term:`control characters` then we raise this exception.
:raises UnicodeDecodeError: If errors is set to ``strict`` and the
:attr:`byte_string` contains bytes that are not decodable using
:attr:`input_encoding`, this error is raised
:rtype: byte :class:`str`
:returns: representation of the byte :class:`str` in the output encoding with
any bytes that aren't available in xml taken care of.
Use this when you have a byte :class:`str` representing text that you need
to make suitable for output to xml. There are several cases where this
is the case. For instance, if you need to transform some strings encoded
in ``latin-1`` to :term:`utf-8` for output::
utf8_string = byte_string_to_xml(latin1_string, input_encoding='latin-1')
If you already have strings in the proper encoding you may still want to
use this function to remove :term:`control characters`::
cleaned_string = byte_string_to_xml(string, input_encoding='utf-8', output_encoding='utf-8')
.. seealso::
:func:`unicode_to_xml`
for other ideas on using this function
sm byte_string_to_xml can only take a byte string as its first argument. Use unicode_to_xml for unicode stringsR5 R^ R_ ( R" R1 R R* R+ R$ R` ( Ra t input_encodingR6 t output_encodingR^ R_ t u_string( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt byte_string_to_xmlØ s
9c C s" t | | | ƒ } t | | | ƒ S( s= Transform a byte :class:`str` from an xml file into :class:`unicode`
string
:arg byte_string: byte :class:`str` to decode
:kwarg input_encoding: encoding that the byte :class:`str` is in
:kwarg errors: What to do if not every character is valid in
:attr:`encoding`. See the :func:`to_unicode` docstring for legal
values.
:kwarg output_encoding: Encoding for the output byte :class:`str`
:returns: :class:`unicode` string decoded from :attr:`byte_string`
This function attempts to reverse what :func:`unicode_to_xml` does. It
takes a byte :class:`str` (presumably read in from an xml file) and
expands all the html entities into unicode characters and decodes the
byte :class:`str` into a :class:`unicode` string. One thing it cannot do
is restore any :term:`control characters` that were removed prior to
inserting into the file. If you need to keep such characters you need to
use :func:`xml_to_bytes` and :func:`bytes_to_xml` or use one of the
strategies documented in :func:`unicode_to_xml` instead.
( Rb R> ( Ra Rc R6 Rd R] ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt xml_to_byte_string s c O s t | | | Ž S( s3 Return a byte :class:`str` encoded so it is valid inside of any xml
file
:arg byte_string: byte :class:`str` to transform
:arg \*args, \*\*kwargs: extra arguments to this function are passed on to
the function actually implementing the encoding. You can use this to
tweak the output in some cases but, as a general rule, you shouldn't
because the underlying encoding function is not guaranteed to remain
the same.
:rtype: byte :class:`str` consisting of all :term:`ASCII` characters
:returns: byte :class:`str` representation of the input. This will be encoded
using base64.
This function is made especially to put binary information into xml
documents.
This function is intended for encoding things that must be preserved
byte-for-byte. If you want to encode a byte string that's text and don't
mind losing the actual bytes you probably want to try :func:`byte_string_to_xml`
or :func:`guess_encoding_to_xml` instead.
.. note::
Although the current implementation uses :func:`base64.b64encode` and
there's no plans to change it, that isn't guaranteed. If you want to
make sure that you can encode and decode these messages it's best to
use :func:`xml_to_bytes` if you use this function to encode.
( R ( Ra RL t kwargs( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt bytes_to_xml4 s c O s t | | | Ž S( s‰ Decode a string encoded using :func:`bytes_to_xml`
:arg byte_string: byte :class:`str` to transform. This should be a base64
encoded sequence of bytes originally generated by :func:`bytes_to_xml`.
:arg \*args, \*\*kwargs: extra arguments to this function are passed on to
the function actually implementing the encoding. You can use this to
tweak the output in some cases but, as a general rule, you shouldn't
because the underlying encoding function is not guaranteed to remain
the same.
:rtype: byte :class:`str`
:returns: byte :class:`str` that's the decoded input
If you've got fields in an xml document that were encoded with
:func:`bytes_to_xml` then you want to use this function to undecode them.
It converts a base64 encoded string into a byte :class:`str`.
.. note::
Although the current implementation uses :func:`base64.b64decode` and
there's no plans to change it, that isn't guaranteed. If you want to
make sure that you can encode and decode these messages it's best to
use :func:`bytes_to_xml` if you use this function to decode.
( R ( Ra RL Rh ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt xml_to_bytesT s c C s_ t | t ƒ r+ t | d | d | d | ƒSt | ƒ } t | d | d d d | d | d | ƒS( s© Return a byte :class:`str` suitable for inclusion in xml
:arg string: :class:`unicode` or byte :class:`str` to be transformed into
a byte :class:`str` suitable for inclusion in xml. If string is
a byte :class:`str` we attempt to guess the encoding. If we cannot guess,
we fallback to ``latin-1``.
:kwarg output_encoding: Output encoding for the byte :class:`str`. This
should match the encoding of your xml file.
:kwarg attrib: If :data:`True`, escape the item for use in an xml
attribute. If :data:`False` (default) escape the item for use in
a text node.
:returns: :term:`utf-8` encoded byte :class:`str`
R5 R^ R_ Rc R6 R Rd ( R" R$ R` R Rf ( R] Rd R^ R_ Rc ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt guess_encoding_to_xmln s
t ignorec C s; t j t j d ƒ t d d ƒt | d | d | d | ƒS( s< *Deprecated*: Use :func:`guess_encoding_to_xml` instead
si kitchen.text.converters.to_xml is deprecated. Use kitchen.text.converters.guess_encoding_to_xml instead.R i Rd R^ R_ ( R( R) R* R+ R, Rk ( R] R5 R^ R_ ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt to_xml‹ s
t BYTE_EXCEPTION_CONVERTERSt EXCEPTION_CONVERTERSRf Ri RS RR RI Rk R> RK R; RJ Rm R` Rg Rj Rb (
s utf-8s UTF-8s utf8R s utf_8R s utfR
s u8R ( s latin-1s LATIN-1s latin1R s latinR s l1R s cp819R s 8859s iso8859-1s ISO8859-1s
iso-8859-1s
ISO-8859-1( s BYTE_EXCEPTION_CONVERTERSs EXCEPTION_CONVERTERSs byte_string_to_xmls bytes_to_xmls exception_to_bytess exception_to_unicodes getwriters guess_encoding_to_xmls to_bytess to_strs
to_unicodes to_utf8s to_xmls unicode_to_xmls xml_to_byte_strings xml_to_bytess xml_to_unicode(- t __doc__t base64R R t ImportErrort kitchen.pycompat24.base64R@ R( t xml.sax.saxutilsRY t kitchenR* t kitchen.pycompat24R t add_builtin_sett kitchen.text.exceptionsR R t kitchen.text.miscR R R t frozensetR% R& R0 R; R> RI RJ RK Ro Rn RR RS t FalseR` Rb Rf Rg Ri Rj Rk Rm t __all__( ( ( s; /usr/lib/python2.7/site-packages/kitchen/text/converters.pyt <module>+ s\
k v F 8 $ ›B
OHA YOOOO