�
�Udac @ s� d Z d d l Z d d l m Z m Z m Z y e j d � e Z Wn e k
r^ e
Z n Xe d � Z
d d d d
� Z d d d d � Z e r� e Z n e Z d S(
s(
.. warn:: This module_util is currently internal implementation.
We want to evaluate this code for stability and API suitability before
making backwards compatibility guarantees. The API may change between
releases. Do not use this unless you are willing to port your module code.
i����N( t PY3t text_typet binary_typet surrogateescapet surrogate_or_replacet surrogate_or_strictt surrogate_then_replaces utf-8t
simplereprc C s� t | t � r | S| } | t k rR t r4 d } qR | d k rI d } qR d } n t | t � r� y | j | | � SWq� t k
r� | d k r� | j d d � } | j d d � } | j | d � S� q� Xn | d k r-y t | � } Wq~t
k
r)y t | � } Wq*t
k
r%t d � SXq~XnQ | d k r=| S| d
k rSt d � S| d k rnt
d � � n t
d | � � t | | | � S( s
Make sure that a string is a byte string
:arg obj: An object to make sure is a byte string. In most cases this
will be either a text string or a byte string. However, with
``nonstring='simplerepr'``, this can be used as a traceback-free
version of ``str(obj)``.
:kwarg encoding: The encoding to use to transform from a text string to
a byte string. Defaults to using 'utf-8'.
:kwarg errors: The error handler to use if the text string is not
encodable using the specified encoding. Any valid `codecs error
handler <https://docs.python.org/2/library/codecs.html#codec-base-classes>`_
may be specified. There are three additional error strategies
specifically aimed at helping people to port code. The first two are:
:surrogate_or_strict: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``strict``
:surrogate_or_replace: Will use ``surrogateescape`` if it is a valid
handler, otherwise it will use ``replace``.
Because ``surrogateescape`` was added in Python3 this usually means that
Python3 will use ``surrogateescape`` and Python2 will use the fallback
error handler. Note that the code checks for ``surrogateescape`` when the
module is imported. If you have a backport of ``surrogateescape`` for
Python2, be sure to register the error handler prior to importing this
module.
The last error handler is:
:surrogate_then_replace: Will use ``surrogateescape`` if it is a valid
handler. If encoding with ``surrogateescape`` would traceback,
surrogates are first replaced with a replacement characters
and then the string is encoded using ``replace`` (which replaces
the rest of the nonencodable bytes). If ``surrogateescape`` is
not present it will simply use ``replace``. (Added in Ansible 2.3)
This strategy is designed to never traceback when it attempts
to encode a string.
The default until Ansible-2.2 was ``surrogate_or_replace``
From Ansible-2.3 onwards, the default is ``surrogate_then_replace``.
:kwarg nonstring: The strategy to use if a nonstring is specified in
``obj``. Default is 'simplerepr'. Valid values are:
:simplerepr: The default. This takes the ``str`` of the object and
then returns the bytes version of that string.
:empty: Return an empty byte string
:passthru: Return the object passed in
:strict: Raise a :exc:`TypeError`
:returns: Typically this returns a byte string. If a nonstring object is
passed in this may be a different type depending on the strategy
specified by nonstring. This will never return a text string.
.. note:: If passed a byte string, this function does not check that the
string is valid in the specified encoding. If it's important that the
byte string is in the specified encoding do::
encoded_string = to_bytes(to_text(input_string, 'latin-1'), 'utf-8')
.. version_changed:: 2.3
Added the ``surrogate_then_replace`` error handler and made it the default error handler.
R R t strictt replaceR s utf-8R t t passthrut emptys obj must be a string types2 Invalid value %s for to_bytes' nonstring parameterN( NR ( t
isinstanceR t _COMPOSED_ERROR_HANDLERSt HAS_SURROGATEESCAPER t encodet UnicodeEncodeErrort Nonet decodet strt UnicodeErrort reprt to_bytest TypeError( t objt encodingt errorst nonstringt original_errorst
return_stringt value( ( s>