IntegerType¶
-
class
asdf.
IntegerType
(value, storage_type='internal')[source]¶ Bases:
asdf.types.AsdfType
Enables the storage of arbitrarily large integer values
The ASDF Standard mandates that integer literals in the tree can be no larger than 52 bits. Use of this class enables the storage of arbitrarily large integer values.
When reading files that contain arbitrarily large integers, the values that are restored in the tree will be raw Python
int
instances.Parameters: value: `numbers.Integral`
A Python integral value (e.g.
int
ornumpy.integer
)storage_type: `str`, optional
Optionally overrides the storage type of the array used to represent the integer value. Valid values are “internal” (the default) and “inline”
Examples
>>> import asdf >>> import random >>> # Create a large integer value >>> largeval = random.getrandbits(100) >>> # Store the large integer value to the tree using asdf.IntegerType >>> tree = dict(largeval=asdf.IntegerType(largeval)) >>> with asdf.AsdfFile(tree) as af: ... af.write_to('largeval.asdf') >>> with asdf.open('largeval.asdf') as aa: ... assert aa['largeval'] == largeval
Attributes Summary
handle_dynamic_subclasses
has_required_modules
name
organization
requires
standard
supported_versions
types
validators
version
yaml_tag
Methods Summary
from_tree
(tree, ctx)Converts basic types representing YAML trees into custom types. from_tree_tagged
(tree, ctx)Converts from tagged tree into custom type. incompatible_version
(version)Indicates if given version is known to be incompatible with this type. make_yaml_tag
(name[, versioned])Given the name of a type, returns a string representing its YAML tag. names
()Returns the name(s) represented by this tag type as a list. tag_base
()Returns the base of the YAML tag for types represented by this class. to_tree
(node, ctx)Converts instances of custom types into YAML representations. to_tree_tagged
(node, ctx)Converts instances of custom types into tagged objects. Attributes Documentation
-
handle_dynamic_subclasses
= False¶
-
has_required_modules
= True¶
-
name
= 'core/integer'¶
-
organization
= 'stsci.edu'¶
-
requires
= []¶
-
standard
= 'asdf'¶
-
supported_versions
= []¶
-
types
= []¶
-
validators
= {}¶
-
version
= Version('1.0.0')¶
-
yaml_tag
= 'tag:stsci.edu:asdf/core/integer-1.0.0'¶
Methods Documentation
-
classmethod
from_tree
(tree, ctx)[source]¶ Converts basic types representing YAML trees into custom types.
This method should be overridden by custom extension classes in order to define how custom types are deserialized from the YAML representation back into their original types. The method will return an instance of the original custom type.
This method is called as part of the process of reading an ASDF file in order to construct an
AsdfFile
object. Whenever a YAML subtree is encountered that has a tag that corresponds to theyaml_tag
property of this class, this method will be used to deserialize that tree back into an instance of the original custom type.Parameters: tree :
object
representing YAML treeAn instance of a basic Python type (possibly nested) that corresponds to a YAML subtree.
ctx :
AsdfFile
An instance of the
AsdfFile
object that is being constructed.Returns: An instance of the custom type represented by this extension class.
-
classmethod
from_tree_tagged
(tree, ctx)¶ Converts from tagged tree into custom type.
It is more common for extension classes to override
from_tree
instead of this method. This method should only be overridden if it is necessary to access the_tag
property of theTagged
object directly.Parameters: tree :
asdf.tagged.Tagged
object representing YAML treectx :
AsdfFile
An instance of the
AsdfFile
object that is being constructed.Returns: An instance of the custom type represented by this extension class.
-
classmethod
incompatible_version
(version)¶ Indicates if given version is known to be incompatible with this type.
If this tag class explicitly identifies compatible versions then this checks whether a given version is compatible or not (see
supported_versions
). Otherwise, all versions are assumed to be compatible.Child classes can override this method to affect how version compatiblity for this type is determined.
Parameters: version :
str
orAsdfVersion
The version to test for compatibility.
-
classmethod
make_yaml_tag
(name, versioned=True)¶ Given the name of a type, returns a string representing its YAML tag.
Parameters: name : str
The name of the type. In most cases this will correspond to the
name
attribute of the tag type. However, it is passed as a parameter since some tag types represent multiple custom types.versioned : bool
If
True
, the tag will be versioned. Otherwise, a YAML tag without a version will be returned.Returns: str
representing the YAML tag
-
classmethod
names
()¶ Returns the name(s) represented by this tag type as a list.
While some tag types represent only a single custom type, others represent multiple types. In the latter case, the
name
attribute of the extension is actually a list, not simply a string. This method normalizes the value ofname
by returning a list in all cases.Returns: list
of names represented by this tag type
-
classmethod
tag_base
()¶ Returns the base of the YAML tag for types represented by this class.
This method returns the portion of the tag that represents the standard and the organization of any type represented by this class.
Returns: str
representing the base of the YAML tag
-
classmethod
to_tree
(node, ctx)[source]¶ Converts instances of custom types into YAML representations.
This method should be overridden by custom extension classes in order to define how custom types are serialized into YAML. The method must return a single Python object corresponding to one of the basic YAML types (dict, list, str, or number). However, the types can be nested and combined in order to represent more complex custom types.
This method is called as part of the process of writing an
AsdfFile
object. Whenever a custom type (or a subclass of that type) that is listed in thetypes
attribute of this class is encountered, this method will be used to serialize that type.The name
to_tree
refers to the act of converting a custom type into part of a YAML object tree.Parameters: node :
object
Instance of a custom type to be serialized. Will be an instance (or an instance of a subclass) of one of the types listed in the
types
attribute of this class.ctx :
AsdfFile
An instance of the
AsdfFile
object that is being written out.Returns: A basic YAML type (
dict
,list
,str
,int
,float
, orcomplex
) representing the properties of the custom type to be serialized. These types can be nested in order to represent more complex custom types.
-
classmethod
to_tree_tagged
(node, ctx)¶ Converts instances of custom types into tagged objects.
It is more common for custom tag types to override
to_tree
instead of this method. This method should only be overridden if it is necessary to modify the YAML tag that will be used to tag this object.Parameters: node :
object
Instance of a custom type to be serialized. Will be an instance (or an instance of a subclass) of one of the types listed in the
types
attribute of this class.ctx :
AsdfFile
An instance of the
AsdfFile
object that is being written out.Returns: An instance of
asdf.tagged.Tagged
.
-