mercurial/thirdparty/cbor/README.rst
author Martin von Zweigbergk <martinvonz@google.com>
Thu, 07 Jan 2021 12:26:32 -0800
changeset 46272 a68d3386138c
parent 37126 4bd73a955ab0
permissions -rw-r--r--
shelve: raise more specific errors Differential Revision: https://phab.mercurial-scm.org/D9699
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37126
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     1
.. image:: https://travis-ci.org/agronholm/cbor2.svg?branch=master
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     2
  :target: https://travis-ci.org/agronholm/cbor2
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     3
  :alt: Build Status
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     4
.. image:: https://coveralls.io/repos/github/agronholm/cbor2/badge.svg?branch=master
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     5
  :target: https://coveralls.io/github/agronholm/cbor2?branch=master
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     6
  :alt: Code Coverage
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     7
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     8
This library provides encoding and decoding for the Concise Binary Object Representation (CBOR)
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
     9
(`RFC 7049`_) serialization format.
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    10
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    11
There exists another Python CBOR implementation (cbor) which is faster on CPython due to its C
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    12
extensions. On PyPy, cbor2 and cbor are almost identical in performance. The other implementation
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    13
also lacks documentation and a comprehensive test suite, does not support most standard extension
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    14
tags and is known to crash (segfault) when passed a cyclic structure (say, a list containing
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    15
itself).
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    16
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    17
.. _RFC 7049: https://tools.ietf.org/html/rfc7049
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    18
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    19
Project links
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    20
-------------
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    21
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    22
* `Documentation <http://cbor2.readthedocs.org/>`_
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    23
* `Source code <https://github.com/agronholm/cbor2>`_
4bd73a955ab0 thirdparty: vendor cbor2 python library
Pulkit Goyal <7895pulkit@gmail.com>
parents:
diff changeset
    24
* `Issue tracker <https://github.com/agronholm/cbor2/issues>`_