]> granicus.if.org Git - python/commitdiff
Fix JSON docs about loads() accepting only str objects, not bytes.
authorAntoine Pitrou <solipsis@pitrou.net>
Fri, 21 Jan 2011 21:37:32 +0000 (21:37 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Fri, 21 Jan 2011 21:37:32 +0000 (21:37 +0000)
Doc/library/json.rst
Lib/json/__init__.py

index b0703a4aef604e18649be48209f3a0e3d1508580..0ba22d1aace73e89d15d280b2036fa411f0bc3d0 100644 (file)
@@ -118,9 +118,8 @@ Basic Usage
    file-like object).
 
    If *skipkeys* is ``True`` (default: ``False``), then dict keys that are not
-   of a basic type (:class:`bytes`, :class:`str`, :class:`int`,
-   :class:`float`, :class:`bool`, ``None``) will be skipped instead of raising a
-   :exc:`TypeError`.
+   of a basic type (:class:`str`, :class:`int`, :class:`float`, :class:`bool`,
+   ``None``) will be skipped instead of raising a :exc:`TypeError`.
 
    The :mod:`json` module always produces :class:`str` objects, not
    :class:`bytes` objects. Therefore, ``fp.write()`` must support :class:`str`
@@ -203,15 +202,11 @@ Basic Usage
 
 .. function:: loads(s, encoding=None, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)
 
-   Deserialize *s* (a :class:`bytes` or :class:`str` instance containing a JSON
-   document) to a Python object.
-
-   If *s* is a :class:`bytes` instance and is encoded with an ASCII based encoding
-   other than UTF-8 (e.g. latin-1), then an appropriate *encoding* name must be
-   specified.  Encodings that are not ASCII based (such as UCS-2) are not
-   allowed and should be decoded to :class:`str` first.
+   Deserialize *s* (a :class:`str` instance containing a JSON document) to a
+   Python object.
 
-   The other arguments have the same meaning as in :func:`load`.
+   The other arguments have the same meaning as in :func:`load`, except
+   *encoding* which is ignored and deprecated.
 
 
 Encoders and decoders
index d71c2ce20f0b8e2ca510315dd93424a0baf701f5..a746f9cf9c9eb7e28526fd9b67ea748b7a643d69 100644 (file)
@@ -298,6 +298,8 @@ def loads(s, encoding=None, cls=None, object_hook=None, parse_float=None,
     To use a custom ``JSONDecoder`` subclass, specify it with the ``cls``
     kwarg; otherwise ``JSONDecoder`` is used.
 
+    The ``encoding`` argument is ignored and deprecated.
+
     """
     if (cls is None and object_hook is None and
             parse_int is None and parse_float is None and