Massage api docs.
This commit is contained in:
@@ -1524,29 +1524,31 @@ class SchemaNode(object):
|
|||||||
return cstruct
|
return cstruct
|
||||||
|
|
||||||
def flatten(self, appstruct):
|
def flatten(self, appstruct):
|
||||||
""" Create an fstruct from the appstruct based on the schema
|
""" Create and return a data structure which is a flattened
|
||||||
represented by this node and return the fstruct. An fstruct
|
representation of the passed in struct based on the schema represented
|
||||||
is a flattened representation of an appstruct. An fstruct is
|
by this node. The return data structure is a dictionary; its keys are
|
||||||
a dictionary; its keys are dotted names. Each dotted name
|
dotted names. Each dotted name represents a path to a location in the
|
||||||
represents a location in the schema. The values of an fstruct
|
schema. The values of of the flattened dictionary are subvalues of
|
||||||
dictionary are appstruct subvalues."""
|
the passed in struct."""
|
||||||
flat = self.typ.flatten(self, appstruct)
|
flat = self.typ.flatten(self, appstruct)
|
||||||
return flat
|
return flat
|
||||||
|
|
||||||
def unflatten(self, fstruct):
|
def unflatten(self, fstruct):
|
||||||
""" Create an appstruct based on the schema represented by
|
""" Create and return a data structure with nested substructures based
|
||||||
this node using the fstruct passed. """
|
on the schema represented by this node using the flattened
|
||||||
|
representation passed in. This is the inverse operation to
|
||||||
|
:meth:`colander.SchemaNode.flatten`."""
|
||||||
paths = sorted(fstruct.keys())
|
paths = sorted(fstruct.keys())
|
||||||
return self.typ.unflatten(self, paths, fstruct)
|
return self.typ.unflatten(self, paths, fstruct)
|
||||||
|
|
||||||
def set_value(self, appstruct, dotted_name, value):
|
def set_value(self, appstruct, dotted_name, value):
|
||||||
""" Uses the schema to set a value in an appstruct from a dotted_name
|
""" Uses the schema to set a value in a nested datastructure from a
|
||||||
path. """
|
dotted name path. """
|
||||||
self.typ.set_value(self, appstruct, dotted_name, value)
|
self.typ.set_value(self, appstruct, dotted_name, value)
|
||||||
|
|
||||||
def get_value(self, appstruct, dotted_name):
|
def get_value(self, appstruct, dotted_name):
|
||||||
""" Traverses the appstruct using the schema and retrieves the value
|
""" Traverses the nested data structure using the schema and retrieves
|
||||||
specified by the dotted_name path."""
|
the value specified by the dotted name path."""
|
||||||
return self.typ.get_value(self, appstruct, dotted_name)
|
return self.typ.get_value(self, appstruct, dotted_name)
|
||||||
|
|
||||||
def deserialize(self, cstruct=null):
|
def deserialize(self, cstruct=null):
|
||||||
|
Submodule docs/_themes updated: 03e5e5aaae...eed33411e3
@@ -57,6 +57,7 @@ internationalizable.
|
|||||||
null.rst
|
null.rst
|
||||||
extending.rst
|
extending.rst
|
||||||
binding.rst
|
binding.rst
|
||||||
|
manipulation.rst
|
||||||
interfaces.rst
|
interfaces.rst
|
||||||
api.rst
|
api.rst
|
||||||
glossary.rst
|
glossary.rst
|
||||||
|
Reference in New Issue
Block a user