Skip to content
Newer
Older
100644 77 lines (50 sloc) 1.65 KB
9e94639 @pauleveritt Update index.rst
pauleveritt authored Aug 13, 2013
1
2 .. _overview:
3
8551306 @mcdonc "cereal" name already taken on pypi.
mcdonc authored Mar 14, 2010
4 Colander
5 ========
35fb6f5 @mcdonc Add partial work towards schema / validation / serialization / deseri…
mcdonc authored Mar 11, 2010
6
a6702e2 @mcdonc garden
mcdonc authored Feb 14, 2012
7 Colander is useful as a system for validating and deserializing data obtained
8 via XML, JSON, an HTML form post or any other equally simple data
ba571a4 @stevepiercy - remove 3.2/add 3.5 to docs (#252 (comment))
stevepiercy authored Feb 26, 2016
9 serialization. It runs on Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy, and pypy3.
1cddeb2 @tisdall update list of supported python versions
tisdall authored Jun 4, 2015
10 Colander can be used to:
35fb6f5 @mcdonc Add partial work towards schema / validation / serialization / deseri…
mcdonc authored Mar 11, 2010
11
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
12 - Define a data schema.
35fb6f5 @mcdonc Add partial work towards schema / validation / serialization / deseri…
mcdonc authored Mar 11, 2010
13
c6ec36b @mcdonc Documentation.
mcdonc authored Mar 12, 2010
14 - Deserialize a data structure composed of strings, mappings, and
15 lists into an arbitrary Python structure after validating the data
16 structure against a data schema.
17
db91df8 @mcdonc
mcdonc authored Mar 12, 2010
18 - Serialize an arbitrary Python structure to a data structure composed
19 of strings, mappings, and lists.
20
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
21 Colander is a good basis for form generation systems, data
22 description systems, and configuration systems.
23
8551306 @mcdonc "cereal" name already taken on pypi.
mcdonc authored Mar 14, 2010
24 Out of the box, Colander can serialize and deserialize various types
25 of objects, including:
c6ec36b @mcdonc Documentation.
mcdonc authored Mar 12, 2010
26
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
27 - A mapping object (e.g. dictionary).
c6ec36b @mcdonc Documentation.
mcdonc authored Mar 12, 2010
28
29 - A variable-length sequence of objects (each object is of the same
30 type).
31
32 - A fixed-length tuple of objects (each object is of a different
33 type).
34
35 - A string or Unicode object.
36
37 - An integer.
38
fa45df5 @mcdonc Add a float type.
mcdonc authored Mar 14, 2010
39 - A float.
40
44adcc5 @mcdonc - Add a Decimal type (decimal floating point).
mcdonc authored May 4, 2010
41 - A decimal float.
42
fa45df5 @mcdonc Add a float type.
mcdonc authored Mar 14, 2010
43 - A boolean.
bdac27e @mcdonc Docs + boolean.
mcdonc authored Mar 12, 2010
44
f85c0ed @mcdonc Docs and tests.
mcdonc authored Mar 12, 2010
45 - An importable Python object (to a dotted Python object path).
c6ec36b @mcdonc Documentation.
mcdonc authored Mar 12, 2010
46
199625c @mcdonc Docs.
mcdonc authored Apr 2, 2010
47 - A Python ``datetime.datetime`` object.
48
49 - A Python ``datetime.date`` object.
50
8551306 @mcdonc "cereal" name already taken on pypi.
mcdonc authored Mar 14, 2010
51 Colander allows additional data structures to be serialized and
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
52 deserialized by allowing a developer to define new "types".
53
54 The error messages used by Colander's default types are
55 internationalizable.
56
57 .. toctree::
0519d19 @mcdonc reshuffle
mcdonc authored Jun 5, 2010
58 :maxdepth: 2
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
59
60 basics.rst
c9d8f7a @lmctv First attempt at documenting colander.drop
lmctv authored Jan 17, 2016
61 null_and_drop.rst
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
62 extending.rst
514b06a @mcdonc - The concept of "schema binding" was added, which allows for a more
mcdonc authored Sep 8, 2010
63 binding.rst
8303e46 @chrisrossi Massage api docs.
chrisrossi authored Jan 13, 2012
64 manipulation.rst
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
65 interfaces.rst
66 api.rst
2dbdd45 @mcdonc describe appstruct and cstruct concepts in docs and in code
mcdonc authored Jun 7, 2010
67 glossary.rst
206cc49 @mcdonc prep for 0.7.0
mcdonc authored Jun 9, 2010
68 changes.rst
854d915 @mcdonc break out docs into separate rst files
mcdonc authored Jun 5, 2010
69
70 Indices and tables
71 ------------------
72
73 * :ref:`genindex`
74 * :ref:`modindex`
75 * :ref:`search`
c6ec36b @mcdonc Documentation.
mcdonc authored Mar 12, 2010
76
Something went wrong with that request. Please try again.