PlasmaCalcs.dimensions.snaps.UniqueSnap

class PlasmaCalcs.dimensions.snaps.UniqueSnap(name, repr=None, module_name=None, unique_includes_module=False)

unique snap; Sentinel value with Snap type.

Methods

`__init__`(args__None, *kw__None)
`copy`(**kw__None)
`copy_add_t`(_t_add)
`deserialize`(serial)
`equal_except_i`(v)
`exists_for`(calculator)
`file_path`(calculator)
`file_s`(calculator)
`file_snap`(calculator)
`from_dict`(d, *[, ignore_dt])
`getter`(dlist)
`lookup_dict`()
`register_type`(cls_to_register[, ...])
`serialize`()
`to_dict`()
`with_i`(i)

Attributes

copy_add_t(_t_add): return self, unchanged; self is a Sentinel so there is only 1 instance.

static deserialize(serial)

creates an XarrayIoSerializable object from a serialized representation.

serial: dict or str: str –> convert to dict via ast.literal_eval.

dict must contain ‘typename’ key.

The output here will be an instance of XarrayIoSerializable.SERIAL_TYPES[typename]

equal_except_i(v): returns whether self == v (another DimensionValue), ignoring i.

equal if v is an instance of type(self) and

all kw from both self._kw_eq and v._kw_eq have the same values.

(any kw missing attrs will be treated as UNSET.)

For DimensionValue: self.s==v.s and self.i==v.i. Subclasses may add more.

exists_for(calculator): returns whether this snap exists for this calculator.

Here, just return self is not MISSING_SNAP. subclass should override if desired.

file_path(calculator): returns the abspath to the file associated with this snap for this calculator.

Here, just return calculator.snap_filepath(self).

file_s(calculator): returns the str used when determining file related to this snap.

Here, just return str(self). subclass should override if desired.

file_snap(calculator): returns the snap used when determining file related to this snap.

Here, just returns self. Subclasses might override.

classmethod from_dict(d, *, ignore_dt=True)

return cls from dict d. d should NOT have ‘typename’ key.

Use cls.deserialize(d) instead if d has ‘typname’ key.

ignore_dt: bool: whether to ignore ‘dt’ key from d.

This exists for backwards compatibility when reading older files;

Snap previously accepted ‘dt’ key but doesn’t anymore.

getter(dlist): get the value from dlist specified by self.

(Here, just returns self, the SpecialDimensionValue)

lookup_dict(): returns dict for looking up self within a DimensionValueList, given int, str, or self.

(used by DimensionValueList.lookup_dict)

static register_type(cls_to_register, _serial_typename=None)

register cls_to_register as a serializable subclass of XarrayIoSerializable.

_serial_typename: str or None: name to use for serialization. if None, use cls_to_register.__name__.

to_dict(): return dictionary of info about self. Attribute values for keys in self._kw_def.

e.g. if _kw_def={‘s’, ‘i’}: result = {‘s’: self.s, ‘i’: self.i}