load_asn

jwst.associations.load_asn(serialized, fmt=None, first=True, validate=True, registry=<class 'jwst.associations.registry.AssociationRegistry'>, **kwargs)[source]

Load an Association from a file or object.

Parameters:
serializedobject

The serialized form of the association.

fmtstr or None

The format to force. If None, try all available.

firstbool

A serialization potentially matches many rules. Only return the first successful load.

validatebool

Validate against the class’s defined schema, if any.

registryAssociationRegistry or None

The AssociationRegistry to use. If None, no registry is used. Can be passed just a registry class instead of instance.

**kwargsdict

Other arguments to pass to the load methods defined in the Association.KeyValueRegistry

Returns:
Association object

The loaded association.

Raises:
AssociationNotValidError

Cannot create or validate the association.

Notes

The serialized object can be in any format supported by the registered I/O routines. For example, for json and yaml formats, the input can be either a string or a file object containing the string.

If no registry is specified, the default Association.load method is used.