FoSpy.blocks.template

This site only contains documentation for the Block subclasses defined in this module. For a complete reference of all functions, classes, and variables, see the full documentation.

Block Types in this Module

---

TemplateBlock

Bases: SingleBlock

Methods:

Name	Description
TemplateClass
__delattr__
__eq__	Check equality of two SingleBlock objects.
__getattr__	Check both self and self.ext for attribute before returning.
__hash__
__init__
__new__
__setattr__
_assign_and_inject	Attaches attributes and methods to any value before assigning it as an
_inject_defaults
_meta_to_front	Moves metadata to the front of _key_order. Metadata will always be
_override_validators
_rename_validators	Realigns any renamed
_resolve_relative_path	Resolves a relative object path string into an object or function.
_subprocess
_update_src
add_all_calc_routines	Schedule all available calculation routines.
add_block	Adds an unexpected attribute with a validator mapped by type_alias.
add_calc_comment	Add a calculated comment to be injected during serialization.
add_calc_routine	Schedules a calculated comment.
add_comments	Default behavior to be overwritten when attached to a parent block.
add_dispatch
build_req_validators	Builds required keys and validators mapped to subclass.
build_validators	Builds expected keys and validators mapped to subclass.
clear_all_comments
clear_comments	Clear comments attached to top-level attributes only.
copy	Returns a deep-copy of self by serializing and reconstructing.
default_key_order	Set to default attribute order for serialization.
dispatch_subclass
dispatcher	Decorate a classmethod to dispatch to other subclasses.
fill
fill_staged_template
find_attachments
find_fileblock	Finds the parent file object.
find_staged_id
find_tempdir	Find the parent file object's temporary directory.
find_temppath	Find the parent file object's temporary directory path.
get_id	Returns an easily recognizable identifier for self. Non-unique.
get_parent_prop
get_prop_dict	Returns a dictionary mapping property names to their live object values.
get_prop_path
get_req_validators
get_validators
has_staged
inject_defaults
inspect
key_to_idx	Reorder attributes for serialization.
keys_to_end	Reorder attributes for serialization.
keys_to_front	Reorder attributes for serialization.
list_avail_routines	Lists all calc routines available to be added to self._calc_routines.
make_template	Converts self into a template of its original subclass.
print_summary
reflex
refresh_attachments
register_dispatch	Decorate a subclass to be dispatched from a parent class.
rename_block
rename_dict
serialize
set_dispatch
setup_dispatch	Decorate a class to dispatch to other classes during construction.
stage_template
to_json	Converts self into a JSON-formatted string or file.
track_attachments

Source code in FoSpy/blocks/template.py

@SingleBlock.setup_dispatch(from_key="_full_class", allow_self=False)
class TemplateBlock(SingleBlock):
    _id_key = "template_name"
    _full_class = None
    _fields = None
    def __init__(self, blockDict, **kwargs):
        self._val_exceptions = {}
        from ._blockUtils import _unwrap_block

        blockDict = _unwrap_block(blockDict)
        blockDict.setdefault("template_name", self.__class__.__name__)
        super().__init__(blockDict, **kwargs)

    def _override_validators(self, validators):
        from .blocks import Block
        try:
            rename_dict = self.rename_dict()
        except AttributeError:
            rename_dict = {}

        for field in self._fields:
            if field in rename_dict:
                field = rename_dict[field]

            if field not in validators:
                continue

            val = validators[field]
            if not isinstance(val, type) or not issubclass(val, Block):
                new_val = TemplateField

            elif issubclass(val, SingleBlock):
                new_val = val.TemplateClass()

            elif issubclass(val, ListBlock):
                new_val = TemplateList.Simple(val._reqCls)

            else:
                raise NotImplementedError("Shouldn't happen")

            validators[field] = new_val

        for field in self._val_exceptions:
            validators[field] = FailedTemplateField

        return validators


    def get_req_validators(self):
        validators = super().get_req_validators()

        return self._override_validators(validators)

    def get_validators(self):
        validators = super().get_validators()

        return self._override_validators(validators)

    def find_staged_id(self):
        if not (hasattr(self, "_staged_parent")
                and self._staged_parent.has_staged()):
            return False

        staged_dict = self._staged_parent._staged_templates
        staged_reversed = {v:k for k,v in staged_dict.items()}

        return staged_reversed.get(self, False)

    def fill(self,incomplete=False,staged=False,in_place=False,**kwargs):
        if not self._full_class is not None and issubclass(self._full_class, SingleBlock):
            raise TypeError("A Template Block must be initialized from an existing class in order to be filled.")

        for prop in self._staged_templates:
            self.fill_staged_template(prop)

        staged_id = self.find_staged_id()
        if staged_id and not staged:
            _, filled = self._staged_parent.fill_staged_template(staged_id, **kwargs)
            return filled

        serial = self.serialize(keepListType=True)
        for kw, arg in kwargs.items():
            serial[kw] = arg

        flex_cls = self._full_class.TemplateClass()

        try:
            filled = self._full_class(serial)
        except Exception as e:
            filled = flex_cls(serial)

        return filled

    def serialize(self,keepListType=False, shallow=False, clean=False, **kwargs):
        # from ..parsing.validation import required_keys
        # from ..parsing.format_fos import format_field
        required = self.get_req_validators()
        required.pop('ext',None)
        required.pop('template_name',None)
        serial = super().serialize(keepListType=keepListType, shallow=shallow, clean=clean)

        out = {"template_name":serial.pop("template_name","")}

        for key, staged in self._staged_templates.items():
            serial.setdefault(key, staged.serialize(keepListType=keepListType, shallow=shallow, clean=clean))

        for key,validator in required.items():
            val = None
            if isinstance(validator,type):
                if issubclass(validator,SingleBlock):
                    val = serial.pop(key, validator.reflex())
                elif issubclass(validator, ListBlock):
                    val = serial.pop(key, validator([]).serialize())

            if val is None:
                val = serial.pop(key, TemplateField("").serialize())

            out[key] = val

        for key, val in serial.items():
            out[key] = val

        return out

    def __setattr__(self, name, value):
        from .. import _errors as err
        from .blocks import Block

        try:
            super().__setattr__(name, value)
            self._val_exceptions.pop(name, None)
        except err.FailedValidatorError as e:
            validators = self.get_validators()

            cached_val = validators.get(name, None)

            if not isinstance(cached_val, type) or not issubclass(cached_val, Block):
                self._val_exceptions[name] = e
                # newly mutated _val_exceptions should allow setattr now.
                super().__setattr__(name, value)

            elif issubclass(cached_val, SingleBlock):
                if isinstance(value, TemplateField) or value == TemplateField().serialize():
                    value = {}
                self.stage_template(name, value)

            elif issubclass(cached_val, TemplateList):
                raise NotImplementedError("A TemplateList construction failed unexpectedly.")

            else: # ListBlock Only
                from ._blockUtils import _unwrap_listblock
                from warnings import warn
                setattr(self, name, [])

                value = _unwrap_listblock(value)

                new_listblock = getattr(self, name)

                warnings = []
                for item in value:
                    try:
                        new_listblock.append(item)
                    except err.FailedValidatorError as e:
                        try:
                            new_listblock.stage_template(template=item)
                        except Exception as e:
                            warnings.append("The following item could not be set to a ListBlock or staged as a template:"
                                            f"\n\nCANDIDATE:\n{item}"
                                            f"\n\nERROR:\n{e}")
                if warnings:
                    for w in warnings:
                        warn(w, UserWarning)

    @classmethod
    def TemplateClass(cls, *args):
        if None in (cls._full_class, cls._fields):
            raise TypeError("A new Template Block must be initialized from an existing class, or a Template of that class.")

        fields = list(cls._fields)

        fields.extend([a for a in args if a not in fields])

        return cls._full_class.TemplateClass(*fields)

    @classmethod
    def _inject_defaults(cls, full_class, blockDict):
        from .. import _errors as err

        full_dispatch = getattr(full_class, "__dispatch__", {})

        next_class = None
        while next_class is not full_class:
            if next_class is None:
                next_class = full_dispatch.get("dispatch_from", full_class)
            else:
                registry = next_class.__dispatch__["registry"]
                try:
                    next_class = next(sub for sub in registry.values() if issubclass(full_class, sub))
                except StopIteration:
                    err.BlockDispatchError(
                        f"Could not find a valid dispatch chain to get from {next_class.__name__} to "
                        f"{full_class.__name__}.")

            blockDict = next_class.inject_defaults(blockDict)


        return blockDict

    def __new__(cls, blockDict, *args, **kwargs):
        from .. import _errors as err

        if None in (cls._fields, cls._full_class):
            raise err.BlockDispatchError("A Template Block must be initialized from an existing class, or a Template of that class.")

        dispatched = kwargs.pop("_dispatched", False)
        if dispatched:
            blockDict.setdefault("template_name", cls.__name__)
            return super().__new__(cls, blockDict, *args, _dispatched=True, **kwargs)

        full_class = cls._full_class
        blockDict = cls._inject_defaults(full_class, blockDict)

        template_class = full_class.TemplateClass(*cls._fields)

        for field in cls._fields:
            if blockDict.get(field, None) is None:
                blockDict[field] = TemplateField()


        return template_class(blockDict, *args, _dispatched=True, **kwargs)

_aliases = new_als class-attribute instance-attribute

_calc_comments = {} instance-attribute

_calc_routines = [] instance-attribute

_constructed = True instance-attribute

_fields = None class-attribute instance-attribute

_full_class = None class-attribute instance-attribute

_id_key = 'template_name' class-attribute instance-attribute

_key_order = [] instance-attribute

_key_overrides = {} instance-attribute

_meta = SubContainer() instance-attribute

_reserved = ['ext'] instance-attribute

_sourceDict = blockDict.copy() instance-attribute

_staged_templates = {} instance-attribute

_val_exceptions = {} instance-attribute

dispatch = {} class-attribute instance-attribute

dispatch_allow_self = True class-attribute instance-attribute

dispatch_default = None class-attribute instance-attribute

dispatch_key = None class-attribute instance-attribute

ext = SubContainer() instance-attribute

rename = rename instance-attribute

TemplateClass(*args) classmethod

Source code in FoSpy/blocks/template.py

@classmethod
def TemplateClass(cls, *args):
    if None in (cls._full_class, cls._fields):
        raise TypeError("A new Template Block must be initialized from an existing class, or a Template of that class.")

    fields = list(cls._fields)

    fields.extend([a for a in args if a not in fields])

    return cls._full_class.TemplateClass(*fields)

__delattr__(attr)

Source code in FoSpy/blocks/blocks.py

def __delattr__(self, attr):
    if attr in self.get_req_validators():
        raise AttributeError(f"Cannot delete property: '{attr}'. It is registered as a required property for this object.")
    return super().__delattr__(attr)

__eq__(other, suppress_routine_paths=False)

Check equality of two SingleBlock objects.

Equality is checked by a deep difference of their serialized dictionaries.

Parameters:

Name	Type	Description	Default
suppress_routine_paths	bool	Optional flag to still return true if the only differences found are in calculation routine metadata. Calculation routines are for user information only and may not be relevant for equality.	False

Source code in FoSpy/blocks/blocks.py

def __eq__(self, other, suppress_routine_paths:bool=False):
    """
    Check equality of two `SingleBlock` objects.

    Equality is checked by a deep difference of their
    [serialized][FoSpy.blocks.blocks.SingleBlock.serialize] dictionaries.

    Args:
        suppress_routine_paths:
            Optional flag to still return true if the only differences found
            are in [calculation
            routine][FoSpy.blocks.blocks.SingleBlock.add_calc_routine]
            metadata. Calculation routines are for user information only and
            may not be relevant for equality.
    """
    from .._debug import deep_diff as dd, _debug as db
    try:
        db.msg("Serializing Blocks to check equality:", module = "SingleBlock.__eq__()")
        diffs = dd(self.serialize(), other.serialize(), suppress_routine_paths=suppress_routine_paths)
        passed = len(diffs) == 0
        if not passed:
            db.pmsg(diffs,module = "SingleBlock.__eq__()")
        return passed
    except Exception as e:
        db.msg(f"Equality failed by exception: {e}",module = "SingleBlock.__eq__()")
        return False

__getattr__(name)

Check both self and self.ext for attribute before returning.

A matching attribute of self will be returned first, but if self has no matching attribute, a matching attribute of self.ext can be returned instead.

Source code in FoSpy/blocks/blocks.py

def __getattr__(self, name:str):
    """
    Check both `self` and `self.ext` for attribute before returning.

    A matching attribute of `self` will be returned first, but if `self` has
    no matching attribute, a matching attribute of `self.ext` can be
    returned instead.
    """

    try:
        if name not in ("rename", "ext") and hasattr(self, "rename"):
            rename_dict = self.rename.serialize(shallow=True, clean=True)
            if name in rename_dict:
                return getattr(self, rename_dict[name])

        if name != 'ext':
            return getattr(self.ext, name)

        raise AttributeError()
    except AttributeError:
        raise AttributeError(
            f"{type(self).__name__} object "
            f"has no attribute {name!r}."
        )

__hash__()

Source code in FoSpy/blocks/blocks.py

def __hash__(self):
    return id(self)

__init__(blockDict, **kwargs)

Source code in FoSpy/blocks/template.py

def __init__(self, blockDict, **kwargs):
    self._val_exceptions = {}
    from ._blockUtils import _unwrap_block

    blockDict = _unwrap_block(blockDict)
    blockDict.setdefault("template_name", self.__class__.__name__)
    super().__init__(blockDict, **kwargs)

__new__(blockDict, *args, **kwargs)

Source code in FoSpy/blocks/template.py

def __new__(cls, blockDict, *args, **kwargs):
    from .. import _errors as err

    if None in (cls._fields, cls._full_class):
        raise err.BlockDispatchError("A Template Block must be initialized from an existing class, or a Template of that class.")

    dispatched = kwargs.pop("_dispatched", False)
    if dispatched:
        blockDict.setdefault("template_name", cls.__name__)
        return super().__new__(cls, blockDict, *args, _dispatched=True, **kwargs)

    full_class = cls._full_class
    blockDict = cls._inject_defaults(full_class, blockDict)

    template_class = full_class.TemplateClass(*cls._fields)

    for field in cls._fields:
        if blockDict.get(field, None) is None:
            blockDict[field] = TemplateField()


    return template_class(blockDict, *args, _dispatched=True, **kwargs)

__setattr__(name, value)

Source code in FoSpy/blocks/template.py

def __setattr__(self, name, value):
    from .. import _errors as err
    from .blocks import Block

    try:
        super().__setattr__(name, value)
        self._val_exceptions.pop(name, None)
    except err.FailedValidatorError as e:
        validators = self.get_validators()

        cached_val = validators.get(name, None)

        if not isinstance(cached_val, type) or not issubclass(cached_val, Block):
            self._val_exceptions[name] = e
            # newly mutated _val_exceptions should allow setattr now.
            super().__setattr__(name, value)

        elif issubclass(cached_val, SingleBlock):
            if isinstance(value, TemplateField) or value == TemplateField().serialize():
                value = {}
            self.stage_template(name, value)

        elif issubclass(cached_val, TemplateList):
            raise NotImplementedError("A TemplateList construction failed unexpectedly.")

        else: # ListBlock Only
            from ._blockUtils import _unwrap_listblock
            from warnings import warn
            setattr(self, name, [])

            value = _unwrap_listblock(value)

            new_listblock = getattr(self, name)

            warnings = []
            for item in value:
                try:
                    new_listblock.append(item)
                except err.FailedValidatorError as e:
                    try:
                        new_listblock.stage_template(template=item)
                    except Exception as e:
                        warnings.append("The following item could not be set to a ListBlock or staged as a template:"
                                        f"\n\nCANDIDATE:\n{item}"
                                        f"\n\nERROR:\n{e}")
            if warnings:
                for w in warnings:
                    warn(w, UserWarning)

_assign_and_inject(name, value, extended=False)

Attaches attributes and methods to any value before assigning it as an attribute of self or self.ext.

Attributes Attached to Object

_parent_block: refers to self

Methods Attached to Object

add_comments_to_parent clear_comments_from_parent

Source code in FoSpy/blocks/blocks.py

def _assign_and_inject(self, name, value, extended=False):
    """
    Attaches attributes and methods to any value before assigning it as an
    attribute of `self` or `self.ext`.

    Attributes Attached to Object:
        `_parent_block`: refers to `self`

    Methods Attached to Object:
        [`add_comments_to_parent`][FoSpy.blocks.blocks._add_comments_to_parent]
        [`clear_comments_from_parent`][FoSpy.blocks.blocks._clear_comments_from_parent]
    """
    from .attachments import Attachment

    if name == 'ext':
        return super().__setattr__('ext', value)
    if not hasattr(value, "__dict__"):
        value = SimpleWrapper(value)

    if extended:
        setattr(self.ext, name, value)
    else:
        super().__setattr__(name, value)

    attr_obj = getattr(self.ext if extended else self, name)

    setattr(attr_obj, "_parent_block", self)

    if isinstance(attr_obj, Attachment):
        attr_obj._get_filepath()
    elif hasattr(attr_obj, "refresh_attachments"):
        attr_obj.refresh_attachments()

    methods = ((_add_comments_to_parent(name), "add_comments"),
            (_clear_comments_from_parent(name), "clear_comments"))

    attr_obj._reserved = ['ext'] if not hasattr(attr_obj,"_reserved") else attr_obj._reserved
    for method, method_name in methods:
        attr_obj._reserved.append(method_name)
        bound = method.__get__(attr_obj, type(attr_obj))
        setattr(attr_obj, method_name, bound)

    self._props_changed = True

_inject_defaults(full_class, blockDict) classmethod

Source code in FoSpy/blocks/template.py

@classmethod
def _inject_defaults(cls, full_class, blockDict):
    from .. import _errors as err

    full_dispatch = getattr(full_class, "__dispatch__", {})

    next_class = None
    while next_class is not full_class:
        if next_class is None:
            next_class = full_dispatch.get("dispatch_from", full_class)
        else:
            registry = next_class.__dispatch__["registry"]
            try:
                next_class = next(sub for sub in registry.values() if issubclass(full_class, sub))
            except StopIteration:
                err.BlockDispatchError(
                    f"Could not find a valid dispatch chain to get from {next_class.__name__} to "
                    f"{full_class.__name__}.")

        blockDict = next_class.inject_defaults(blockDict)


    return blockDict

_meta_to_front()

Moves metadata to the front of _key_order. Metadata will always be serialized first, but being elsewhere in the order leads to unexpected results when moving other keys to desired indices.

Source code in FoSpy/blocks/blocks.py

def _meta_to_front(self):
    """
    Moves metadata to the front of `_key_order`. Metadata will always be
    serialized first, but being elsewhere in the order leads to unexpected
    results when moving other keys to desired indices.
    """
    try:
        meta_idx =self._key_order.index("metadata")
        self._key_order.pop(meta_idx)
    # TODO: Better handling
    except Exception:
        pass
    self._key_order.insert(0,"metadata")

_override_validators(validators)

Source code in FoSpy/blocks/template.py

def _override_validators(self, validators):
    from .blocks import Block
    try:
        rename_dict = self.rename_dict()
    except AttributeError:
        rename_dict = {}

    for field in self._fields:
        if field in rename_dict:
            field = rename_dict[field]

        if field not in validators:
            continue

        val = validators[field]
        if not isinstance(val, type) or not issubclass(val, Block):
            new_val = TemplateField

        elif issubclass(val, SingleBlock):
            new_val = val.TemplateClass()

        elif issubclass(val, ListBlock):
            new_val = TemplateList.Simple(val._reqCls)

        else:
            raise NotImplementedError("Shouldn't happen")

        validators[field] = new_val

    for field in self._val_exceptions:
        validators[field] = FailedTemplateField

    return validators

_rename_validators(validators)

Realigns any renamed attributes with their expected validator.

Parameters:

Name	Type	Description	Default
validators	dict	A dictionary mapping attribute names to validators, returned by either build_validators or build_req_validators	required

Source code in FoSpy/blocks/blocks.py

def _rename_validators(self, validators:dict):
    """
    Realigns any [renamed][FoSpy.blocks.blocks.SingleBlock.rename_block]
    attributes with their expected validator.

    Args:
        validators:
            A dictionary mapping attribute names to validators, returned by
            either
            [`build_validators`][FoSpy.blocks.blocks.SingleBlock.build_validators]
            or
            [`build_req_validators`][FoSpy.blocks.blocks.SingleBlock.build_req_validators]
    """
    if hasattr(self, "rename"):
        for name, rename in self.rename.serialize(shallow=True, clean=True).items():
            if name in validators and rename not in validators:
                val = validators.pop(name)
                validators[rename] = val
    return validators

_resolve_relative_path(path)

Resolves a relative object path string into an object or function.

Example:

    mySyn._resolve_relative_path("materials[1].ratio")
    ## returns mySyn.materials[1].ratio

Source code in FoSpy/blocks/blocks.py

def _resolve_relative_path(self, path: str):
    """
    Resolves a relative object path string into an object or function.

    Example:
    ```
        mySyn._resolve_relative_path("materials[1].ratio")
        ## returns mySyn.materials[1].ratio
    ```
    """
    import re

    _index_re = re.compile(r"^([A-Za-z_]\w*)\[(\d+)\]$")
    obj = self

    for part in path.split("."):

        # Case: attr[index]
        m = _index_re.match(part)
        if m:
            attr_name, idx_str = m.groups()
            idx = int(idx_str)

            # Get the ListBlock
            obj = getattr(obj, attr_name)

            # Index into its _objs
            obj = obj._objs[idx]
            continue

        # Case: simple attribute
        obj = getattr(obj, part)

    return obj

_subprocess(target, args=(), **kwargs)

Source code in FoSpy/blocks/blocks.py

def _subprocess(self, target, args=(), **kwargs):
    from multiprocessing import Process

    if kwargs is None:
        kwargs={}

    p = Process(target=target, args=args, kwargs=kwargs)
    p.start()

_update_src()

Source code in FoSpy/blocks/blocks.py

def _update_src(self):
    if self._constructed and self._props_changed:
        self._sourceDict = self.serialize(clean=True)
        self._props_changed = False

    return self._sourceDict   

add_all_calc_routines(recursive=False)

Schedule all available calculation routines.

Adds all available calc_routines to self._calc_routines using list_avail_routines() and add_calc_routine().

Parameters:

Name	Type	Description	Default
recursive	bool	Optional recursion. See SingleBlock.list_avail_routines()	False

Source code in FoSpy/blocks/blocks.py

def add_all_calc_routines(self, recursive:bool=False):
    """
    Schedule all available calculation routines.

    Adds all available calc_routines to `self._calc_routines` using
    [`list_avail_routines()`][FoSpy.blocks.blocks.SingleBlock.list_avail_routines]
    and
    [`add_calc_routine()`][FoSpy.blocks.blocks.SingleBlock.add_calc_routine].

    Args:
        recursive:
            Optional recursion. See `SingleBlock.list_avail_routines()`
    """
    for path in self.list_avail_routines(recursive=recursive, abbreviated=False):
        self.add_calc_routine(path)

add_block(block_name, type_alias, value=[])

Adds an unexpected attribute with a validator mapped by type_alias. Unexpected attributes not requiring a validator can be set directly without using this method.

Parameters:

Name	Type	Description	Default
block_name	str	new unexpected attribute name	required
type_alias	str	Alias mapped to the desired validator in parsing.validation.aliases. For more information on how aliases are used, see __setattr__.	required

Source code in FoSpy/blocks/blocks.py

def add_block(self, block_name:str, type_alias:str, value=[]):
    """
    Adds an unexpected attribute with a validator mapped by `type_alias`.
    Unexpected attributes not requiring a validator can be set directly
    without using this method.

    Args:
        block_name: new unexpected attribute name
        type_alias:
            Alias mapped to the desired validator in
            [`parsing.validation.aliases`][FoSpy.parsing.validation.aliases].
            For more information on how aliases are used, see
            [`__setattr__`][FoSpy.blocks.blocks.SingleBlock.__setattr__].
    """
    if hasattr(self,block_name):
        raise ValueError(f"This object already has attribute: '{block_name}'.")
    return setattr(self, f"{block_name}${type_alias}", value)

add_calc_comment(key, comment, calc_id)

Add a calculated comment to be injected during serialization.

WARNING: This function can leave outdated calculations in comments after serialization. Recommended to use add_calc_routine() instead.

Calculated comments are for user information and will be formatted to be skipped by the parser when reading the file. This is useful for comments that should be recalculated and refreshed during saving/serialization, like weight percentages or summaries.

Parameters:

Name	Type	Description	Default
key	str	attribute to attach the calculated comment to. Comments appear above their attached attributes in FOS format.	required
comment	str	comment text without comment formatting (don't include // or !)	required
calc_id	str	unique identifier for the calculated comment. If it matches an existing comment (like when refreshing a value), the comment is overwritten	required

Source code in FoSpy/blocks/blocks.py

def add_calc_comment(self, key:str, comment:str, calc_id:str):
    """
    Add a calculated comment to be injected during serialization.

    WARNING: This function can leave outdated calculations in comments after
    serialization. Recommended to use `add_calc_routine()` instead.

    Calculated comments are for user information and will be formatted to be
    skipped by the parser when reading the file. This is useful for comments
    that should be recalculated and refreshed during saving/serialization,
    like weight percentages or summaries.

    Args:
        key:
            attribute to attach the calculated comment to. Comments appear
            above their attached attributes in FOS format.
        comment:
            comment text without comment formatting (don't include // or !)
        calc_id:
            unique identifier for the calculated comment. If it matches an
            existing comment (like when refreshing a value), the comment is
            overwritten

    """
    calc_comments = self._calc_comments.get(key, {})
    self._calc_comments[key] = calc_comments
    self._calc_comments[key][calc_id]=comment

add_calc_routine(path, **kwargs)

Schedules a calculated comment.

Appends a _calc_routine()-decorated function to self._calc_routines to be run at serialization.

Used to add calculated comments that should be refreshed during serialization.

Parameters:

Name	Type	Description	Default
path	str	a relative path string that can be resolved into a _calc_routine()-decorated function	required
**kwargs	any	optional key word arguments to be passed to the function at path.	{}

Raises:

Type	Description
TypeError	the attr or method at path is not registered as a _calc_routine

Example:

    mySyn.add_calc_routine("materials.add_weight_pcts", typ="reagent")
    ## mySyn.materials.add_weight_pcts(typ="reagent") is now scheduled
    ## to run at serialization

Source code in FoSpy/blocks/blocks.py

def add_calc_routine(self, path:str, **kwargs):
    """
    Schedules a calculated comment.

    Appends a
    [`_calc_routine()`][FoSpy.blocks._blockUtils._calc_routine]-decorated
    function to `self._calc_routines` to be run at
    [serialization][FoSpy.blocks.blocks.SingleBlock.serialize].

    Used to add calculated comments that should be refreshed during
    serialization.

    Args:
        path:
            a relative path string that can be resolved into a
            `_calc_routine()`-decorated function
        **kwargs (any):
            optional key word arguments to be passed to the function at
            path.

    Raises:
        TypeError:
            the attr or method at path is not registered as a
            _calc_routine

    Example:
    ```
        mySyn.add_calc_routine("materials.add_weight_pcts", typ="reagent")
        ## mySyn.materials.add_weight_pcts(typ="reagent") is now scheduled
        ## to run at serialization
    ```
    """

    func = self._resolve_relative_path(path)
    if not getattr(func, "_is_calc_routine", False):
        raise TypeError(f"'{path}' is not a registered calc routine.")

    self._meta.routine_paths.append(path)

    def wrapped(f=func, k=kwargs):
        return f(**k)

    self._calc_routines.append(wrapped)

add_comments(*comments)

Default behavior to be overwritten when attached to a parent block.

If a SingleBlock is stored as an attribute of another SingleBlock, this method will be overwritten by the parent's __setattr__.

Source code in FoSpy/blocks/blocks.py

def add_comments(self, *comments):
    """
    Default behavior to be overwritten when attached to a parent block.

    If a `SingleBlock` is stored as an attribute of another `SingleBlock`,
    this method will be overwritten by the parent's `__setattr__`.
    """
    keys = list(self.get_req_validators())

    keys = [k for k in keys if k != "metadata"]
    fallback = [k for k in self._key_order if k != "metadata"]
    if not (keys or fallback):
        raise ValueError("This object has not been correctly attached to a parent block "
                         "and could not identify a required key to attach to.")

    first = keys[0] if keys else fallback[0]

    self._meta.comments.setdefault(first, [])
    for comment in comments:
        self._meta.comments[first].append(comment)

add_dispatch(blockDict, dispatch_key, _wrapped=False, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def add_dispatch(cls, blockDict, dispatch_key, _wrapped=False, **kwargs):
    if _wrapped:
        # subclasses may want to mutate blockDict
        return {}

    raise Exception("add_dispatch should only be called by a decorated dispatch_subclass method.")

build_req_validators() classmethod

Builds required keys and validators mapped to subclass.

Walks all parent classes and builds a map of all keys that are required during __init__, and their respective validation routines. Subclasses are mapped to expected keys and validations in parsing.validation. Subclass validations override parent classes when applicable.

Returns:

Name	Type	Description
merged	dict	Maps required keys to validation routines. Routines may be a class constructor or a func taking one arg.

Example:

>>> SingleBlock.build_req_validators()
{
    "name": str,
    "type": str,
    "formula": ChemFormula, # class constructor
    "supplier": str,
    "cas": str,
    "form": str,
    "env": str,
    "ratio": validators.material.ratio # validator function
}

Source code in FoSpy/blocks/blocks.py

@classmethod
def build_req_validators(cls):
    """
    Builds required keys and validators mapped to subclass.

    Walks all parent classes and builds a map of all keys that are required
    during `__init__`, and their respective validation routines. Subclasses
    are mapped to expected keys and validations in
    [`parsing.validation`][FoSpy.parsing.validation]. Subclass validations
    override parent classes when applicable.

    Returns:
        merged (dict):
            Maps required keys to validation routines. Routines may be
            a class constructor or a func taking one arg.
    Example:
        ``` 
        >>> SingleBlock.build_req_validators()
        {
            "name": str,
            "type": str,
            "formula": ChemFormula, # class constructor
            "supplier": str,
            "cas": str,
            "form": str,
            "env": str,
            "ratio": validators.material.ratio # validator function
        }
        ```
    """
    from ..parsing.validation import required_keys
    from ._blockUtils import _get_prop_mro, _merge_vals
    merged = {}
    # mro = list(reversed(cls.__mro__))
    # for i, base in enumerate(mro):
    #     base_reqs = required_keys.get(base,{})
    #     for key, validator in base_reqs.items():
    #         # allow subclasses to remove parent requirements.
    #         if not validator:
    #             merged.pop(key, None)
    #         else:
    #             merged[key] = validator

    req_mro = _get_prop_mro(cls, required_keys)
    for i in range(len(req_mro)):
        merged = _merge_vals(merged, req_mro, i)

    merged.pop("__all__")

    return merged

build_validators() classmethod

Builds expected keys and validators mapped to subclass.

Walks all parent classes and builds a map of all keys that are expected (required or optional), and their respective validation routines. Subclasses are mapped to keys and validations in parsing.validation. Subclass validations override parent classes when applicable.

See build_req_validators

Source code in FoSpy/blocks/blocks.py

@classmethod
def build_validators(cls):
    """
    Builds expected keys and validators mapped to subclass.

    Walks all parent classes and builds a map of all keys that are expected
    (required or optional), and their respective validation routines.
    Subclasses are mapped to keys and validations in
    [`parsing.validation`][FoSpy.parsing.validation]. Subclass validations
    override parent classes when applicable.

    See
    [`build_req_validators`][FoSpy.blocks.blocks.SingleBlock.build_req_validators]
    """
    from ..parsing.validation import required_keys, optional_keys
    from ._blockUtils import _merge_vals, _get_prop_mro
    from .._docs.properties import _validator_rules
    merged = {}
    # for base in reversed(cls.__mro__):
    #     for key_set in (required_keys, optional_keys):
    #         base_reqs = key_set.get(base,{})
    #         for key, validator in base_reqs.items():
    #             # allow subclasses to remove parent requirements.
    #             if validator is False:
    #                 merged.pop(key, None)
    #             else:
    #                 merged[key] = validator
    req_mro = _get_prop_mro(cls, required_keys)
    opt_mro = _get_prop_mro(cls, optional_keys)

    for i in range(len(req_mro)): # req_mro and opt_mro are the same length
        merged = _merge_vals(merged, req_mro, i)
        merged = _merge_vals(merged, opt_mro, i)

    universal_val = merged.pop("__all__")

    @_validator_rules(inherit_from=universal_val)
    def universal_val_method(cls, *_, _m=universal_val, **__):
        return _m(*_, **__)

    cls.universal_val = universal_val_method

    return merged

clear_all_comments()

Source code in FoSpy/blocks/blocks.py

def clear_all_comments(self):
    self._meta.comments = {}
    for attr, val in self.__dict__.items():
        if attr.startswith("_") or attr in self._reserved:
            continue
        if hasattr(val, "clear_all_comments"):
            val.clear_all_comments()

clear_comments()

Clear comments attached to top-level attributes only.

Source code in FoSpy/blocks/blocks.py

def clear_comments(self):
    """
    Clear comments attached to top-level attributes only.
    """
    self._meta.comments = {}

copy()

Returns a deep-copy of self by serializing and reconstructing.

_calc_comments are not preserved during copy, but _calc_routines are. This prevents mutation of the comments when reconstructing.

Source code in FoSpy/blocks/blocks.py

def copy(self):
    """
    Returns a deep-copy of `self` by serializing and reconstructing.

    _calc_comments are not preserved during copy, but _calc_routines are.
    This prevents mutation of the comments when reconstructing.
    """
    cls = type(self)
    # cache calculated comments before serializing
    c_cmts = self._calc_comments.copy()

    serial = self.serialize(keepListType=True)

    new_obj =  cls(serial)

    # restore cached calc comments
    self._calc_comments = c_cmts

    return new_obj

default_key_order(deep=False)

Set to default attribute order for serialization.

Rearrange attribute order to the default order assigned by build_validators

Parameters:

Name	Type	Description	Default
deep	bool	When true, recursively calls default_key_order on any other SingleBlock objects stored in attributes.	False

Source code in FoSpy/blocks/blocks.py

def default_key_order(self, deep:bool=False):
    """
    Set to default attribute order for serialization.

    Rearrange attribute order to the default order assigned by
    [`build_validators`][FoSpy.blocks.blocks.SingleBlock.build_validators]

    Args:
        deep:
            When true, recursively calls `default_key_order` on any other
            `SingleBlock` objects stored in attributes.
    """
    new_order = []
    for key in self.get_validators():
        if key != "ext" and key in self.serialize(shallow=True):
            new_order.append(key)
    for key in self._key_order:
        if key not in new_order:
            new_order.append(key)
    self._key_order = new_order
    self._meta_to_front()

    if deep:
        for name, obj in self.__dict__.items():
            if not name.startswith("_") and hasattr(obj, "default_key_order"):
                obj.default_key_order(deep=True)

dispatch_subclass(*args, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def dispatch_subclass(cls, *args, **kwargs):
    # fallback.
    # overridden by setup_dispatch decorator
    return cls

dispatcher(dispatch_method) staticmethod

Decorate a classmethod to dispatch to other subclasses.

Not normally used directly. See setup_dispatch decorator.

Source code in FoSpy/blocks/blocks.py

@staticmethod
def dispatcher(dispatch_method: Callable[..., dict])->classmethod:
    """
    Decorate a classmethod to dispatch to other subclasses.

    Not normally used directly. See
    [`setup_dispatch`][FoSpy.blocks.blocks.SingleBlock.setup_dispatch]
    decorator.
    """

    @classmethod
    def dispatch_subclass(cls:type[BlockType], blockDict, _add_defaults=False, **kwargs):
        from .. import _errors as err
        for_template = kwargs.get("for_template", False)

        block_dispatch = blockDict.setdefault("__dispatch__", {})
        visited = block_dispatch.setdefault("visited", [])
        cls_dispatch = getattr(cls, "__dispatch__", None)
        # shorthand for keying dispatch parameters
        d=cls_dispatch

        if d['dispatch_from'] in visited and (
            cls in visited or
            d is None or
            d['from_key'] is None):
            return cls
        try:
            blockDict = dispatch_method(cls, blockDict, add_defaults=_add_defaults, **kwargs)
        except Exception as e:
            if not for_template:
                raise e

        visited.append(cls)

        if d['dispatch_from'] not in visited:
            blockDict.pop("__dispatch__", None)
            return d['dispatch_from'].dispatch_subclass(blockDict, _add_defaults=_add_defaults, **kwargs)


        dispatch_val = block_dispatch.get(d['from_key'],
                            blockDict.get(d['from_key'], None))

        dispatched_cls = d['registry'].get(dispatch_val, d['registry'].get(None, cls))

        if dispatched_cls is cls and not d['allow_self']:
            if not for_template:
                raise err.BlockDispatchError(
                    f"The following blockDict was dispatched to {cls.__name__} "
                    "but could not be dispatched further. "
                    f"{cls.__name__} blocks are not allowed without a subclass.")
            return cls

        return dispatched_cls.dispatch_subclass(blockDict, **kwargs)
    return dispatch_subclass

fill(incomplete=False, staged=False, in_place=False, **kwargs)

Source code in FoSpy/blocks/template.py

def fill(self,incomplete=False,staged=False,in_place=False,**kwargs):
    if not self._full_class is not None and issubclass(self._full_class, SingleBlock):
        raise TypeError("A Template Block must be initialized from an existing class in order to be filled.")

    for prop in self._staged_templates:
        self.fill_staged_template(prop)

    staged_id = self.find_staged_id()
    if staged_id and not staged:
        _, filled = self._staged_parent.fill_staged_template(staged_id, **kwargs)
        return filled

    serial = self.serialize(keepListType=True)
    for kw, arg in kwargs.items():
        serial[kw] = arg

    flex_cls = self._full_class.TemplateClass()

    try:
        filled = self._full_class(serial)
    except Exception as e:
        filled = flex_cls(serial)

    return filled

fill_staged_template(prop_name, **kwargs)

Source code in FoSpy/blocks/blocks.py

def fill_staged_template(self, prop_name, **kwargs):
    from .template import TemplateBlock

    prop_key = prop_name.split("$")[0] if "$" in prop_name else prop_name

    template = self._staged_templates.pop(prop_key, None)
    if template is None:
        prop_name, _ = self.stage_template(prop_name)
        return self.fill_staged_template(prop_name, **kwargs)

    prop_name = prop_key

    filled = template.fill(staged=True,**kwargs)

    if isinstance(filled, TemplateBlock):
        return self.stage_template(prop_name, filled)

    try:
        setattr(self, prop_name, filled)
    except Exception as e:
        raise Exception(f"Template was filled but could not be assigned {prop_name}") from e

    filled = getattr(self, prop_name)

    if isinstance(self, TemplateBlock):
        self.fill()

    return prop_name, filled

find_attachments()

Source code in FoSpy/blocks/blocks.py

def find_attachments(self):
    attachments = []
    for propVal in self.get_prop_dict().values():
        if isinstance(propVal, ListBlock):
            for obj in propVal._objs:
                attachments.extend([
                    o for o in obj.find_attachments()
                    if o not in attachments
                ])
        elif isinstance(propVal, SingleBlock):
            attachments.extend([
                o for o in propVal.find_attachments()
                if o not in attachments
            ])
    return attachments

find_fileblock()

Finds the parent file object.

Walks upward through _parent_block attributes until a FileBlock instance is found and returns that instance.

Source code in FoSpy/blocks/blocks.py

def find_fileblock(self):
    """
    Finds the parent file object.

    Walks upward through `_parent_block` attributes until a
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance is found and
    returns that instance.
    """
    from .files import FileBlock
    from .._errors import FileBlockNotFoundError

    blk = self
    while blk is not None:
        if isinstance(blk, FileBlock):
            return blk
        if hasattr(blk,"_parent_block"):
            blk = blk._parent_block
        else:
            blk = None
    raise FileBlockNotFoundError("Could not find a FileBlock containing the current object")

find_staged_id()

Source code in FoSpy/blocks/template.py

def find_staged_id(self):
    if not (hasattr(self, "_staged_parent")
            and self._staged_parent.has_staged()):
        return False

    staged_dict = self._staged_parent._staged_templates
    staged_reversed = {v:k for k,v in staged_dict.items()}

    return staged_reversed.get(self, False)

find_tempdir()

Find the parent file object's temporary directory.

Finds the temporary directory created by the FileBlock instance containing this block as one of its attributes.

Returns:

Name	Type	Description
tempdir	tempfile.TemporaryDirectory	The temporary directory created by the parent file object

Source code in FoSpy/blocks/blocks.py

def find_tempdir(self):
    """
    Find the parent file object's temporary directory.

    Finds the temporary directory created by the
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance containing this
    block as one of its attributes. 

    Returns:
        tempdir (tempfile.TemporaryDirectory):
            The temporary directory created by the parent file object
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_tempdir"):
        return fileblock._tempdir
    else:
        raise AttributeError("Could not find a temporary directory attached to this object's FileBlock")

find_temppath()

Find the parent file object's temporary directory path.

Similar to find_tempdir but returns the corresponding pathlib.Path object instead.

Source code in FoSpy/blocks/blocks.py

def find_temppath(self):
    """
    Find the parent file object's temporary directory path.

    Similar to [`find_tempdir`][FoSpy.blocks.blocks.Block.find_tempdir] but
    returns the corresponding `pathlib.Path` object instead.
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_temppath"):
        return fileblock._temppath
    if hasattr(fileblock, "_temppdir"):
        raise AttributeError("This object's FileBlock has a temporary directory but no path mapped to it. "
                             "Use obj.find_tempdir() instead")
    raise AttributeError("Could not find a temporary directory object or path "
                         "attached to this object's FileBlock.")

get_id()

Returns an easily recognizable identifier for self. Non-unique.

Source code in FoSpy/blocks/blocks.py

def get_id(self):
    """Returns an easily recognizable identifier for self. Non-unique."""
    id_txt = str(getattr(self, self._id_key)) if self._id_key is not None else type(self).__name__
    return self._id_key, id_txt

get_parent_prop()

Source code in FoSpy/blocks/blocks.py

def get_parent_prop(self):
    if not hasattr(self, "_parent_block"):
        return None
    parent_blk = self._parent_block

    if isinstance(parent_blk, SingleBlock):
        for prop, val in parent_blk.get_prop_dict().items():
            if val is self:
                return prop

        raise err.FoSpyStructureError(f"Block {self} points to a parent block {parent_blk} that does not contain it as a property.")

    elif isinstance(parent_blk, ListBlock):
        return f"[{parent_blk.get_idx(self)}]"

    raise err.FoSpyStructureError(f"Block {self} has an unknown parent block type: {type(parent_blk)}")

get_prop_dict()

Returns a dictionary mapping property names to their live object values.

Source code in FoSpy/blocks/blocks.py

def get_prop_dict(self):
    """Returns a dictionary mapping property names to their live object values."""
    serial = self.serialize(shallow=True, clean=True)
    out = {}
    for prop in serial:
        if "$" in prop:
            prop = prop.split("$")[0]

        # guard for when templateblocks add staged templates to their serial
        if hasattr(self, prop):
            out[prop] = getattr(self, prop)

    return out

get_prop_path()

Source code in FoSpy/blocks/blocks.py

def get_prop_path(self):
    from .files import FileBlock

    if not hasattr(self, "_parent_block"):
        if isinstance(self, FileBlock):
            root_path = f"<{str(self.get_file_name())}>"
        else:
            root_path = f"<Root {type(self).__name__}"
            if isinstance(self, SingleBlock):
                id_key, id_txt = self.get_id()
                if id_key is not None:
                    root_path += f" ({id_key}={id_txt})"
            root_path += ">"
        return root_path

    parent_path = self._parent_block.get_prop_path()
    parent_prop = self.get_parent_prop()

    if "[" not in parent_prop:
        return parent_path + "." + parent_prop

    return parent_path + parent_prop

get_req_validators()

Source code in FoSpy/blocks/template.py

def get_req_validators(self):
    validators = super().get_req_validators()

    return self._override_validators(validators)

get_validators()

Source code in FoSpy/blocks/template.py

def get_validators(self):
    validators = super().get_validators()

    return self._override_validators(validators)

has_staged()

Source code in FoSpy/blocks/blocks.py

def has_staged(self):
    if len(self._staged_templates) > 0:
        return True

    for val in self.get_prop_dict().values():
        if hasattr(val, "has_staged") and val.has_staged():
            return True

    return False

inject_defaults(blockDict, *args, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def inject_defaults(cls, blockDict, *args, **kwargs):
    # fallback.
    # overridden by setup_dispatch decorator
    return blockDict

inspect() classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def inspect(self):
    # for breaking to debugger from gui
    raise Exception("put a break point here")

key_to_idx(key, idx)

Reorder attributes for serialization.

Move any attribute name to a specific index in _key_order for serialization order. The invisible "metadata" key is always refreshed to the front of the list, so indices are effectively 1-based.

Parameters:

Name	Type	Description	Default
key	str	name of attribute to reorder	required
idx	int	new index in _key_order	required

Source code in FoSpy/blocks/blocks.py

def key_to_idx(self, key:str, idx:int):
    """
    Reorder attributes for serialization.

    Move any attribute name to a specific index in `_key_order` for
    serialization order. The invisible `"metadata"` key is always refreshed
    to the front of the list, so indices are effectively 1-based.

    Args:
        key: name of attribute to reorder
        idx: new index in _key_order
    """
    self._meta_to_front()
    try:
        old_idx = self._key_order.index(key)
        self._key_order.pop(old_idx)
    # TODO: Better handling
    except Exception:
        pass
    self._key_order.insert(idx, key)

keys_to_end(*args)

Reorder attributes for serialization.

Move any attribute names in *args to the end of _key_order to be serialized last. Order within *args is maintained in result.

Source code in FoSpy/blocks/blocks.py

def keys_to_end(self, *args):
    """
    Reorder attributes for serialization.

    Move any attribute names in `*args` to the end of _key_order to be
    serialized last. Order within `*args` is maintained in result.
    """
    def remove_alias(key):
        return key.split("$")[0] if "$" in key else key
    for key in self.serialize(shallow=True):
        if not key.startswith("_") and remove_alias(key) not in self._key_order:
            self._key_order.append(remove_alias(key))
    for key in args:
        try:
            idx = self._key_order.index(key)
            self._key_order.pop(idx)
        # TODO: Better handling
        except Exception:
            pass
        self._key_order.append(key)
    self._meta_to_front()

keys_to_front(*args)

Reorder attributes for serialization.

Move any attribute names in *args to the front of _key_order to be serialized first. Order within *args is maintained in result.

Source code in FoSpy/blocks/blocks.py

def keys_to_front(self,*args):
    """
    Reorder attributes for serialization.

    Move any attribute names in `*args` to the front of _key_order to be
    serialized first. Order within `*args` is maintained in result.
    """
    try:
        meta_idx = args.index("metadata")
        args.pop(meta_idx)
    # TODO: Better handling
    except Exception:
        pass

    new_order = []
    for key in args:
        new_order.append(key)
    for key in self._key_order:
        if key not in new_order:
            new_order.append(key)
    self._key_order = new_order
    self._meta_to_front()

list_avail_routines(recursive=False, prefix='', abbreviated=False)

Lists all calc routines available to be added to self._calc_routines.

Non-abbreviated calc routine strings can be passed directly to self.add_calc_routine()

Parameters:

Name	Type	Description	Default
recursive	bool	If True, recursively walks all attributes and appends results from self.attr.list_avail_routines() to result. Otherwise only identifies methods of self.	False
prefix	str	Used during recursion to build relative paths	''
abbreviated	bool	optionally abbreviate recursively repeated routines for similar objects into one line. This line cannot be passed to self.add_calc_routine()	False

Returns:

Name	Type	Description
routines	list	list of strings describing _calc_routine-decorated methods. Non-abbreviated calc routine strings can be passed directly to self.add_calc_routine()

Example:

    mySyn.list_avail_routines()
    ## returns []
    mySyn.list_avail_routines(recursive=True)
    ## returns [
    ##     'reaction.add_nom_MW',
    ##     'materials.add_weight_pcts',
    ##     'materials[0].add_MW',
    ##     'materials[1].add_MW',
    ##     ... 6 total materials with the same calc_routine
    ##     'materials[5].add_MW'
    ## ]
    mySyn.list_avail_routines(recursive=True, abbreviated=True)
    ## returns [
    ##     'reaction.add_nom_MW',
    ##     'materials.add_weight_pcts',
    ##     'materials[i].add_MW; i = [0, 1, 2, 3, 4, 5]'
    ## ]

Source code in FoSpy/blocks/blocks.py

def list_avail_routines(self, recursive:bool=False, prefix:str="", abbreviated:bool=False):
    """
    Lists all calc routines available to be added to `self._calc_routines`.

    Non-abbreviated calc routine strings can be passed directly to
    `self.add_calc_routine()`

    Args:
        recursive:
            If True, recursively walks all attributes and appends results
            from `self.attr.list_avail_routines()` to result. Otherwise only
            identifies methods of `self`.

        prefix: Used during recursion to build relative paths
        abbreviated:
            optionally abbreviate recursively repeated routines for similar
            objects into one line. This line cannot be passed to
            `self.add_calc_routine()`

    Returns:
        routines (list): 
            list of strings describing _calc_routine-decorated methods.
            Non-abbreviated calc routine strings can be passed directly to
            `self.add_calc_routine()`

    Example:
    ```
        mySyn.list_avail_routines()
        ## returns []
        mySyn.list_avail_routines(recursive=True)
        ## returns [
        ##     'reaction.add_nom_MW',
        ##     'materials.add_weight_pcts',
        ##     'materials[0].add_MW',
        ##     'materials[1].add_MW',
        ##     ... 6 total materials with the same calc_routine
        ##     'materials[5].add_MW'
        ## ]
        mySyn.list_avail_routines(recursive=True, abbreviated=True)
        ## returns [
        ##     'reaction.add_nom_MW',
        ##     'materials.add_weight_pcts',
        ##     'materials[i].add_MW; i = [0, 1, 2, 3, 4, 5]'
        ## ]
    ```
    """
    routines = []

    # Local routines
    for name in dir(self):
        attr = getattr(self, name)
        if callable(attr) and getattr(attr, "_is_calc_routine", False):
            routines.append(prefix + name)

    if recursive:
        for attr, val in self.__dict__.items():
            if attr.startswith("_"):
                continue

            # Recurse into child blocks
            if hasattr(val, "list_avail_routines"):
                child_prefix = f"{prefix}{attr}."
                routines.extend(val.list_avail_routines(True, child_prefix, abbreviated))

    return routines

make_template(template_name, *args)

Converts self into a template of its original subclass.

Returns a copy of self as a template of its original subclass, with specified fields replaced with template types. See TemplateClass for more information on template generation.

Parameters:

Name	Type	Description	Default
template_name	str	All templates require an identifying name.	required
*args	str	properties to clear and replace with template types.	()

Source code in FoSpy/blocks/blocks.py

def make_template(self,template_name:str,*args:str):
    """
    Converts `self` into a template of its original subclass.

    Returns a copy of `self` as a template of its original subclass, with
    specified fields replaced with template types. See
    [`TemplateClass`][FoSpy.blocks.blocks.SingleBlock.TemplateClass] for
    more information on template generation.

    Args:
        template_name: All templates require an identifying name.
        *args: properties to clear and replace with template types.
    """

    from ..parsing.format_fos import format_field

    serial = self.serialize(keepListType=True)
    validators = self.get_validators()
    for key in args:
        val = validators.get(key, None)
        if isinstance(val,type) and (issubclass(val, SingleBlock) or issubclass(val, ListBlock)):
            serial.setdefault(key, [{}])
        else:
            serial[key] = format_field("template")
    serial["template_name"] = template_name
    return self.TemplateClass(*args)(serial)

print_summary(mode='cli') classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def print_summary(cls, mode="cli"):
    from .._docs.properties import get_summary

    print(get_summary(cls, mode=mode))

reflex(serialize=True, include_temp_names=True, clean=False, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def reflex(cls, serialize=True, include_temp_names=True, clean=False, **kwargs):
    """

    """
    kwargs.setdefault("template_name", f"Reflexed {cls.__name__}")

    reflexor = cls.TemplateClass()

    empty = reflexor(kwargs)

    if not serialize:
        return empty

    serial = empty.serialize(clean=clean)

    if include_temp_names:
        return serial

    from ._blockUtils import _prune_template_names
    serial = _prune_template_names(serial)
    return serial

refresh_attachments(new_copy=None, overwrite=None, **kwargs)

Source code in FoSpy/blocks/blocks.py

def refresh_attachments(self, new_copy=None, overwrite=None, **kwargs):
    from .attachments import Attachment

    if new_copy is None:
        new_copy = self._att_new_copy
    if overwrite is None:
        overwrite = self._att_overwrite

    for propDict in self.__dict__, self.ext.__dict__:
        for key, val in propDict.items():
            if key.startswith("_") or key in self._reserved:
                continue
            if hasattr(val, "refresh_attachments"):
                val.refresh_attachments(new_copy=new_copy, overwrite=overwrite, **kwargs)
            elif isinstance(val, Attachment) and hasattr(val, "refresh"):
                val.refresh(new_copy=new_copy, overwrite=overwrite, **kwargs)

register_dispatch(registry_val, from_parent=None, setup_from_key=None, setup_allow_self=True, inherit_dispatch=False, defaults=None) classmethod

Decorate a subclass to be dispatched from a parent class.

The subclass will also be decorated with the parent's setup_dispatch to set up its own dispatch parameters.

Parameters:

Name	Type	Description	Default
registry_val		The value to be found in a dispatched blockDict which will be mapped to the subclass in the parent class's registry.	required
from_parent	type[BlockType]	The parent class to register the subclass to. Defaults to the class which calls the method, but may be overridden if a non-SingleBlock abstract class is the parent.	None
setup_from_key		Passed as from_key to the parents setup_dispatch decorator.	None
setup_allow_self		Passed as allow_self to the parent's setup_dispatch decorator.	True
inherit_dispatch		Whether the decorated class should inherit its parent's add_dispatch method	False
defaults	dict	Default values that should be injected into the blockDict when trying to guarantee dispatching to the registered class. Defaults to {}. If parent's from_key is public, defaults will be updated with {from_key: registry_val}	None

Source code in FoSpy/blocks/blocks.py

@classmethod
def register_dispatch(cls, registry_val,
                      from_parent:type[BlockType]=None,
                      setup_from_key=None,
                      setup_allow_self=True,
                      inherit_dispatch=False,
                      defaults:dict=None):
    """
    Decorate a subclass to be dispatched from a parent class.

    The subclass will also be decorated with the parent's
    [setup_dispatch][FoSpy.blocks.blocks.SingleBlock.setup_dispatch] to set
    up its own dispatch parameters.

    Args:
        registry_val:
            The value to be found in a dispatched blockDict which will be
            mapped to the subclass in the parent class's registry.

        from_parent:
            The parent class to register the subclass to. Defaults to the
            class which calls the method, but may be overridden if a
            non-SingleBlock abstract class is the parent.

        setup_from_key:
            Passed as from_key to the parents setup_dispatch decorator.

        setup_allow_self:
            Passed as allow_self to the parent's setup_dispatch decorator.

        inherit_dispatch:
            Whether the decorated class should inherit its parent's
            `add_dispatch` method

        defaults:
            Default values that should be injected into the blockDict when
            trying to guarantee dispatching to the registered class.
            Defaults to {}. If parent's from_key is public, defaults will be
            updated with `{from_key: registry_val}`
    """
    setup = {
        "from_key": setup_from_key,
        "allow_self": setup_allow_self,
        "_defaults": defaults or {}
    }
    from_parent = from_parent or cls
    def decorator(subcls, _val=registry_val, _p=from_parent, _cls=cls, _s=setup):
        if "__dispatch__" not in _p.__dict__:
            raise Exception("You cannot register a subclass to a class that "
            f"hasn't been decorated with @setup_dispatch() or @register_dispatch() ({_p.__name__})")

        dispatch_key = _p.__dispatch__["from_key"]
        if not dispatch_key.startswith("_"):
            _s["_defaults"][dispatch_key] = _val


        _s["_dispatch_from"] = _p.__dispatch__["dispatch_from"]

        subcls = cls.setup_dispatch(subcls, **_s)
        registry = _p.__dispatch__["registry"]

        registry[registry_val] = subcls

        if not inherit_dispatch and "add_dispatch" not in subcls.__dict__:
            subcls.add_dispatch = SingleBlock.add_dispatch

        return subcls
    return decorator

rename_block(old, new)

Source code in FoSpy/blocks/blocks.py

def rename_block(self, old, new):
    validators = self.get_validators()
    req = self.get_req_validators()
    if any(name.startswith("_") for name in (old, new)):
        raise ValueError("You cannot set private attributes (starting with '_') using obj.rename_block()")

    if old in req and new in validators:
        raise ValueError(f"You cannot rename '{old}' to '{new}'. '{old}' is a required property that "
                            f"can only be renamed to an unregistered key; '{new}' is already registered "
                            "as an expected property.")

    if hasattr(self, new):
        raise ValueError(f"'{new}' is already a property for this object, you cannot overwrite it with "
                         "obj.rename_block()")

    if "rename" in (old, new):
        raise ValueError("obj.rename property cannot be set or changed by obj.rename_block()")

    if hasattr(self, "rename") and hasattr(self.rename, old):
        old = getattr(self.rename, old)()

    if old in self._key_overrides:
        val = self._key_overrides.pop(old)
        self._key_overrides[new] = val

    else:
        if not hasattr(self,"rename"):
            self.rename = {}

        rename_dict = self.rename_dict()
        rename_from = {v:k for k,v in rename_dict.items()}
        if old in rename_from:
            base = rename_from[old]
        else:
            base = old

        _debug.msg(f"Registering '{base}':'{new}' into rename block")
        setattr(self.rename, base, new)
    _debug.msg(f"Moving '{old}' over to '{new}'.")
    setattr(self,new,getattr(self, old))
    delattr(self,old)

    try:
        idx = self._key_order.index(old)
        self._key_order[idx] = new
    # TODO: Better handling
    except Exception:
        self._key_order.append(new)

rename_dict()

Source code in FoSpy/blocks/blocks.py

def rename_dict(self):
    if not hasattr(self, "rename"):
        return {}
    return self.rename.serialize(shallow=True, clean=True)

serialize(keepListType=False, shallow=False, clean=False, **kwargs)

Source code in FoSpy/blocks/template.py

def serialize(self,keepListType=False, shallow=False, clean=False, **kwargs):
    # from ..parsing.validation import required_keys
    # from ..parsing.format_fos import format_field
    required = self.get_req_validators()
    required.pop('ext',None)
    required.pop('template_name',None)
    serial = super().serialize(keepListType=keepListType, shallow=shallow, clean=clean)

    out = {"template_name":serial.pop("template_name","")}

    for key, staged in self._staged_templates.items():
        serial.setdefault(key, staged.serialize(keepListType=keepListType, shallow=shallow, clean=clean))

    for key,validator in required.items():
        val = None
        if isinstance(validator,type):
            if issubclass(validator,SingleBlock):
                val = serial.pop(key, validator.reflex())
            elif issubclass(validator, ListBlock):
                val = serial.pop(key, validator([]).serialize())

        if val is None:
            val = serial.pop(key, TemplateField("").serialize())

        out[key] = val

    for key, val in serial.items():
        out[key] = val

    return out

set_dispatch(value=None, from_parent=None, from_key=None, allow_self=None) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def set_dispatch(cls, value=None, from_parent=None, from_key=None, allow_self=None):

    # Abstract classes are sometimes made without SingleBlock in MRO
    if from_parent is not None:
        target_cls = from_parent
    else:
        target_cls = cls

    if "dispatch" not in target_cls.__dict__:
        target_cls.dispatch = {}

    if from_key is not None:
        target_cls.dispatch_key = from_key

    if allow_self is not None:
        target_cls.dispatch_allow_self = allow_self

    def dispatched_cls(subcls, v=value, _cls=target_cls):
        subcls.dispatch_from = _cls
        _cls.dispatch[v] = subcls
        return subcls
    return dispatched_cls

setup_dispatch(from_key=None, allow_self=True, _dispatch_from=None, _defaults={}) staticmethod

Decorate a class to dispatch to other classes during construction.

The decorated class's add_dispatch method will be wrapped into a new method, dispatch_subclass, which is decorator as a dispatcher. The parent class's from_key is found in the blockDict passed to the constructor, and the value mapped to from_key is mapped to dispatchable subclasses in the registry.

add_dispatch returns a dictionary of values that are injected into the blockDict, either to be detected by dispatch, or to be delegated to the constructor.

This decorator should only be used directly for the start of a dispatch chain. For later dispatches, use register_dispatch

Parameters:

Name	Type	Description	Default
cls	SingleBlock subclass	The class to be decorated. If provided, the decorator is most likely being called as a bare decorator. Otherwise, the decorators is being called with other keyword arguments and returns the modified decorator.	None
from_key	str	The key to be located in the blockDict after optional injection by add_dispatch. Private from_keys will be injected and located under the __dispatch__ key which is popped before final construction.	None
allow_self	bool	When True, the decorated class will dispatch to itself if no subclasses can be found. When False, error is raised during construction if dispatchable subclass is not found.	True
_dispatch_from	SingleBlock subclass	To be passed only by register_dispatch, which decorates subclasses to populate this class's registry. Identifies the parent class that the constructor must start at. If not provided, the decorated class is assumed to be the start of a dispatch chain.	None
_defaults	dict	To be passed only by register_dispatch, which decorates subclasses to populat this class's registry. Provides default values that should be injected into the blockDict when trying to guarantee dispatching to the decorated class (usually by a template constructor).	{}

Source code in FoSpy/blocks/blocks.py

@staticmethod
def setup_dispatch(cls:type[BlockType]=None,
    from_key=None,
    allow_self=True,
    _dispatch_from=None,
    _defaults={}
):
    """
    Decorate a class to dispatch to other classes during construction.

    The decorated class's [`add_dispatch`
    method][FoSpy.blocks.blocks.SingleBlock.add_dispatch] will be wrapped
    into a new method,
    [`dispatch_subclass`][FoSpy.blocks.blocks.SingleBlock.dispatch_subclass],
    which is decorator as a
    [`dispatcher`][FoSpy.blocks.blocks.SingleBlock.dispatcher]. The parent
    class's `from_key` is found in the blockDict passed to the constructor,
    and the value mapped to `from_key` is mapped to dispatchable subclasses
    in the `registry`.

    `add_dispatch` returns a dictionary of values that are injected into the
    blockDict, either to be detected by dispatch, or to be delegated to the
    constructor.

    This decorator should only be used directly for the start of a dispatch
    chain. For later dispatches, use
    [`register_dispatch`][FoSpy.blocks.blocks.SingleBlock.register_dispatch]

    Args:
        cls (SingleBlock subclass):
            The class to be decorated. If provided, the decorator is most
            likely being called as a bare decorator. Otherwise, the
            decorators is being called with other keyword arguments and
            returns the modified decorator.

        from_key (str):
            The key to be located in the blockDict after optional injection
            by `add_dispatch`. Private `from_key`s will be injected and
            located under the `__dispatch__` key which is popped before
            final construction.

        allow_self (bool):
            When True, the decorated class will dispatch to itself if no
            subclasses can be found. When False, error is raised during
            construction if dispatchable subclass is not found.

        _dispatch_from (SingleBlock subclass):
            To be passed only by `register_dispatch`, which decorates
            subclasses to populate this class's registry. Identifies the
            parent class that the constructor must start at. If not
            provided, the decorated class is assumed to be the start of a
            dispatch chain. 
        _defaults (dict):
            To be passed only by `register_dispatch`, which decorates
            subclasses to populat this class's registry. Provides default
            values that should be injected into the blockDict when trying to
            guarantee dispatching to the decorated class (usually by a
            template constructor).
        """
    if cls is not None and not isinstance(cls, type):
        raise Exception("@setup_dispatch must be used as a bare decorator, or with "
                        "a class as the first positional argument. You may have tried "
                        "to decorate a class with positional args instead of keywords.")

    def decorator(_cls:type[BlockType], _fk=from_key, _as=allow_self, _df=_dispatch_from, _def=_defaults):
        _cls.__dispatch__ = {
            "from_key": _fk,
            "allow_self": _as,
            "dispatch_from": _df or _cls,
            "registry": {}
        }

        def inject(bD, k, v, is_default=False):
            target_dict = bD["__dispatch__"] if k.startswith("_") else bD

            if is_default and v is None and k in target_dict:
                return bD

            target_dict[k] = v

            return bD

        @classmethod
        def inject_defaults(current_cls, blockDict, _d=_def):
            d = current_cls.__dispatch__
            blk_d = blockDict.setdefault("__dispatch__", {})
            if (not d['allow_self'] and
                None not in d['registry'] and
                blockDict.get(d['from_key'],blk_d.get(d['from_key'], None)) is None):
                default_dispatch = next(iter(d['registry'].values()))
                blockDict = default_dispatch.inject_defaults(blockDict)

            for k, v in _d.items():
                blockDict = inject(blockDict, k, v, is_default=True)
            return blockDict

        @SingleBlock.dispatcher
        def dispatch_subclass(current_cls:type[BlockType], blockDict:dict, _dispatch_key=_fk, **kwargs):
            injection = current_cls.add_dispatch(blockDict, _dispatch_key, _wrapped=True, **kwargs)

            for k, v in injection.items():
                blockDict = inject(blockDict, k, v)

            return blockDict

        # inject methods
        _cls.inject_defaults = inject_defaults
        _cls.dispatch_subclass = dispatch_subclass

        return _cls

    if cls is not None:
        return decorator(cls)

    return decorator

stage_template(prop_name, template=None)

Source code in FoSpy/blocks/blocks.py

def stage_template(self, prop_name, template:Block|dict=None):
    from .template import TemplateBlock
    if template is None:
        template = {}

    if not isinstance(template, (TemplateBlock, dict)):
        raise ValueError("Template must be a TemplateBlock or dictionary. To 'stage' a ListBlock, "
                         "you can stage a SingleBlock template with a ListBlock alias. This creates "
                         "a non-template ListBlock with the template staged as its first entry.")

    alias_validator = None
    if "$" in prop_name:
        prop_name, alias = prop_name.split("$",1)
        try:
            alias_validator = self._aliases[alias]
        except KeyError as e:
            raise err.PropertyAliasError(prop_name, self, blockDict={prop_name: "<staged template>"},
                                         hint=f"Unrecognized block alias: '{alias}' assigned to property: ",
                                         posthint=f"Valid aliases: {list(self._aliases.keys())}") from e

    if hasattr(self, prop_name):
        raise ValueError(f"Property {prop_name} already exists. You cannot stage a template for a property that already exists.")

    validators = self.build_validators()
    validator = validators.get(prop_name, None)

    if validator is not None:
        alias = None

    if alias_validator is not validator and None not in (validator, alias_validator):
        raise ValueError(f"Property {prop_name} already has a validator. You cannot alias a different validator for the same property.")

    validator = next(v for v in (validator, alias_validator) if v is not None)

    if validator is None:
        try:
            if not isinstance(template, TemplateBlock):
                raise TypeError("Dictionary templates must be staged with an alias.")

            alias = next(k for k, v in self._aliases.items() if isinstance(template, v))
            validator = self._aliases[alias]
        except (TypeError,StopIteration) as e:
            raise ValueError(f"Property {prop_name} is unexpected. In order to stage a template "
                            "for and unexpected property, you must specify the validator with a '$' alias "
                            "in the property name, or stage a pre-constructed template of an aliasable validator."
                            ) from e

    if isinstance(validator, type) and issubclass(validator, ListBlock):
        # let setattr handle ListBlock construction using alias
        # this creates an empty ListBlock under self.prop_name
        # (alias stripped during setattr)
        setattr(self, prop_name+"$"+alias if alias is not None else prop_name, [])
        empty_lb = getattr(self, prop_name)
        return empty_lb.stage_template("entry0", template)

    if isinstance(template, dict):
        # reflex returns a TemplateBlock subclassed from the validator
        template = validator.reflex(serialize=False, include_temp_names=True, clean=False, **template)
        template.template_name = prop_name

    elif not isinstance(template, validator):
        val_nm = validator.__name__
        if alias is None:
            error_msg = f"The provided template is not compatible with the validator expected for property '{prop_name}' ({val_nm})."
        else:
            error_msg = f"The provided template is not compatible with the validator specified by alias '{alias}' ({val_nm})."
        raise ValueError(error_msg)


    template._staged_parent = self

    if alias is not None:
        self._key_overrides[prop_name] = validator

    self._staged_templates[prop_name] = template

    return prop_name, template

to_json(filepath=None, clean=True, indent=4, **kwargs)

Converts self into a JSON-formatted string or file.

Serializes and either returns as a JSON-formatted string or saves to a JSON file.

Parameters:

Name	Type	Description	Default
filepath	pathlike	JSON file save destination. If None, returns JSON-formatted string instead.	None
clean	bool	When True, no FOS format read/write metadata is included in the serial. FOS metadata has no impact on JSON format but may be useful to view in JSON for troubleshooting.	True
indent	int	indent value passed to json.dump for file saving.	4
**kwargs	any	other arguments passed to json.dump for file saving.	{}

Source code in FoSpy/blocks/blocks.py

def to_json(self, filepath=None, clean:bool=True, indent:int=4, **kwargs):
    """
    Converts `self` into a JSON-formatted string or file.

    [Serializes][FoSpy.blocks.blocks.SingleBlock.serialize] and either
    returns as a JSON-formatted string or saves to a JSON file.

    Args:
        filepath (pathlike):
            JSON file save destination. If `None`, returns JSON-formatted
            string instead.

        clean:
            When True, no FOS format read/write metadata is included in the
            serial. FOS metadata has no impact on JSON format but may be
            useful to view in JSON for troubleshooting.

        indent:
            `indent` value passed to `json.dump` for file saving.

        **kwargs (any):
            other arguments passed to `json.dump` for file saving.
    """
    import json
    serial = self.serialize(clean=clean)

    if filepath is None:
        return json.dumps(serial)

    with open(filepath, "w") as f:
        json.dump(serial, f, indent=indent, **kwargs)

track_attachments(new_copy='prompt', overwrite='prompt', **kwargs)

Source code in FoSpy/blocks/blocks.py

def track_attachments(self, new_copy="prompt",overwrite="prompt", **kwargs):
    self._att_new_copy = new_copy
    self._att_overwrite = overwrite

---

TemplateList

Bases: ListBlock

Represents a list of templates with the same subclass.

Methods:

Name	Description
Simple
TemplateClass
__eq__	Check equality of two ListBlock objects.
__getitem__	Get an item from this ListBlock by index.
__hash__	Get the hash of this ListBlock object
__init__	Constructs a ListBlock from a list of objects or serialized dictionaries.
__iter__	Iterate over the items in this ListBlock
__len__	Get the number of items in this ListBlock
__setattr__	Only private attributes starting with "_" can be set.
__setitem__	Set an item to this ListBlock by index.
_subprocess
add_comments	Attach comments to self in the parent block.
add_dispatch
append	Append a SingleBlock-coercable object to this ListBlock
block_to_idx
clear_all_comments
clear_comments	Remove comments attached to self in the parent block.
copy	Returns a deep copy by serializing and then reconstructing.
default_key_order
fill_staged_template
find_fileblock	Finds the parent file object.
find_tempdir	Find the parent file object's temporary directory.
find_temppath	Find the parent file object's temporary directory path.
get_any
get_first
get_idx
get_parent_prop
get_prop_path
has_staged
insert	Insert a SingleBlock-coercable object into this ListBlock.
inspect
list_avail_routines	Lists all methods decorated as calc routines.
order_down
order_up
refresh_attachments
remove_any	Remove any objects from self._objs with attributes matching kwargs
remove_block
remove_idx	Remove a range of items from this ListBlock
serialize	Serialize this ListBlock as a list of dictionaries.
set_list_type	Set FOS list formatting (explicit or looped).
stage_template
temp_id_gen
track_attachments

Source code in FoSpy/blocks/template.py

@SingleBlock.setup_dispatch(from_key="_reqCls",allow_self=False)
class TemplateList(ListBlock):
    """
    Represents a list of templates with the same subclass.
    """

    @classmethod
    def add_dispatch(cls, blockDict, dispatch_key, **kwargs):
        _ = SingleBlock.add_dispatch(blockDict, dispatch_key, **kwargs)

        block_dispatch = blockDict.setdefault("__dispatch__", {})
        reqCls = block_dispatch.setdefault("_reqCls", cls._reqCls)

        if reqCls is None:
            return {}

        if getattr(reqCls, "_full_class", None) is not None:
            reqCls = reqCls._full_class

        registry = TemplateList.__dispatch__['registry']
        if reqCls not in registry:

            link = _get_docs_link(reqCls)
            @SingleBlock.register_dispatch(reqCls, from_parent=TemplateList)
            @_validator_rules(
                f"A [simple `ListBlock`](#listblock-and-simple-lists) of flexible [`{reqCls.__name__}` *templates.*]{link}",
                ["[`FlexTemplate` subclasses](#flextemplate) are defined with a parent "
                "[`SingleBlock` subclass](#singleblock). They automatically detect "
                "which required properties are missing at construction time, and "
                "instantiate a [dynamic `TemplateBlock`](#templateblock) with template "
                "fields in those properties."]
            )
            class FlexList(TemplateList):
                _reqCls = reqCls.TemplateClass()
                pass

            FlexList.__name__ = f"{reqCls.__name__}FlexList"
            FlexList.__qualname__ = f"{cls.__name__}.{reqCls.__name__}FlexList"
            FlexList.__module__ = cls.__module__

        return {dispatch_key: reqCls}

    @classmethod
    def Simple(cls, reqCls, **kwargs):
        proxy_dict = {
            "__dispatch__": {
                "_reqCls": reqCls,
            }
        }

        return TemplateList.dispatch_subclass(proxy_dict)

_objs = blockList instance-attribute

_reqCls = None class-attribute instance-attribute

_staged_templates = {} instance-attribute

_temp_id_gen = self.temp_id_gen() instance-attribute

simple_lists = {} class-attribute instance-attribute

Simple(reqCls, **kwargs) classmethod

Source code in FoSpy/blocks/template.py

@classmethod
def Simple(cls, reqCls, **kwargs):
    proxy_dict = {
        "__dispatch__": {
            "_reqCls": reqCls,
        }
    }

    return TemplateList.dispatch_subclass(proxy_dict)

TemplateClass()

Source code in FoSpy/blocks/blocks.py

def TemplateClass(cls):
    from .template import TemplateList
    return TemplateList.simple(cls._reqCls)

__eq__(other, suppress_routine_paths=False)

Check equality of two ListBlock objects.

Equality is checked by a deep difference of their serialized lists.

Parameters:

Name	Type	Description	Default
other		The other ListBlock object to check equality with	required
suppress_routine_paths		Optional flag to still return true if the only differences found are in calculation routine metadata. Calculation routines are for user information only and may not be relevant for equality.	False

Source code in FoSpy/blocks/blocks.py

def __eq__(self, other, suppress_routine_paths=False):
    """
    Check equality of two `ListBlock` objects.

    Equality is checked by a deep difference of their serialized lists.

    Args:
        other:
            The other `ListBlock` object to check equality with
        suppress_routine_paths:
            Optional flag to still return true if the only differences found
            are in [calculation
            routine][FoSpy.blocks.blocks.SingleBlock.add_calc_routine]
            metadata. Calculation routines are for user information only and
            may not be relevant for equality.
    """
    from .._debug import deep_diff
    try:
        return len(deep_diff(self.serialize(), other.serialize(), suppress_routine_paths=suppress_routine_paths))==0
    except Exception:
        return False

__getitem__(idx)

Get an item from this ListBlock by index.

Parameters:

Name	Type	Description	Default
idx	int	The index of the item	required

Source code in FoSpy/blocks/blocks.py

def __getitem__(self, idx:int):
    """
    Get an item from this `ListBlock` by index.

    Args:
        idx:
            The index of the item
    """
    return self._objs[idx]

__hash__()

Get the hash of this ListBlock object

Source code in FoSpy/blocks/blocks.py

def __hash__(self):
    """
    Get the hash of this `ListBlock` object
    """
    return id(self)

__init__(blockList)

Constructs a ListBlock from a list of objects or serialized dictionaries.

Each item in blockList is checked against the SingleBlock subclass specified for the ListBlock subclass. If the item is not the correct subclass, it is passed to the SingleBlock subclass's dispatch_subclass method for coersion.

Parameters:

Name	Type	Description	Default
blockList	list	A list containing either dicts or SingleBlock objects (Mixing is allowed).	required

Raises: TypeError: ListBlock instances can only be constructed from subclasses with an assigned _reqCls, not the parent ListBlock class.

Source code in FoSpy/blocks/blocks.py

def __init__(self, blockList:list):
    """
    Constructs a `ListBlock` from a list of objects or serialized dictionaries.

    Each item in blockList is checked against the `SingleBlock` subclass
    specified for the `ListBlock` subclass. If the item is not the correct
    subclass, it is passed to the `SingleBlock` subclass's
    `dispatch_subclass` method for coersion.

    Args:
        blockList:
            A list containing either `dicts` or `SingleBlock` objects (Mixing
            is allowed).
    Raises:
        TypeError:
            `ListBlock` instances can only be constructed from subclasses with an assigned _reqCls, not the parent `ListBlock` class.
    """
    #self._objs = []
    if not (isinstance(self._reqCls, type) and issubclass(self._reqCls, SingleBlock)):
        raise TypeError(f"ListBlock instances can only be constructed from subclasses with an assigned _reqCls. {self.__class__} has no _reqCls.")
    self.track_attachments(**cfg.track_attachments())
    self._temp_id_gen = self.temp_id_gen()
    if not isinstance(blockList, list):
        blockList = [blockList]
    self._objs = blockList
    self._staged_templates = {}

__iter__()

Iterate over the items in this ListBlock

Source code in FoSpy/blocks/blocks.py

def __iter__(self):
    """
    Iterate over the items in this `ListBlock`
    """
    return iter(self._objs)

__len__()

Get the number of items in this ListBlock

Source code in FoSpy/blocks/blocks.py

def __len__(self):
    """
    Get the number of items in this `ListBlock`
    """
    return len(self._objs)

__setattr__(name, value)

Only private attributes starting with "_" can be set.

Items in self._objs can be edited/replaced individually by indexing with self[i], or self._objs can be replaced with a new list, which is re-validated and coerced to the correct SingleBlock subclass specified by _reqCls

Parameters:

Name	Type	Description	Default
name		The name of the attribute to set.	required
value		The value to set the attribute to.	required

Raises: AttributeError: Only private attributes starting with "_" can be set. TypeError: self._objs must be a list of objects which can be coerced to the correct SingleBlock subclass specified by _reqCls

Source code in FoSpy/blocks/blocks.py

def __setattr__(self, name, value):
    """
    Only private attributes starting with "_" can be set.

    Items in self._objs can be edited/replaced individually by indexing with
    self[i], or self._objs can be replaced with a new list, which is
    re-validated and coerced to the correct `SingleBlock` subclass specified
    by _reqCls

    Args:
        name:
            The name of the attribute to set.
        value:
            The value to set the attribute to.
    Raises:
        AttributeError:
            Only private attributes starting with "_" can be set.
        TypeError:
            self._objs must be a list of objects which can be coerced to the
            correct `SingleBlock` subclass specified by _reqCls
    """
    from .attachments import Attachment
    from ._blockUtils import _unwrap_listblock
    from .template import TemplateBlock, TemplateList

    if name == "_objs":


        if hasattr(self, "_reqCls"):
            errors = []
            typ = self._reqCls
            if getattr(typ, "_full_class", None) is not None:
                check_typ = typ._full_class
            else:
                check_typ = typ
            value = _unwrap_listblock(value, typ=check_typ)
            new_list = []
            for idx, obj in enumerate(value):
                if isinstance(obj, dict) and obj == {}:
                    continue
                if not isinstance(obj, check_typ):
                    try:
                        new_obj = typ(obj)
                    except Exception as e:
                        errors.append(err.ListBlockMismatchError(self, obj, idx, cause=e))
                        continue  
                    if isinstance(obj, Attachment) and hasattr(obj, "_filepath"):
                        new_obj._filepath = obj._filepath
                    obj=new_obj
                elif isinstance(obj, TemplateBlock) and not isinstance(self, TemplateList):
                    try:
                        obj = obj.fill()
                        if isinstance(obj, TemplateBlock):
                            raise err.FoSpyStructureError("Could not fill a template into a complete block before adding to this ListBlock")
                    except Exception as e:
                        errors.append(err.ListBlockMismatchError(self, obj, idx, cause=e))
                obj._parent_block = self
                if hasattr(obj, "refresh") and isinstance(obj, Attachment):
                    obj.refresh(new_copy=self._att_new_copy, overwrite=self._att_overwrite)
                new_list.append(obj)
            if errors:
                raise err.ListBlockErrorGroup(self, errors)
            return super().__setattr__(name, new_list)

    elif name.startswith("_") or name in self._reserved:
        return super().__setattr__(name,value)
    else:
        raise AttributeError(
            f"{type(self).__name__} does not allow setting attribute '{name}'. "
            f"Only private names starting with '_' can be used. "
            f"Each list item is an item in {type(self).__name__}._objs which can be edited individually, "
            f"Or you can replace {type(self).__name__}._objs with a new list of objects."
        )

__setitem__(idx, val)

Set an item to this ListBlock by index.

After setting, all items in this ListBlock's _objs list are passed back to __setattr__ for validation.

Parameters:

Name	Type	Description	Default
idx		The index of the item	required
val		The new value for the item	required

Source code in FoSpy/blocks/blocks.py

def __setitem__(self, idx, val):
    """
    Set an item to this `ListBlock` by index.

    After setting, all items in this `ListBlock`'s `_objs` list are passed
    back to [`__setattr__`][FoSpy.blocks.blocks.ListBlock.__setattr__] for
    validation.

    Args:
        idx:
            The index of the item
        val:
            The new value for the item
    """
    new_objs = self._objs.copy()
    new_objs[idx] = val
    self._objs = new_objs

_subprocess(target, args=(), **kwargs)

Source code in FoSpy/blocks/blocks.py

def _subprocess(self, target, args=(), **kwargs):
    from multiprocessing import Process

    if kwargs is None:
        kwargs={}

    p = Process(target=target, args=args, kwargs=kwargs)
    p.start()

add_comments(*comments)

Attach comments to self in the parent block.

Mutates the parent block's comments metadata under the assigned attribute name.

Parameters:

Name	Type	Description	Default
*comments	str	Comments to attach to the assigned attribute name in the parent block's metadata. Comments are printed above their attached attribute when saving in the FOS format.	()

Example

>>> my_synthesis.materials.add_comments("A comment on the materials header")
>>> my_synthesis._meta.comments 
{"materials":
    [
        "an older comment", 
        "A comment on the materials header"
    ]
}

Source code in FoSpy/blocks/blocks.py

def add_comments(self, *comments):
    """
    Attach comments to self in the parent block.

    Mutates the parent block's comments metadata under the assigned
    attribute name.

    Args:
        *comments (str):
            Comments to attach to the assigned attribute name in
            the parent block's metadata. Comments are printed above
            their attached attribute when saving in the FOS format.

    Example:
        ```
        >>> my_synthesis.materials.add_comments("A comment on the materials header")
        >>> my_synthesis._meta.comments 
        {"materials":
            [
                "an older comment", 
                "A comment on the materials header"
            ]
        }
        ```
    """
    # placeholder. Method is injected by _add_comments_to_parent when this
    # block is assigned as an attribute of another block
    return

add_dispatch(blockDict, dispatch_key, **kwargs) classmethod

Source code in FoSpy/blocks/template.py

@classmethod
def add_dispatch(cls, blockDict, dispatch_key, **kwargs):
    _ = SingleBlock.add_dispatch(blockDict, dispatch_key, **kwargs)

    block_dispatch = blockDict.setdefault("__dispatch__", {})
    reqCls = block_dispatch.setdefault("_reqCls", cls._reqCls)

    if reqCls is None:
        return {}

    if getattr(reqCls, "_full_class", None) is not None:
        reqCls = reqCls._full_class

    registry = TemplateList.__dispatch__['registry']
    if reqCls not in registry:

        link = _get_docs_link(reqCls)
        @SingleBlock.register_dispatch(reqCls, from_parent=TemplateList)
        @_validator_rules(
            f"A [simple `ListBlock`](#listblock-and-simple-lists) of flexible [`{reqCls.__name__}` *templates.*]{link}",
            ["[`FlexTemplate` subclasses](#flextemplate) are defined with a parent "
            "[`SingleBlock` subclass](#singleblock). They automatically detect "
            "which required properties are missing at construction time, and "
            "instantiate a [dynamic `TemplateBlock`](#templateblock) with template "
            "fields in those properties."]
        )
        class FlexList(TemplateList):
            _reqCls = reqCls.TemplateClass()
            pass

        FlexList.__name__ = f"{reqCls.__name__}FlexList"
        FlexList.__qualname__ = f"{cls.__name__}.{reqCls.__name__}FlexList"
        FlexList.__module__ = cls.__module__

    return {dispatch_key: reqCls}

append(obj)

Append a SingleBlock-coercable object to this ListBlock

Appends the object to this ListBlock's _objs list, and passes the entire list back to __setattr__ for validation.

Parameters:

Name	Type	Description	Default
obj	SingleBlock	The object to append	required

Source code in FoSpy/blocks/blocks.py

def append(self, obj:SingleBlock):
    """
    Append a `SingleBlock`-coercable object to this `ListBlock`

    Appends the object to this `ListBlock`'s `_objs` list, and passes the
    entire list back to
    [`__setattr__`][FoSpy.blocks.blocks.ListBlock.__setattr__] for
    validation.

    Args:
        obj:
            The object to append
    """
    objs = self._objs.copy()
    objs.append(obj)
    self._objs = objs

block_to_idx(blk, idx)

Source code in FoSpy/blocks/blocks.py

def block_to_idx(self, blk, idx):
    objs = self._objs.copy()
    current_idx = None
    if blk in objs:
        current_idx = objs.index(blk)
        if idx <= current_idx:
            current_idx += 1
    objs.insert(idx, blk)
    objs.pop(current_idx)
    self._objs = objs

clear_all_comments()

Source code in FoSpy/blocks/blocks.py

def clear_all_comments(self):
    for obj in self:
        if hasattr(obj, "clear_all_comments"):
            obj.clear_all_comments()

clear_comments(self_attr)

Remove comments attached to self in the parent block.

Clears parent block's comments metadata under the assigned attribute name.

Example

>>> my_synthesis._meta.comments["materials"]
["This comment was read from a FOS file"]

>>> my_synthesis.materials.clear_comments()
>>> my_synthesis._meta.comments["materials"]
[]

Source code in FoSpy/blocks/blocks.py

def clear_comments(self_attr):
    """
    Remove comments attached to self in the parent block.

    Clears parent block's comments metadata under the assigned attribute name.

    Example:
        ```
        >>> my_synthesis._meta.comments["materials"]
        ["This comment was read from a FOS file"]

        >>> my_synthesis.materials.clear_comments()
        >>> my_synthesis._meta.comments["materials"]
        []
        ```
    """
    # placeholder. Method is injected by _clear_comments_from_parent when this
    # block is assigned as an attribute of another block
    return

copy()

Returns a deep copy by serializing and then reconstructing.

Source code in FoSpy/blocks/blocks.py

def copy(self):
    """Returns a deep copy by serializing and then reconstructing."""
    cls = type(self)
    return cls(self.serialize(override_list_type=False))

default_key_order(deep=False)

Source code in FoSpy/blocks/blocks.py

def default_key_order(self, deep=False):
    for obj in self:
        if hasattr(obj, "default_key_order"):
            obj.default_key_order(deep=deep)

fill_staged_template(temp_id, idx=None, **kwargs)

Source code in FoSpy/blocks/blocks.py

def fill_staged_template(self, temp_id, idx=None, **kwargs):
    from .template import TemplateBlock

    template = self._staged_templates.pop(temp_id, None)
    if template is None:
        temp_id, _ = self.stage_template(temp_id)
        return self.fill_staged_template(temp_id, **kwargs)

    filled = template.fill(staged=True, **kwargs)

    if isinstance(filled, TemplateBlock):
        return self.stage_template(temp_id, filled)

    if idx is None:
        self.append(filled)
    else:
        self.insert(idx, filled)

    return temp_id, filled

find_fileblock()

Finds the parent file object.

Walks upward through _parent_block attributes until a FileBlock instance is found and returns that instance.

Source code in FoSpy/blocks/blocks.py

def find_fileblock(self):
    """
    Finds the parent file object.

    Walks upward through `_parent_block` attributes until a
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance is found and
    returns that instance.
    """
    from .files import FileBlock
    from .._errors import FileBlockNotFoundError

    blk = self
    while blk is not None:
        if isinstance(blk, FileBlock):
            return blk
        if hasattr(blk,"_parent_block"):
            blk = blk._parent_block
        else:
            blk = None
    raise FileBlockNotFoundError("Could not find a FileBlock containing the current object")

find_tempdir()

Find the parent file object's temporary directory.

Finds the temporary directory created by the FileBlock instance containing this block as one of its attributes.

Returns:

Name	Type	Description
tempdir	tempfile.TemporaryDirectory	The temporary directory created by the parent file object

Source code in FoSpy/blocks/blocks.py

def find_tempdir(self):
    """
    Find the parent file object's temporary directory.

    Finds the temporary directory created by the
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance containing this
    block as one of its attributes. 

    Returns:
        tempdir (tempfile.TemporaryDirectory):
            The temporary directory created by the parent file object
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_tempdir"):
        return fileblock._tempdir
    else:
        raise AttributeError("Could not find a temporary directory attached to this object's FileBlock")

find_temppath()

Find the parent file object's temporary directory path.

Similar to find_tempdir but returns the corresponding pathlib.Path object instead.

Source code in FoSpy/blocks/blocks.py

def find_temppath(self):
    """
    Find the parent file object's temporary directory path.

    Similar to [`find_tempdir`][FoSpy.blocks.blocks.Block.find_tempdir] but
    returns the corresponding `pathlib.Path` object instead.
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_temppath"):
        return fileblock._temppath
    if hasattr(fileblock, "_temppdir"):
        raise AttributeError("This object's FileBlock has a temporary directory but no path mapped to it. "
                             "Use obj.find_tempdir() instead")
    raise AttributeError("Could not find a temporary directory object or path "
                         "attached to this object's FileBlock.")

get_any(**kwargs)

Source code in FoSpy/blocks/blocks.py

def get_any(self, **kwargs):
    if len(kwargs) != 1:
        raise TypeError("Exactly one keyword argument is required")

    key, val = next(iter(kwargs.items()))
    found = []
    for obj in self:
        if getattr(obj, key, None) == val:
            found.append(obj)
    return found

get_first(**kwargs)

Source code in FoSpy/blocks/blocks.py

def get_first(self, **kwargs):
    return self.get_any(**kwargs)[0]

get_idx(blk)

Source code in FoSpy/blocks/blocks.py

def get_idx(self, blk):
    try:
        return self._objs.index(blk)
    except ValueError:
        raise err.FoSpyStructureError(f"Block {blk} is not in {self}")

get_parent_prop()

Source code in FoSpy/blocks/blocks.py

def get_parent_prop(self):
    if not hasattr(self, "_parent_block"):
        return None
    parent_blk = self._parent_block

    if isinstance(parent_blk, SingleBlock):
        for prop, val in parent_blk.get_prop_dict().items():
            if val is self:
                return prop

        raise err.FoSpyStructureError(f"Block {self} points to a parent block {parent_blk} that does not contain it as a property.")

    elif isinstance(parent_blk, ListBlock):
        return f"[{parent_blk.get_idx(self)}]"

    raise err.FoSpyStructureError(f"Block {self} has an unknown parent block type: {type(parent_blk)}")

get_prop_path()

Source code in FoSpy/blocks/blocks.py

def get_prop_path(self):
    from .files import FileBlock

    if not hasattr(self, "_parent_block"):
        if isinstance(self, FileBlock):
            root_path = f"<{str(self.get_file_name())}>"
        else:
            root_path = f"<Root {type(self).__name__}"
            if isinstance(self, SingleBlock):
                id_key, id_txt = self.get_id()
                if id_key is not None:
                    root_path += f" ({id_key}={id_txt})"
            root_path += ">"
        return root_path

    parent_path = self._parent_block.get_prop_path()
    parent_prop = self.get_parent_prop()

    if "[" not in parent_prop:
        return parent_path + "." + parent_prop

    return parent_path + parent_prop

has_staged()

Source code in FoSpy/blocks/blocks.py

def has_staged(self):
    return len(self._staged_templates) > 0 or any(blk.has_staged() for blk in self)

insert(idx, obj)

Insert a SingleBlock-coercable object into this ListBlock.

Inserts the object into this ListBlock's _objs list, and passes the entire list back to __setattr__ for validation.

Parameters:

Name	Type	Description	Default
idx		The index to insert the object at	required
obj	SingleBlock	The object to insert	required

Source code in FoSpy/blocks/blocks.py

def insert(self, idx, obj:SingleBlock):
    """
    Insert a `SingleBlock`-coercable object into this `ListBlock`.

    Inserts the object into this `ListBlock`'s `_objs` list, and passes the
    entire list back to
    [`__setattr__`][FoSpy.blocks.blocks.ListBlock.__setattr__] for
    validation.

    Args:
        idx:
            The index to insert the object at
        obj:
            The object to insert
    """
    objs = self._objs.copy()
    objs.insert(idx,obj)
    self._objs = objs

inspect() classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def inspect(self):
    # for breaking to debugger from gui
    raise Exception("put a break point here")

list_avail_routines(recursive=False, prefix='', abbreviated=False)

Lists all methods decorated as calc routines.

Methods are resolved as path strings relative to self, including indexing for recursively searched methods within self._objs. When returned back to a parent ListBlock object's call, these strings produce paths that can be resolved back into function calls relative to the parent object. See SingleBlock.list_avail_routines().

This method is usually only used in a recursive call from a SingleBlock object where one of its attributes is a ListBlock.

Example:

mySyn.materals.list_avail_routines(recursive=True)
## returns [
##     'add_weight_pcts',
##     '[0].add_MW',
##     '[1].add_MW',
##     ... 6 total materials with the same calc_routine
##     '[5].add_MW'
## ]

# Resursive call from `SingleBlock` mySyn object:
mySyn.list_avail_routines(recursive=True)
## returns [
##     'reaction.add_nom_MW',
##     'materials.add_weight_pcts',
##     'materials[0].add_MW',
##     'materials[1].add_MW',
##     ... 6 total materials with the same calc_routine
##     'materials[5].add_MW'
## ]

Source code in FoSpy/blocks/blocks.py

def list_avail_routines(self, recursive=False, prefix="", abbreviated=False):
    """
    Lists all methods decorated as calc routines.

    Methods are resolved as path strings relative to self, including
    indexing for recursively searched methods within self._objs. When
    returned back to a parent `ListBlock` object's call, these strings
    produce paths that can be resolved back into function calls relative to
    the parent object. See `SingleBlock.list_avail_routines()`.

    This method is usually only used in a recursive call from a
    `SingleBlock` object where one of its attributes is a `ListBlock`.

    Example:
    ```
    mySyn.materals.list_avail_routines(recursive=True)
    ## returns [
    ##     'add_weight_pcts',
    ##     '[0].add_MW',
    ##     '[1].add_MW',
    ##     ... 6 total materials with the same calc_routine
    ##     '[5].add_MW'
    ## ]

    # Resursive call from `SingleBlock` mySyn object:
    mySyn.list_avail_routines(recursive=True)
    ## returns [
    ##     'reaction.add_nom_MW',
    ##     'materials.add_weight_pcts',
    ##     'materials[0].add_MW',
    ##     'materials[1].add_MW',
    ##     ... 6 total materials with the same calc_routine
    ##     'materials[5].add_MW'
    ## ]
    ```
    """
    routines = []

    # Local routines on the ListBlock itself
    for name in dir(self):
        attr = getattr(self, name)
        if callable(attr) and getattr(attr, "_is_calc_routine", False):
            routines.append(prefix + name)

    if recursive:
        if abbreviated:
            obj_routines = {}
            idx_str = "i"
            idx_num = 0
            while f"[{idx_str}{idx_num if idx_num > 0 else ''}]" in prefix:
                if idx_str == "z":
                    idx_str = "i"
                    idx_num += 1
                else:
                    idx_str = chr(ord(idx_str)+1)

            idx_str = f"{idx_str}{idx_num if idx_num > 0 else ''}"

            for i, obj in enumerate(self._objs):
                if hasattr(obj, "list_avail_routines"):
                    rtns = obj.list_avail_routines(True,f"{prefix[:-1]}[{idx_str}].",abbreviated=True)
                    for routine in rtns:
                        if routine not in obj_routines:
                            obj_routines[routine] = []
                        obj_routines[routine].append(i)
            for routine, i_list in obj_routines.items():
                routines.append(f"{routine}; {idx_str} = {i_list}")
        else:
            for i, obj in enumerate(self._objs):
                if hasattr(obj, "list_avail_routines"):
                    child_prefix = f"{prefix[:-1]}[{i}]."
                    routines.extend(obj.list_avail_routines(
                        recursive=True,
                        prefix=child_prefix,
                        abbreviated=False
                    ))

    return routines

order_down(blk)

Source code in FoSpy/blocks/blocks.py

def order_down(self, blk):
    idx = self.get_idx(blk)
    if idx == len(self)-1:
        return
    self.block_to_idx(blk, idx+2)

order_up(blk)

Source code in FoSpy/blocks/blocks.py

def order_up(self, blk):
    idx = self.get_idx(blk)
    if idx == 0:
        return
    self.block_to_idx(blk, idx-1)

refresh_attachments(new_copy=None, overwrite=None, **kwargs)

Source code in FoSpy/blocks/blocks.py

def refresh_attachments(self, new_copy=None, overwrite=None, **kwargs):
    from .attachments import Attachment

    if new_copy is None:
        new_copy = self._att_new_copy
    if overwrite is None:
        overwrite = self._att_overwrite

    for val in self:
        if hasattr(val, "refresh_attachments"):
            val.refresh_attachments(new_copy=new_copy, overwrite=overwrite, **kwargs)
        if isinstance(val, Attachment) and hasattr(val, "refresh"):
            val.refresh(new_copy=new_copy, overwrite=overwrite, **kwargs)

remove_any(**kwargs)

Remove any objects from self._objs with attributes matching kwargs

Parameters:

Name	Type	Description	Default
**kwargs		A single keyword argument can be passed. Any objects with attr:value matching kw:arg are removed.	{}

Raises:

Type	Description
TypeError	Exactly one keyword argument is required.

Example:

mySyn.materials.remove_any(supplier="sigma")
## removes any obj from mySyn.materials._objs where
## obj.supplier == "sigma"

Source code in FoSpy/blocks/blocks.py

def remove_any(self, **kwargs):
    """
    Remove any objects from self._objs with attributes matching `kwargs`

    Args:
        **kwargs:
            A single keyword argument can be passed. Any objects with
            attr:value matching kw:arg are removed.

    Raises:
        TypeError: Exactly one keyword argument is required.

    Example:
    ```
    mySyn.materials.remove_any(supplier="sigma")
    ## removes any obj from mySyn.materials._objs where
    ## obj.supplier == "sigma"
    ```
    """
    if len(kwargs) != 1:
        raise TypeError("Exactly one keyword argument is required")

    key, val = next(iter(kwargs.items()))

    objs = list(iter(self)).copy()
    removed = 0
    for obj in self:
        if getattr(obj, key, None) == val:
            for i, existing in enumerate(objs):
                if existing is obj:
                    del objs[i]
                    removed += 1
                    break

    self._objs = objs
    _debug.msg(f"Removed {removed} {self._reqCls.__name__} objects matching {key} = {val}.")

remove_block(blk)

Source code in FoSpy/blocks/blocks.py

def remove_block(self, blk):
    if blk in self._objs:
        self._objs.remove(blk)

    if blk in self._staged_templates.values():
        temp_id = next(k for k,v in self._staged_templates.items() if v is blk)
        self._staged_templates.pop(temp_id)

remove_idx(from_idx=None, to_idx=None)

Remove a range of items from this ListBlock

Removes a range of items from this ListBlock's _objs list, and passes the entire list back to __setattr__ for validation.

from_idx is inclusive, and to_idx is non-inclusive. i.e., if from_idx is 0 and to_idx is 1, then the first item in the list will be removed, but not the second.

If from_idx is None, then all items starting at and including to_idx will be removed. If to_idx is None, then all items up to and not including from_idx will be removed.

Parameters:

Name	Type	Description	Default
from_idx	int	The index of the first item to remove	None
to_idx	int	The non-inclusive index to stop removing	None

Source code in FoSpy/blocks/blocks.py

def remove_idx(self, from_idx:int=None, to_idx:int=None):
    """
    Remove a range of items from this `ListBlock`

    Removes a range of items from this `ListBlock`'s `_objs` list, and
    passes the entire list back to
    [`__setattr__`][FoSpy.blocks.blocks.ListBlock.__setattr__] for
    validation.

    `from_idx` is inclusive, and `to_idx` is non-inclusive. i.e., if
    `from_idx` is 0 and `to_idx` is 1, then the first item in the list will
    be removed, but not the second.

    If `from_idx` is None, then all items starting at and including `to_idx`
    will be removed. If `to_idx` is None, then all items up to and **not**
    including `from_idx` will be removed.

    Args:
        from_idx:
            The index of the first item to remove
        to_idx:
            The non-inclusive index to stop removing
    """
    if from_idx is None and to_idx is None:
        self._objs = []

    objs = self._objs.copy()

    if from_idx is None:
        objs = objs[to_idx:]
    elif to_idx is None:
        objs = objs[:from_idx]
    else:
        objs = objs[:from_idx] + objs[to_idx:]

    self._objs = objs   

serialize(clean=False, shallow=False, override_list_type=None)

Serialize this ListBlock as a list of dictionaries.

Overriding list type is only skipped when all objects in the list have the same list type. To prevent mutation, list type override is performed by calling set_list_type on a copy of this ListBlock and returning the serialized copy.

ListBlocks of length one are always overridden to "explicit".

List Types

• "explicit": Each object declares its own keys.
• "looped": Common keys are declared once at the beginning of a list. Each object specifies values for those keys in the declared order. Anomalous keys are still printed as key:value pairs.

Parameters:

Name	Type	Description	Default
clean		When True, no FOS format read/write metadata is included in the serial. Recommended for sending output to other formats like JSON.	False
shallow		When True, no recursive serialization occurs. Recommended when serialization is used only to inspect top-level keys for object dictionaries.	False
override_list_type	str | bool	When None (default): Checks for mixed list types and recurses with override set to "explicit" if found. When False: Does not override any list type. This should be avoided for FOS-formatted output unless you know that all objects in the list have the same list type. When str: Copies this ListBlock and passes override to copy.set_list_type before returning the serialized copy	None

Source code in FoSpy/blocks/blocks.py

def serialize(self, clean=False, shallow=False, override_list_type:str|bool=None):
    """
    Serialize this `ListBlock` as a list of dictionaries.

    Overriding list type is only skipped when all objects in the list have
    the same list type. To prevent mutation, list type override is performed
    by calling
    [`set_list_type`][FoSpy.blocks.blocks.ListBlock.set_list_type] on a copy
    of this `ListBlock` and returning the serialized copy.

    `ListBlock`s of length one are always overridden to "explicit".

    List Types:
        - "explicit": Each object declares its own keys.
        - "looped": 
            Common keys are declared once at the beginning of a list. Each
            object specifies values for those keys in the declared order.
            Anomalous keys are still printed as key:value pairs.

    Args:
        clean:
            When True, no FOS format read/write metadata is included in the
            serial. Recommended for sending output to other formats like
            JSON.
        shallow:
            When True, no recursive serialization occurs. Recommended when
            serialization is used only to inspect top-level keys for object
            dictionaries.
        override_list_type:
            - When `None` (default): Checks for mixed list types and
              recurses with override set to "explicit" if found.
            - When `False`: Does not override any list type. This should be
              avoided for FOS-formatted output unless you know that all
              objects in the list have the same list type.
            - When `str`: Copies this `ListBlock` and passes override to
              [`copy.set_list_type`][FoSpy.blocks.blocks.ListBlock.set_list_type]
              before returning the serialized copy
    """
    if override_list_type is None:
        for obj in self:
            if obj._meta.list_type == "explicit":
                return self.serialize(clean=clean, shallow=shallow, override_list_type="explicit")
        return self.serialize(clean=clean, shallow=shallow, override_list_type="looped")
    elif not override_list_type:
        keepListType = len(self)>1
        lst = [obj.serialize(clean=clean, shallow=shallow, keepListType=keepListType) for obj in self]
        return lst
    else:
        copy = self.copy()
        copy.set_list_type(override_list_type)
        return copy.serialize(clean=clean, shallow=shallow, override_list_type=False)

set_list_type(typ='explicit')

Set FOS list formatting (explicit or looped).

Sets metadata for all items in this ListBlock to the specified type.

List Types

• "explicit": Each object declares its own keys.
• "looped": Common keys are declared once at the beginning of a list. Each object specifies values for those keys in the declared order. Anomalous keys are still printed as key:value pairs.

Parameters:

Name	Type	Description	Default
typ		The type to set	'explicit'

Source code in FoSpy/blocks/blocks.py

def set_list_type(self,typ="explicit"):
    """
    Set FOS list formatting (explicit or looped).

    Sets metadata for all items in this `ListBlock` to the specified type.

    List Types:
        - "explicit": Each object declares its own keys.
        - "looped": 
            Common keys are declared once at the beginning of a list. Each
            object specifies values for those keys in the declared order.
            Anomalous keys are still printed as key:value pairs.

    Args:
        typ:
            The type to set
    """
    if typ not in ("explicit", "looped"):
        raise ValueError("List type must be 'single' or 'looped'.")
    for obj in self:
        obj._meta.list_type = typ

stage_template(temp_id=None, template=None)

Source code in FoSpy/blocks/blocks.py

def stage_template(self, temp_id=None, template:Block|dict=None):
    from .template import TemplateBlock
    if template is None:
        template = {}

    if isinstance(template, TemplateBlock):
        temp_id = temp_id or template.template_name
        if temp_id in self._staged_templates:
            temp_id += f" ({next(self._temp_id_gen)})"
    elif isinstance(template, dict):
        temp_id = temp_id or template.get("template_name", next(self._temp_id_gen))
    else:
        raise ValueError("Template must be a TemplateBlock or dictionary.")

    if isinstance(template, dict):
        template = self._reqCls.reflex(serialize=False,**template)
        template.template_name = temp_id
    elif not isinstance(template, self._reqCls):
        raise ValueError("Template must be a TemplateBlock subclass of the same type as this ListBlock.")

    if temp_id in self._staged_templates:
        raise ValueError(f"A Template has already been staged for {temp_id}.")

    template._staged_parent = self
    self._staged_templates[temp_id] = template

    return temp_id, template

temp_id_gen()

Source code in FoSpy/blocks/blocks.py

def temp_id_gen(self):
    i = 0
    while True:
        yield "template_" + str(i)
        i += 1

track_attachments(new_copy='prompt', overwrite='prompt', **kwargs)

Source code in FoSpy/blocks/blocks.py

def track_attachments(self, new_copy="prompt",overwrite="prompt", **kwargs):
    self._att_new_copy = new_copy
    self._att_overwrite = overwrite

---

TemplateSet

Bases: FileBlock

Represents a set of templates loaded from a FOS file.

FOS files may contain multiple different types of templates grouped into TemplateLists. Each of these lists is one attribute of a TemplateSet.

Methods:

Name	Description
TemplateClass	Create a template for a subclass of SingleBlock.
__delattr__
__eq__	Check equality of two SingleBlock objects.
__getattr__	Check both self and self.ext for attribute before returning.
__hash__
__init__
__new__
__setattr__
_assign_and_inject	Attaches attributes and methods to any value before assigning it as an
_meta_to_front	Moves metadata to the front of _key_order. Metadata will always be
_rename_validators	Realigns any renamed
_resolve_relative_path	Resolves a relative object path string into an object or function.
_subprocess
_update_src
add_all_calc_routines	Schedule all available calculation routines.
add_block	Adds an unexpected attribute with a validator mapped by type_alias.
add_calc_comment	Add a calculated comment to be injected during serialization.
add_calc_routine	Schedules a calculated comment.
add_comments	Default behavior to be overwritten when attached to a parent block.
add_dispatch
build_req_validators	Builds required keys and validators mapped to subclass.
build_validators	Builds expected keys and validators mapped to subclass.
check_attachments
cleanup
clear_all_comments
clear_comments	Clear comments attached to top-level attributes only.
copy	Returns a deep copy of self by saving to a temp file and reloading.
default_key_order	Set to default attribute order for serialization.
dispatch_subclass
dispatcher	Decorate a classmethod to dispatch to other subclasses.
fill_staged_template
find_attachments
find_fileblock	Finds the parent file object.
find_tempdir	Find the parent file object's temporary directory.
find_temppath	Find the parent file object's temporary directory path.
fromFile
get_file_name
get_id
get_parent_prop
get_prop_dict	Returns a dictionary mapping property names to their live object values.
get_prop_path
get_req_validators	Overrides class validators with any renamed properties.
get_validators	Overrides class validators with any renamed properties.
has_staged
inject_defaults
inspect
key_to_idx	Reorder attributes for serialization.
keys_to_end	Reorder attributes for serialization.
keys_to_front	Reorder attributes for serialization.
list_avail_routines	Lists all calc routines available to be added to self._calc_routines.
make_template	Converts self into a template of its original subclass.
matches_file
package
print_summary
reflex
refresh_attachments
register_dispatch	Decorate a subclass to be dispatched from a parent class.
rename_block
rename_dict
save	Sends a serialized dict to be written to file.
serialize
set_dispatch
setup_dispatch	Decorate a class to dispatch to other classes during construction.
stage_template
to_json	Converts self into a JSON-formatted string or file.
track_attachments

Source code in FoSpy/blocks/template.py

@FileBlock.register_dispatch("templates",defaults={"metadata":{"fos_type":"templates"}})
class TemplateSet(FileBlock):
    """
    Represents a set of templates loaded from a FOS file.

    FOS files may contain multiple different types of templates grouped into
    `TemplateList`s. Each of these lists is one attribute of a `TemplateSet`.
    """
    def __init__(self, blockDict, **kwargs):
        self._aliases = _get_template_aliases()
        super().__init__(blockDict, **kwargs)

    def __setattr__(self, name, value):
        if "$" in name:
            new_name, alias = name.split("$")
            if alias in self._aliases:
                return super().__setattr__(name, value)

            try:
                alias = next(a for a in self._aliases if _is_plural(alias, a))
                name = new_name + "$" + alias
            except StopIteration:
                pass
            return super().__setattr__(name, value)

        if name.startswith("_") or name in (
            "metadata",
            "ext",
            "rename"
        ):
            return super().__setattr__(name, value)

        if name in self._aliases:
            name = name + "s" + name
        else:
            try:
                alias = next(a for a in self._aliases if _is_plural(name, a))
                name = name + "$" + alias
            except StopIteration:
                pass

        return super().__setattr__(name, value)

    def serialize(self, *args, **kwargs):
        serial = super().serialize(*args, **kwargs)

        out = {}

        for name, value in serial.items():
            if "$" in name:
                new_name, alias = name.split("$")
                if _is_plural(new_name, alias):
                    name = new_name

            out[name] = value

        return out

_aliases = _get_template_aliases() instance-attribute

_calc_comments = {} instance-attribute

_calc_routines = [] instance-attribute

_constructed = True instance-attribute

_id_key = None class-attribute instance-attribute

_key_order = [] instance-attribute

_key_overrides = {} instance-attribute

_meta = SubContainer() instance-attribute

_reserved = ['ext'] instance-attribute

_sourceDict = blockDict.copy() instance-attribute

_sourceFile = _sourceFile instance-attribute

_staged_templates = {} instance-attribute

_tempdir = tempfile.TemporaryDirectory() instance-attribute

_temppath = Path(self._tempdir.name) instance-attribute

dispatch = {} class-attribute instance-attribute

dispatch_allow_self = True class-attribute instance-attribute

dispatch_default = None class-attribute instance-attribute

dispatch_key = None class-attribute instance-attribute

ext = SubContainer() instance-attribute

rename = rename instance-attribute

TemplateClass(*args) classmethod

Create a template for a subclass of SingleBlock.

Generates a hybridized subclass of the current block class and TemplateBlock. Template subclasses override original expected validators with either a TemplateField, TemplateBlock, or TemplateList depending on the type of the original validator.

Parameters:

Name	Type	Description	Default
*args	str	A list of properties to override as template types.	()

Source code in FoSpy/blocks/blocks.py

@classmethod
def TemplateClass(cls,*args:str):
    """
    Create a template for a subclass of `SingleBlock`.

    Generates a hybridized subclass of the current block class and
    [`TemplateBlock`][FoSpy.blocks.template.TemplateBlock]. Template
    subclasses override original expected validators with either a
    [`TemplateField`][FoSpy.blocks.template.TemplateField],
    [`TemplateBlock`][FoSpy.blocks.template.TemplateBlock], or
    [`TemplateList`][FoSpy.blocks.template.TemplateList] depending on the
    type of the original validator.

    Args:
        *args: A list of properties to override as template types.
    """
    from .template import TemplateBlock, FlexTemplate

    cls_registry = TemplateBlock.__dispatch__["registry"]

    if cls not in cls_registry:

        @TemplateBlock.register_dispatch(cls, setup_from_key="_fields", setup_allow_self=True, inherit_dispatch=True)
        class TemplateLocator(FlexTemplate, TemplateBlock, cls):
            _full_class = cls

        TemplateLocator.__name__ = f"{cls.__name__}TemplateLocator"
        TemplateLocator.__qualname__ = f"{cls.__name__}.TemplateClass.Locator"
        TemplateLocator.__module__ = cls.__module__

    fields = tuple(sorted(args))

    # construct a proxy dictionary that will correctly dispatch to the right
    # template class in TemplateBlock's dispatch chain.
    proxy_dict = {
        "__dispatch__": {
            "_full_class": cls,
            "_fields": fields
        }
    }

    return TemplateBlock.dispatch_subclass(proxy_dict)

__delattr__(attr)

Source code in FoSpy/blocks/blocks.py

def __delattr__(self, attr):
    if attr in self.get_req_validators():
        raise AttributeError(f"Cannot delete property: '{attr}'. It is registered as a required property for this object.")
    return super().__delattr__(attr)

__eq__(other, suppress_routine_paths=False)

Check equality of two SingleBlock objects.

Equality is checked by a deep difference of their serialized dictionaries.

Parameters:

Name	Type	Description	Default
suppress_routine_paths	bool	Optional flag to still return true if the only differences found are in calculation routine metadata. Calculation routines are for user information only and may not be relevant for equality.	False

Source code in FoSpy/blocks/blocks.py

def __eq__(self, other, suppress_routine_paths:bool=False):
    """
    Check equality of two `SingleBlock` objects.

    Equality is checked by a deep difference of their
    [serialized][FoSpy.blocks.blocks.SingleBlock.serialize] dictionaries.

    Args:
        suppress_routine_paths:
            Optional flag to still return true if the only differences found
            are in [calculation
            routine][FoSpy.blocks.blocks.SingleBlock.add_calc_routine]
            metadata. Calculation routines are for user information only and
            may not be relevant for equality.
    """
    from .._debug import deep_diff as dd, _debug as db
    try:
        db.msg("Serializing Blocks to check equality:", module = "SingleBlock.__eq__()")
        diffs = dd(self.serialize(), other.serialize(), suppress_routine_paths=suppress_routine_paths)
        passed = len(diffs) == 0
        if not passed:
            db.pmsg(diffs,module = "SingleBlock.__eq__()")
        return passed
    except Exception as e:
        db.msg(f"Equality failed by exception: {e}",module = "SingleBlock.__eq__()")
        return False

__getattr__(name)

Check both self and self.ext for attribute before returning.

A matching attribute of self will be returned first, but if self has no matching attribute, a matching attribute of self.ext can be returned instead.

Source code in FoSpy/blocks/blocks.py

def __getattr__(self, name:str):
    """
    Check both `self` and `self.ext` for attribute before returning.

    A matching attribute of `self` will be returned first, but if `self` has
    no matching attribute, a matching attribute of `self.ext` can be
    returned instead.
    """

    try:
        if name not in ("rename", "ext") and hasattr(self, "rename"):
            rename_dict = self.rename.serialize(shallow=True, clean=True)
            if name in rename_dict:
                return getattr(self, rename_dict[name])

        if name != 'ext':
            return getattr(self.ext, name)

        raise AttributeError()
    except AttributeError:
        raise AttributeError(
            f"{type(self).__name__} object "
            f"has no attribute {name!r}."
        )

__hash__()

Source code in FoSpy/blocks/blocks.py

def __hash__(self):
    return id(self)

__init__(blockDict, **kwargs)

Source code in FoSpy/blocks/template.py

def __init__(self, blockDict, **kwargs):
    self._aliases = _get_template_aliases()
    super().__init__(blockDict, **kwargs)

__new__(blockDict, *args, **kwargs)

Source code in FoSpy/blocks/blocks.py

def __new__(cls, blockDict, *args, **kwargs):
    _dispatched = kwargs.pop("_dispatched", False)
    if _dispatched:
        # blockDict should always be dict after dispatch. I want to see attributeerror if not.
        blockDict.pop("__dispatch__",None)
        return super().__new__(cls)

    blockDict = _unwrap_block(blockDict)

    dispatched_cls = cls.dispatch_subclass(blockDict, *args, **kwargs)

    if issubclass(dispatched_cls, cls):
        return dispatched_cls(blockDict, *args, _dispatched=True, **kwargs)

    dispatch = blockDict.pop("__dispatch__")
    raise err.BlockDispatchError(
        f"Attempted to construct the following dictionary as a {cls.__name__} block, "
        f"but it was dispatched to a {dispatched_cls.__name__} instead."
        f"\n\nINPUT:\n{blockDict}"
        f"\n\nDISPATCH:\n{dispatch}")

__setattr__(name, value)

Source code in FoSpy/blocks/template.py

def __setattr__(self, name, value):
    if "$" in name:
        new_name, alias = name.split("$")
        if alias in self._aliases:
            return super().__setattr__(name, value)

        try:
            alias = next(a for a in self._aliases if _is_plural(alias, a))
            name = new_name + "$" + alias
        except StopIteration:
            pass
        return super().__setattr__(name, value)

    if name.startswith("_") or name in (
        "metadata",
        "ext",
        "rename"
    ):
        return super().__setattr__(name, value)

    if name in self._aliases:
        name = name + "s" + name
    else:
        try:
            alias = next(a for a in self._aliases if _is_plural(name, a))
            name = name + "$" + alias
        except StopIteration:
            pass

    return super().__setattr__(name, value)

_assign_and_inject(name, value, extended=False)

Attaches attributes and methods to any value before assigning it as an attribute of self or self.ext.

Attributes Attached to Object

_parent_block: refers to self

Methods Attached to Object

add_comments_to_parent clear_comments_from_parent

Source code in FoSpy/blocks/blocks.py

def _assign_and_inject(self, name, value, extended=False):
    """
    Attaches attributes and methods to any value before assigning it as an
    attribute of `self` or `self.ext`.

    Attributes Attached to Object:
        `_parent_block`: refers to `self`

    Methods Attached to Object:
        [`add_comments_to_parent`][FoSpy.blocks.blocks._add_comments_to_parent]
        [`clear_comments_from_parent`][FoSpy.blocks.blocks._clear_comments_from_parent]
    """
    from .attachments import Attachment

    if name == 'ext':
        return super().__setattr__('ext', value)
    if not hasattr(value, "__dict__"):
        value = SimpleWrapper(value)

    if extended:
        setattr(self.ext, name, value)
    else:
        super().__setattr__(name, value)

    attr_obj = getattr(self.ext if extended else self, name)

    setattr(attr_obj, "_parent_block", self)

    if isinstance(attr_obj, Attachment):
        attr_obj._get_filepath()
    elif hasattr(attr_obj, "refresh_attachments"):
        attr_obj.refresh_attachments()

    methods = ((_add_comments_to_parent(name), "add_comments"),
            (_clear_comments_from_parent(name), "clear_comments"))

    attr_obj._reserved = ['ext'] if not hasattr(attr_obj,"_reserved") else attr_obj._reserved
    for method, method_name in methods:
        attr_obj._reserved.append(method_name)
        bound = method.__get__(attr_obj, type(attr_obj))
        setattr(attr_obj, method_name, bound)

    self._props_changed = True

_meta_to_front()

Moves metadata to the front of _key_order. Metadata will always be serialized first, but being elsewhere in the order leads to unexpected results when moving other keys to desired indices.

Source code in FoSpy/blocks/blocks.py

def _meta_to_front(self):
    """
    Moves metadata to the front of `_key_order`. Metadata will always be
    serialized first, but being elsewhere in the order leads to unexpected
    results when moving other keys to desired indices.
    """
    try:
        meta_idx =self._key_order.index("metadata")
        self._key_order.pop(meta_idx)
    # TODO: Better handling
    except Exception:
        pass
    self._key_order.insert(0,"metadata")

_rename_validators(validators)

Realigns any renamed attributes with their expected validator.

Parameters:

Name	Type	Description	Default
validators	dict	A dictionary mapping attribute names to validators, returned by either build_validators or build_req_validators	required

Source code in FoSpy/blocks/blocks.py

def _rename_validators(self, validators:dict):
    """
    Realigns any [renamed][FoSpy.blocks.blocks.SingleBlock.rename_block]
    attributes with their expected validator.

    Args:
        validators:
            A dictionary mapping attribute names to validators, returned by
            either
            [`build_validators`][FoSpy.blocks.blocks.SingleBlock.build_validators]
            or
            [`build_req_validators`][FoSpy.blocks.blocks.SingleBlock.build_req_validators]
    """
    if hasattr(self, "rename"):
        for name, rename in self.rename.serialize(shallow=True, clean=True).items():
            if name in validators and rename not in validators:
                val = validators.pop(name)
                validators[rename] = val
    return validators

_resolve_relative_path(path)

Resolves a relative object path string into an object or function.

Example:

    mySyn._resolve_relative_path("materials[1].ratio")
    ## returns mySyn.materials[1].ratio

Source code in FoSpy/blocks/blocks.py

def _resolve_relative_path(self, path: str):
    """
    Resolves a relative object path string into an object or function.

    Example:
    ```
        mySyn._resolve_relative_path("materials[1].ratio")
        ## returns mySyn.materials[1].ratio
    ```
    """
    import re

    _index_re = re.compile(r"^([A-Za-z_]\w*)\[(\d+)\]$")
    obj = self

    for part in path.split("."):

        # Case: attr[index]
        m = _index_re.match(part)
        if m:
            attr_name, idx_str = m.groups()
            idx = int(idx_str)

            # Get the ListBlock
            obj = getattr(obj, attr_name)

            # Index into its _objs
            obj = obj._objs[idx]
            continue

        # Case: simple attribute
        obj = getattr(obj, part)

    return obj

_subprocess(target, args=(), **kwargs)

Source code in FoSpy/blocks/blocks.py

def _subprocess(self, target, args=(), **kwargs):
    from multiprocessing import Process

    if kwargs is None:
        kwargs={}

    p = Process(target=target, args=args, kwargs=kwargs)
    p.start()

_update_src()

Source code in FoSpy/blocks/blocks.py

def _update_src(self):
    if self._constructed and self._props_changed:
        self._sourceDict = self.serialize(clean=True)
        self._props_changed = False

    return self._sourceDict   

add_all_calc_routines(recursive=False)

Schedule all available calculation routines.

Adds all available calc_routines to self._calc_routines using list_avail_routines() and add_calc_routine().

Parameters:

Name	Type	Description	Default
recursive	bool	Optional recursion. See SingleBlock.list_avail_routines()	False

Source code in FoSpy/blocks/blocks.py

def add_all_calc_routines(self, recursive:bool=False):
    """
    Schedule all available calculation routines.

    Adds all available calc_routines to `self._calc_routines` using
    [`list_avail_routines()`][FoSpy.blocks.blocks.SingleBlock.list_avail_routines]
    and
    [`add_calc_routine()`][FoSpy.blocks.blocks.SingleBlock.add_calc_routine].

    Args:
        recursive:
            Optional recursion. See `SingleBlock.list_avail_routines()`
    """
    for path in self.list_avail_routines(recursive=recursive, abbreviated=False):
        self.add_calc_routine(path)

add_block(block_name, type_alias, value=[])

Adds an unexpected attribute with a validator mapped by type_alias. Unexpected attributes not requiring a validator can be set directly without using this method.

Parameters:

Name	Type	Description	Default
block_name	str	new unexpected attribute name	required
type_alias	str	Alias mapped to the desired validator in parsing.validation.aliases. For more information on how aliases are used, see __setattr__.	required

Source code in FoSpy/blocks/blocks.py

def add_block(self, block_name:str, type_alias:str, value=[]):
    """
    Adds an unexpected attribute with a validator mapped by `type_alias`.
    Unexpected attributes not requiring a validator can be set directly
    without using this method.

    Args:
        block_name: new unexpected attribute name
        type_alias:
            Alias mapped to the desired validator in
            [`parsing.validation.aliases`][FoSpy.parsing.validation.aliases].
            For more information on how aliases are used, see
            [`__setattr__`][FoSpy.blocks.blocks.SingleBlock.__setattr__].
    """
    if hasattr(self,block_name):
        raise ValueError(f"This object already has attribute: '{block_name}'.")
    return setattr(self, f"{block_name}${type_alias}", value)

add_calc_comment(key, comment, calc_id)

Add a calculated comment to be injected during serialization.

WARNING: This function can leave outdated calculations in comments after serialization. Recommended to use add_calc_routine() instead.

Calculated comments are for user information and will be formatted to be skipped by the parser when reading the file. This is useful for comments that should be recalculated and refreshed during saving/serialization, like weight percentages or summaries.

Parameters:

Name	Type	Description	Default
key	str	attribute to attach the calculated comment to. Comments appear above their attached attributes in FOS format.	required
comment	str	comment text without comment formatting (don't include // or !)	required
calc_id	str	unique identifier for the calculated comment. If it matches an existing comment (like when refreshing a value), the comment is overwritten	required

Source code in FoSpy/blocks/blocks.py

def add_calc_comment(self, key:str, comment:str, calc_id:str):
    """
    Add a calculated comment to be injected during serialization.

    WARNING: This function can leave outdated calculations in comments after
    serialization. Recommended to use `add_calc_routine()` instead.

    Calculated comments are for user information and will be formatted to be
    skipped by the parser when reading the file. This is useful for comments
    that should be recalculated and refreshed during saving/serialization,
    like weight percentages or summaries.

    Args:
        key:
            attribute to attach the calculated comment to. Comments appear
            above their attached attributes in FOS format.
        comment:
            comment text without comment formatting (don't include // or !)
        calc_id:
            unique identifier for the calculated comment. If it matches an
            existing comment (like when refreshing a value), the comment is
            overwritten

    """
    calc_comments = self._calc_comments.get(key, {})
    self._calc_comments[key] = calc_comments
    self._calc_comments[key][calc_id]=comment

add_calc_routine(path, **kwargs)

Schedules a calculated comment.

Appends a _calc_routine()-decorated function to self._calc_routines to be run at serialization.

Used to add calculated comments that should be refreshed during serialization.

Parameters:

Name	Type	Description	Default
path	str	a relative path string that can be resolved into a _calc_routine()-decorated function	required
**kwargs	any	optional key word arguments to be passed to the function at path.	{}

Raises:

Type	Description
TypeError	the attr or method at path is not registered as a _calc_routine

Example:

    mySyn.add_calc_routine("materials.add_weight_pcts", typ="reagent")
    ## mySyn.materials.add_weight_pcts(typ="reagent") is now scheduled
    ## to run at serialization

Source code in FoSpy/blocks/blocks.py

def add_calc_routine(self, path:str, **kwargs):
    """
    Schedules a calculated comment.

    Appends a
    [`_calc_routine()`][FoSpy.blocks._blockUtils._calc_routine]-decorated
    function to `self._calc_routines` to be run at
    [serialization][FoSpy.blocks.blocks.SingleBlock.serialize].

    Used to add calculated comments that should be refreshed during
    serialization.

    Args:
        path:
            a relative path string that can be resolved into a
            `_calc_routine()`-decorated function
        **kwargs (any):
            optional key word arguments to be passed to the function at
            path.

    Raises:
        TypeError:
            the attr or method at path is not registered as a
            _calc_routine

    Example:
    ```
        mySyn.add_calc_routine("materials.add_weight_pcts", typ="reagent")
        ## mySyn.materials.add_weight_pcts(typ="reagent") is now scheduled
        ## to run at serialization
    ```
    """

    func = self._resolve_relative_path(path)
    if not getattr(func, "_is_calc_routine", False):
        raise TypeError(f"'{path}' is not a registered calc routine.")

    self._meta.routine_paths.append(path)

    def wrapped(f=func, k=kwargs):
        return f(**k)

    self._calc_routines.append(wrapped)

add_comments(*comments)

Default behavior to be overwritten when attached to a parent block.

If a SingleBlock is stored as an attribute of another SingleBlock, this method will be overwritten by the parent's __setattr__.

Source code in FoSpy/blocks/blocks.py

def add_comments(self, *comments):
    """
    Default behavior to be overwritten when attached to a parent block.

    If a `SingleBlock` is stored as an attribute of another `SingleBlock`,
    this method will be overwritten by the parent's `__setattr__`.
    """
    keys = list(self.get_req_validators())

    keys = [k for k in keys if k != "metadata"]
    fallback = [k for k in self._key_order if k != "metadata"]
    if not (keys or fallback):
        raise ValueError("This object has not been correctly attached to a parent block "
                         "and could not identify a required key to attach to.")

    first = keys[0] if keys else fallback[0]

    self._meta.comments.setdefault(first, [])
    for comment in comments:
        self._meta.comments[first].append(comment)

add_dispatch(blockDict, dispatch_key, **kwargs) classmethod

Source code in FoSpy/blocks/files.py

@classmethod
def add_dispatch(cls, blockDict, dispatch_key, **kwargs):
    _ = SingleBlock.add_dispatch(blockDict, dispatch_key, **kwargs)

    from .. import _errors as err
    from ._blockUtils import _unwrap_block

    from .metadata import MetaData
    metadata = blockDict.get("metadata", None)

    if metadata is None:
        raise err.MissingPropertyError("metadata", cls, blockDict=blockDict)

    metadata = _unwrap_block(metadata)
    fos_type = metadata.pop("fos_type", None)
    if fos_type is None:
        raise err.MissingPropertyError("fos_type", MetaData, blockDict=metadata)

    return {dispatch_key: fos_type}

build_req_validators() classmethod

Builds required keys and validators mapped to subclass.

Walks all parent classes and builds a map of all keys that are required during __init__, and their respective validation routines. Subclasses are mapped to expected keys and validations in parsing.validation. Subclass validations override parent classes when applicable.

Returns:

Name	Type	Description
merged	dict	Maps required keys to validation routines. Routines may be a class constructor or a func taking one arg.

Example:

>>> SingleBlock.build_req_validators()
{
    "name": str,
    "type": str,
    "formula": ChemFormula, # class constructor
    "supplier": str,
    "cas": str,
    "form": str,
    "env": str,
    "ratio": validators.material.ratio # validator function
}

Source code in FoSpy/blocks/blocks.py

@classmethod
def build_req_validators(cls):
    """
    Builds required keys and validators mapped to subclass.

    Walks all parent classes and builds a map of all keys that are required
    during `__init__`, and their respective validation routines. Subclasses
    are mapped to expected keys and validations in
    [`parsing.validation`][FoSpy.parsing.validation]. Subclass validations
    override parent classes when applicable.

    Returns:
        merged (dict):
            Maps required keys to validation routines. Routines may be
            a class constructor or a func taking one arg.
    Example:
        ``` 
        >>> SingleBlock.build_req_validators()
        {
            "name": str,
            "type": str,
            "formula": ChemFormula, # class constructor
            "supplier": str,
            "cas": str,
            "form": str,
            "env": str,
            "ratio": validators.material.ratio # validator function
        }
        ```
    """
    from ..parsing.validation import required_keys
    from ._blockUtils import _get_prop_mro, _merge_vals
    merged = {}
    # mro = list(reversed(cls.__mro__))
    # for i, base in enumerate(mro):
    #     base_reqs = required_keys.get(base,{})
    #     for key, validator in base_reqs.items():
    #         # allow subclasses to remove parent requirements.
    #         if not validator:
    #             merged.pop(key, None)
    #         else:
    #             merged[key] = validator

    req_mro = _get_prop_mro(cls, required_keys)
    for i in range(len(req_mro)):
        merged = _merge_vals(merged, req_mro, i)

    merged.pop("__all__")

    return merged

build_validators() classmethod

Builds expected keys and validators mapped to subclass.

Walks all parent classes and builds a map of all keys that are expected (required or optional), and their respective validation routines. Subclasses are mapped to keys and validations in parsing.validation. Subclass validations override parent classes when applicable.

See build_req_validators

Source code in FoSpy/blocks/blocks.py

@classmethod
def build_validators(cls):
    """
    Builds expected keys and validators mapped to subclass.

    Walks all parent classes and builds a map of all keys that are expected
    (required or optional), and their respective validation routines.
    Subclasses are mapped to keys and validations in
    [`parsing.validation`][FoSpy.parsing.validation]. Subclass validations
    override parent classes when applicable.

    See
    [`build_req_validators`][FoSpy.blocks.blocks.SingleBlock.build_req_validators]
    """
    from ..parsing.validation import required_keys, optional_keys
    from ._blockUtils import _merge_vals, _get_prop_mro
    from .._docs.properties import _validator_rules
    merged = {}
    # for base in reversed(cls.__mro__):
    #     for key_set in (required_keys, optional_keys):
    #         base_reqs = key_set.get(base,{})
    #         for key, validator in base_reqs.items():
    #             # allow subclasses to remove parent requirements.
    #             if validator is False:
    #                 merged.pop(key, None)
    #             else:
    #                 merged[key] = validator
    req_mro = _get_prop_mro(cls, required_keys)
    opt_mro = _get_prop_mro(cls, optional_keys)

    for i in range(len(req_mro)): # req_mro and opt_mro are the same length
        merged = _merge_vals(merged, req_mro, i)
        merged = _merge_vals(merged, opt_mro, i)

    universal_val = merged.pop("__all__")

    @_validator_rules(inherit_from=universal_val)
    def universal_val_method(cls, *_, _m=universal_val, **__):
        return _m(*_, **__)

    cls.universal_val = universal_val_method

    return merged

check_attachments()

Source code in FoSpy/blocks/files.py

def check_attachments(self):
    pass

cleanup()

Source code in FoSpy/blocks/files.py

def cleanup(self):
    if self._tempdir is not None:
        self._tempdir.cleanup()

clear_all_comments()

Source code in FoSpy/blocks/blocks.py

def clear_all_comments(self):
    self._meta.comments = {}
    for attr, val in self.__dict__.items():
        if attr.startswith("_") or attr in self._reserved:
            continue
        if hasattr(val, "clear_all_comments"):
            val.clear_all_comments()

clear_comments()

Clear comments attached to top-level attributes only.

Source code in FoSpy/blocks/blocks.py

def clear_comments(self):
    """
    Clear comments attached to top-level attributes only.
    """
    self._meta.comments = {}

copy(path=None)

Returns a deep copy of self by saving to a temp file and reloading.

Save/Reload allows attachment tracking to remain intact where serialization/reconstruction would normally desync.

Source code in FoSpy/blocks/files.py

def copy(self, path=None):
    """
    Returns a deep copy of self by saving to a temp file and reloading.

    Save/Reload allows attachment tracking to remain intact where
    serialization/reconstruction would normally desync.
    """
    if path is None:
        # get temporary save location
        loc = self._temppath / "~temp~.fos"
    else:
        path = Path(path)
        loc = path

    # cache current source file
    src = self._sourceFile

    # save and restore cached source file
    self.save(loc)
    self._sourceFile = src

    # load copy from temp file
    copy = self.fromFile(loc)
    # desync copy from temp file
    copy._sourceFile = path
    return copy

default_key_order(deep=False)

Set to default attribute order for serialization.

Rearrange attribute order to the default order assigned by build_validators

Parameters:

Name	Type	Description	Default
deep	bool	When true, recursively calls default_key_order on any other SingleBlock objects stored in attributes.	False

Source code in FoSpy/blocks/blocks.py

def default_key_order(self, deep:bool=False):
    """
    Set to default attribute order for serialization.

    Rearrange attribute order to the default order assigned by
    [`build_validators`][FoSpy.blocks.blocks.SingleBlock.build_validators]

    Args:
        deep:
            When true, recursively calls `default_key_order` on any other
            `SingleBlock` objects stored in attributes.
    """
    new_order = []
    for key in self.get_validators():
        if key != "ext" and key in self.serialize(shallow=True):
            new_order.append(key)
    for key in self._key_order:
        if key not in new_order:
            new_order.append(key)
    self._key_order = new_order
    self._meta_to_front()

    if deep:
        for name, obj in self.__dict__.items():
            if not name.startswith("_") and hasattr(obj, "default_key_order"):
                obj.default_key_order(deep=True)

dispatch_subclass(*args, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def dispatch_subclass(cls, *args, **kwargs):
    # fallback.
    # overridden by setup_dispatch decorator
    return cls

dispatcher(dispatch_method) staticmethod

Decorate a classmethod to dispatch to other subclasses.

Not normally used directly. See setup_dispatch decorator.

Source code in FoSpy/blocks/blocks.py

@staticmethod
def dispatcher(dispatch_method: Callable[..., dict])->classmethod:
    """
    Decorate a classmethod to dispatch to other subclasses.

    Not normally used directly. See
    [`setup_dispatch`][FoSpy.blocks.blocks.SingleBlock.setup_dispatch]
    decorator.
    """

    @classmethod
    def dispatch_subclass(cls:type[BlockType], blockDict, _add_defaults=False, **kwargs):
        from .. import _errors as err
        for_template = kwargs.get("for_template", False)

        block_dispatch = blockDict.setdefault("__dispatch__", {})
        visited = block_dispatch.setdefault("visited", [])
        cls_dispatch = getattr(cls, "__dispatch__", None)
        # shorthand for keying dispatch parameters
        d=cls_dispatch

        if d['dispatch_from'] in visited and (
            cls in visited or
            d is None or
            d['from_key'] is None):
            return cls
        try:
            blockDict = dispatch_method(cls, blockDict, add_defaults=_add_defaults, **kwargs)
        except Exception as e:
            if not for_template:
                raise e

        visited.append(cls)

        if d['dispatch_from'] not in visited:
            blockDict.pop("__dispatch__", None)
            return d['dispatch_from'].dispatch_subclass(blockDict, _add_defaults=_add_defaults, **kwargs)


        dispatch_val = block_dispatch.get(d['from_key'],
                            blockDict.get(d['from_key'], None))

        dispatched_cls = d['registry'].get(dispatch_val, d['registry'].get(None, cls))

        if dispatched_cls is cls and not d['allow_self']:
            if not for_template:
                raise err.BlockDispatchError(
                    f"The following blockDict was dispatched to {cls.__name__} "
                    "but could not be dispatched further. "
                    f"{cls.__name__} blocks are not allowed without a subclass.")
            return cls

        return dispatched_cls.dispatch_subclass(blockDict, **kwargs)
    return dispatch_subclass

fill_staged_template(prop_name, **kwargs)

Source code in FoSpy/blocks/blocks.py

def fill_staged_template(self, prop_name, **kwargs):
    from .template import TemplateBlock

    prop_key = prop_name.split("$")[0] if "$" in prop_name else prop_name

    template = self._staged_templates.pop(prop_key, None)
    if template is None:
        prop_name, _ = self.stage_template(prop_name)
        return self.fill_staged_template(prop_name, **kwargs)

    prop_name = prop_key

    filled = template.fill(staged=True,**kwargs)

    if isinstance(filled, TemplateBlock):
        return self.stage_template(prop_name, filled)

    try:
        setattr(self, prop_name, filled)
    except Exception as e:
        raise Exception(f"Template was filled but could not be assigned {prop_name}") from e

    filled = getattr(self, prop_name)

    if isinstance(self, TemplateBlock):
        self.fill()

    return prop_name, filled

find_attachments()

Source code in FoSpy/blocks/blocks.py

def find_attachments(self):
    attachments = []
    for propVal in self.get_prop_dict().values():
        if isinstance(propVal, ListBlock):
            for obj in propVal._objs:
                attachments.extend([
                    o for o in obj.find_attachments()
                    if o not in attachments
                ])
        elif isinstance(propVal, SingleBlock):
            attachments.extend([
                o for o in propVal.find_attachments()
                if o not in attachments
            ])
    return attachments

find_fileblock()

Finds the parent file object.

Walks upward through _parent_block attributes until a FileBlock instance is found and returns that instance.

Source code in FoSpy/blocks/blocks.py

def find_fileblock(self):
    """
    Finds the parent file object.

    Walks upward through `_parent_block` attributes until a
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance is found and
    returns that instance.
    """
    from .files import FileBlock
    from .._errors import FileBlockNotFoundError

    blk = self
    while blk is not None:
        if isinstance(blk, FileBlock):
            return blk
        if hasattr(blk,"_parent_block"):
            blk = blk._parent_block
        else:
            blk = None
    raise FileBlockNotFoundError("Could not find a FileBlock containing the current object")

find_tempdir()

Find the parent file object's temporary directory.

Finds the temporary directory created by the FileBlock instance containing this block as one of its attributes.

Returns:

Name	Type	Description
tempdir	tempfile.TemporaryDirectory	The temporary directory created by the parent file object

Source code in FoSpy/blocks/blocks.py

def find_tempdir(self):
    """
    Find the parent file object's temporary directory.

    Finds the temporary directory created by the
    [`FileBlock`][FoSpy.blocks.files.FileBlock] instance containing this
    block as one of its attributes. 

    Returns:
        tempdir (tempfile.TemporaryDirectory):
            The temporary directory created by the parent file object
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_tempdir"):
        return fileblock._tempdir
    else:
        raise AttributeError("Could not find a temporary directory attached to this object's FileBlock")

find_temppath()

Find the parent file object's temporary directory path.

Similar to find_tempdir but returns the corresponding pathlib.Path object instead.

Source code in FoSpy/blocks/blocks.py

def find_temppath(self):
    """
    Find the parent file object's temporary directory path.

    Similar to [`find_tempdir`][FoSpy.blocks.blocks.Block.find_tempdir] but
    returns the corresponding `pathlib.Path` object instead.
    """
    fileblock = self.find_fileblock()
    if hasattr(fileblock, "_temppath"):
        return fileblock._temppath
    if hasattr(fileblock, "_temppdir"):
        raise AttributeError("This object's FileBlock has a temporary directory but no path mapped to it. "
                             "Use obj.find_tempdir() instead")
    raise AttributeError("Could not find a temporary directory object or path "
                         "attached to this object's FileBlock.")

fromFile(filepath) classmethod

Source code in FoSpy/blocks/files.py

@classmethod
def fromFile(cls, filepath):
    abspath = os.path.abspath(filepath)
    pathstr = str(abspath)
    try:
        ext = pathstr.lower().split(".")[-1]
    except IndexError:
        raise ValueError(f"Could not determine extension for filepath: {pathstr}")

    if ext not in EXT_READ_MAP:
        raise ValueError(f"Unrecognized file extension '{ext}'. Supported extensions are: {list(EXT_READ_MAP.keys())}")

    blockDict = EXT_READ_MAP[ext](abspath)
    abspath = blockDict.pop("_sourceFile", abspath)

    return cls(blockDict, _sourceFile=abspath)

get_file_name()

Source code in FoSpy/blocks/files.py

def get_file_name(self):
    if self._sourceFile is None:
        return "<Unsaved FileBlock>"

    if hasattr(self, "_ext_file") and self._ext_file is not None:
        filepath = self._ext_file
    else:
        filepath = self._sourceFile

    return os.path.basename(filepath)

get_id()

Source code in FoSpy/blocks/files.py

def get_id(self):
    try:
        if self._sourceFile is not None:
            from pathlib import Path
            fp = Path(self._sourceFile)
            return "file_name", str(fp.name)
        else:
            return "file_name", "<Unsaved FileBlock>"
    except Exception:
        return super().get_id()

get_parent_prop()

Source code in FoSpy/blocks/blocks.py

def get_parent_prop(self):
    if not hasattr(self, "_parent_block"):
        return None
    parent_blk = self._parent_block

    if isinstance(parent_blk, SingleBlock):
        for prop, val in parent_blk.get_prop_dict().items():
            if val is self:
                return prop

        raise err.FoSpyStructureError(f"Block {self} points to a parent block {parent_blk} that does not contain it as a property.")

    elif isinstance(parent_blk, ListBlock):
        return f"[{parent_blk.get_idx(self)}]"

    raise err.FoSpyStructureError(f"Block {self} has an unknown parent block type: {type(parent_blk)}")

get_prop_dict()

Returns a dictionary mapping property names to their live object values.

Source code in FoSpy/blocks/blocks.py

def get_prop_dict(self):
    """Returns a dictionary mapping property names to their live object values."""
    serial = self.serialize(shallow=True, clean=True)
    out = {}
    for prop in serial:
        if "$" in prop:
            prop = prop.split("$")[0]

        # guard for when templateblocks add staged templates to their serial
        if hasattr(self, prop):
            out[prop] = getattr(self, prop)

    return out

get_prop_path()

Source code in FoSpy/blocks/blocks.py

def get_prop_path(self):
    from .files import FileBlock

    if not hasattr(self, "_parent_block"):
        if isinstance(self, FileBlock):
            root_path = f"<{str(self.get_file_name())}>"
        else:
            root_path = f"<Root {type(self).__name__}"
            if isinstance(self, SingleBlock):
                id_key, id_txt = self.get_id()
                if id_key is not None:
                    root_path += f" ({id_key}={id_txt})"
            root_path += ">"
        return root_path

    parent_path = self._parent_block.get_prop_path()
    parent_prop = self.get_parent_prop()

    if "[" not in parent_prop:
        return parent_path + "." + parent_prop

    return parent_path + parent_prop

get_req_validators()

Overrides class validators with any renamed properties.

Similar to class method: build_req_validators, but uses _rename_validators to align any renamed properties with their original validators.

Source code in FoSpy/blocks/blocks.py

def get_req_validators(self):
    """
    Overrides class validators with any renamed properties.

    Similar to class method:
    [`build_req_validators`][FoSpy.blocks.blocks.SingleBlock.build_req_validators],
    but uses
    [`_rename_validators`][FoSpy.blocks.blocks.SingleBlock._rename_validators]
    to align any renamed properties with their original validators.
    """
    return self._rename_validators(self.build_req_validators())

get_validators()

Overrides class validators with any renamed properties.

Similar to class method: build_validators, but uses _rename_validators to align any renamed properties with their original validators. Also adds any optional key overrides added by key$alias syntax.

Returns:

Name	Type	Description
vals	dict	maps expected keys to validation routines.

Source code in FoSpy/blocks/blocks.py

def get_validators(self):
    """
    Overrides class validators with any renamed properties.

    Similar to class method:
    [`build_validators`][FoSpy.blocks.blocks.SingleBlock.build_validators],
    but uses
    [`_rename_validators`][FoSpy.blocks.blocks.SingleBlock._rename_validators]
    to align any renamed properties with their original validators. Also
    adds any optional key overrides added by key$alias syntax.

    Returns:
        vals (dict): maps expected keys to validation routines.
    """
    vals = self._rename_validators(self.build_validators())
    if hasattr(self, "_key_overrides"):
        for key, val in self._key_overrides.items():
            vals[key] = val
    return vals

has_staged()

Source code in FoSpy/blocks/blocks.py

def has_staged(self):
    if len(self._staged_templates) > 0:
        return True

    for val in self.get_prop_dict().values():
        if hasattr(val, "has_staged") and val.has_staged():
            return True

    return False

inject_defaults(blockDict, *args, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def inject_defaults(cls, blockDict, *args, **kwargs):
    # fallback.
    # overridden by setup_dispatch decorator
    return blockDict

inspect() classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def inspect(self):
    # for breaking to debugger from gui
    raise Exception("put a break point here")

key_to_idx(key, idx)

Reorder attributes for serialization.

Move any attribute name to a specific index in _key_order for serialization order. The invisible "metadata" key is always refreshed to the front of the list, so indices are effectively 1-based.

Parameters:

Name	Type	Description	Default
key	str	name of attribute to reorder	required
idx	int	new index in _key_order	required

Source code in FoSpy/blocks/blocks.py

def key_to_idx(self, key:str, idx:int):
    """
    Reorder attributes for serialization.

    Move any attribute name to a specific index in `_key_order` for
    serialization order. The invisible `"metadata"` key is always refreshed
    to the front of the list, so indices are effectively 1-based.

    Args:
        key: name of attribute to reorder
        idx: new index in _key_order
    """
    self._meta_to_front()
    try:
        old_idx = self._key_order.index(key)
        self._key_order.pop(old_idx)
    # TODO: Better handling
    except Exception:
        pass
    self._key_order.insert(idx, key)

keys_to_end(*args)

Reorder attributes for serialization.

Move any attribute names in *args to the end of _key_order to be serialized last. Order within *args is maintained in result.

Source code in FoSpy/blocks/blocks.py

def keys_to_end(self, *args):
    """
    Reorder attributes for serialization.

    Move any attribute names in `*args` to the end of _key_order to be
    serialized last. Order within `*args` is maintained in result.
    """
    def remove_alias(key):
        return key.split("$")[0] if "$" in key else key
    for key in self.serialize(shallow=True):
        if not key.startswith("_") and remove_alias(key) not in self._key_order:
            self._key_order.append(remove_alias(key))
    for key in args:
        try:
            idx = self._key_order.index(key)
            self._key_order.pop(idx)
        # TODO: Better handling
        except Exception:
            pass
        self._key_order.append(key)
    self._meta_to_front()

keys_to_front(*args)

Reorder attributes for serialization.

Move any attribute names in *args to the front of _key_order to be serialized first. Order within *args is maintained in result.

Source code in FoSpy/blocks/blocks.py

def keys_to_front(self,*args):
    """
    Reorder attributes for serialization.

    Move any attribute names in `*args` to the front of _key_order to be
    serialized first. Order within `*args` is maintained in result.
    """
    try:
        meta_idx = args.index("metadata")
        args.pop(meta_idx)
    # TODO: Better handling
    except Exception:
        pass

    new_order = []
    for key in args:
        new_order.append(key)
    for key in self._key_order:
        if key not in new_order:
            new_order.append(key)
    self._key_order = new_order
    self._meta_to_front()

list_avail_routines(recursive=False, prefix='', abbreviated=False)

Lists all calc routines available to be added to self._calc_routines.

Non-abbreviated calc routine strings can be passed directly to self.add_calc_routine()

Parameters:

Name	Type	Description	Default
recursive	bool	If True, recursively walks all attributes and appends results from self.attr.list_avail_routines() to result. Otherwise only identifies methods of self.	False
prefix	str	Used during recursion to build relative paths	''
abbreviated	bool	optionally abbreviate recursively repeated routines for similar objects into one line. This line cannot be passed to self.add_calc_routine()	False

Returns:

Name	Type	Description
routines	list	list of strings describing _calc_routine-decorated methods. Non-abbreviated calc routine strings can be passed directly to self.add_calc_routine()

Example:

    mySyn.list_avail_routines()
    ## returns []
    mySyn.list_avail_routines(recursive=True)
    ## returns [
    ##     'reaction.add_nom_MW',
    ##     'materials.add_weight_pcts',
    ##     'materials[0].add_MW',
    ##     'materials[1].add_MW',
    ##     ... 6 total materials with the same calc_routine
    ##     'materials[5].add_MW'
    ## ]
    mySyn.list_avail_routines(recursive=True, abbreviated=True)
    ## returns [
    ##     'reaction.add_nom_MW',
    ##     'materials.add_weight_pcts',
    ##     'materials[i].add_MW; i = [0, 1, 2, 3, 4, 5]'
    ## ]

Source code in FoSpy/blocks/blocks.py

def list_avail_routines(self, recursive:bool=False, prefix:str="", abbreviated:bool=False):
    """
    Lists all calc routines available to be added to `self._calc_routines`.

    Non-abbreviated calc routine strings can be passed directly to
    `self.add_calc_routine()`

    Args:
        recursive:
            If True, recursively walks all attributes and appends results
            from `self.attr.list_avail_routines()` to result. Otherwise only
            identifies methods of `self`.

        prefix: Used during recursion to build relative paths
        abbreviated:
            optionally abbreviate recursively repeated routines for similar
            objects into one line. This line cannot be passed to
            `self.add_calc_routine()`

    Returns:
        routines (list): 
            list of strings describing _calc_routine-decorated methods.
            Non-abbreviated calc routine strings can be passed directly to
            `self.add_calc_routine()`

    Example:
    ```
        mySyn.list_avail_routines()
        ## returns []
        mySyn.list_avail_routines(recursive=True)
        ## returns [
        ##     'reaction.add_nom_MW',
        ##     'materials.add_weight_pcts',
        ##     'materials[0].add_MW',
        ##     'materials[1].add_MW',
        ##     ... 6 total materials with the same calc_routine
        ##     'materials[5].add_MW'
        ## ]
        mySyn.list_avail_routines(recursive=True, abbreviated=True)
        ## returns [
        ##     'reaction.add_nom_MW',
        ##     'materials.add_weight_pcts',
        ##     'materials[i].add_MW; i = [0, 1, 2, 3, 4, 5]'
        ## ]
    ```
    """
    routines = []

    # Local routines
    for name in dir(self):
        attr = getattr(self, name)
        if callable(attr) and getattr(attr, "_is_calc_routine", False):
            routines.append(prefix + name)

    if recursive:
        for attr, val in self.__dict__.items():
            if attr.startswith("_"):
                continue

            # Recurse into child blocks
            if hasattr(val, "list_avail_routines"):
                child_prefix = f"{prefix}{attr}."
                routines.extend(val.list_avail_routines(True, child_prefix, abbreviated))

    return routines

make_template(template_name, *args)

Converts self into a template of its original subclass.

Returns a copy of self as a template of its original subclass, with specified fields replaced with template types. See TemplateClass for more information on template generation.

Parameters:

Name	Type	Description	Default
template_name	str	All templates require an identifying name.	required
*args	str	properties to clear and replace with template types.	()

Source code in FoSpy/blocks/blocks.py

def make_template(self,template_name:str,*args:str):
    """
    Converts `self` into a template of its original subclass.

    Returns a copy of `self` as a template of its original subclass, with
    specified fields replaced with template types. See
    [`TemplateClass`][FoSpy.blocks.blocks.SingleBlock.TemplateClass] for
    more information on template generation.

    Args:
        template_name: All templates require an identifying name.
        *args: properties to clear and replace with template types.
    """

    from ..parsing.format_fos import format_field

    serial = self.serialize(keepListType=True)
    validators = self.get_validators()
    for key in args:
        val = validators.get(key, None)
        if isinstance(val,type) and (issubclass(val, SingleBlock) or issubclass(val, ListBlock)):
            serial.setdefault(key, [{}])
        else:
            serial[key] = format_field("template")
    serial["template_name"] = template_name
    return self.TemplateClass(*args)(serial)

matches_file()

Source code in FoSpy/blocks/files.py

def matches_file(self):
    reloaded = self.fromFile(self._sourceFile)

    return self.__eq__(reloaded, suppress_routine_paths=True)

package(pkg_fp)

Source code in FoSpy/blocks/files.py

def package(self, pkg_fp):
    import shutil
    pkg_fp = Path(pkg_fp)
    pkg_dir = self._temppath / "~package~"
    pkg_dir.mkdir(exist_ok=True)

    attachment_dir = pkg_dir / "attachments"
    attachment_dir.mkdir(exist_ok=True)

    copy = self.copy()

    for attachment in copy.find_attachments():
        attachment.path = "attachments"

    copy._sourceFile = pkg_dir / (pkg_fp.stem + ".fos")
    copy.refresh_attachments(new_copy=True, overwrite=False)
    copy.save()

    pkg_fp = pkg_fp.parent / pkg_fp.stem
    fosx_fp = pkg_fp.with_suffix(".fosx")
    zip_fp = Path(shutil.make_archive(pkg_fp, "zip", pkg_dir))

    if fosx_fp.exists():
        fosx_fp.unlink()

    zip_fp.rename(fosx_fp)

    shutil.rmtree(pkg_dir)

print_summary(mode='cli') classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def print_summary(cls, mode="cli"):
    from .._docs.properties import get_summary

    print(get_summary(cls, mode=mode))

reflex(serialize=True, include_temp_names=True, clean=False, **kwargs) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def reflex(cls, serialize=True, include_temp_names=True, clean=False, **kwargs):
    """

    """
    kwargs.setdefault("template_name", f"Reflexed {cls.__name__}")

    reflexor = cls.TemplateClass()

    empty = reflexor(kwargs)

    if not serialize:
        return empty

    serial = empty.serialize(clean=clean)

    if include_temp_names:
        return serial

    from ._blockUtils import _prune_template_names
    serial = _prune_template_names(serial)
    return serial

refresh_attachments(new_copy=None, overwrite=None, **kwargs)

Source code in FoSpy/blocks/blocks.py

def refresh_attachments(self, new_copy=None, overwrite=None, **kwargs):
    from .attachments import Attachment

    if new_copy is None:
        new_copy = self._att_new_copy
    if overwrite is None:
        overwrite = self._att_overwrite

    for propDict in self.__dict__, self.ext.__dict__:
        for key, val in propDict.items():
            if key.startswith("_") or key in self._reserved:
                continue
            if hasattr(val, "refresh_attachments"):
                val.refresh_attachments(new_copy=new_copy, overwrite=overwrite, **kwargs)
            elif isinstance(val, Attachment) and hasattr(val, "refresh"):
                val.refresh(new_copy=new_copy, overwrite=overwrite, **kwargs)

register_dispatch(registry_val, from_parent=None, setup_from_key=None, setup_allow_self=True, inherit_dispatch=False, defaults=None) classmethod

Decorate a subclass to be dispatched from a parent class.

The subclass will also be decorated with the parent's setup_dispatch to set up its own dispatch parameters.

Parameters:

Name	Type	Description	Default
registry_val		The value to be found in a dispatched blockDict which will be mapped to the subclass in the parent class's registry.	required
from_parent	type[BlockType]	The parent class to register the subclass to. Defaults to the class which calls the method, but may be overridden if a non-SingleBlock abstract class is the parent.	None
setup_from_key		Passed as from_key to the parents setup_dispatch decorator.	None
setup_allow_self		Passed as allow_self to the parent's setup_dispatch decorator.	True
inherit_dispatch		Whether the decorated class should inherit its parent's add_dispatch method	False
defaults	dict	Default values that should be injected into the blockDict when trying to guarantee dispatching to the registered class. Defaults to {}. If parent's from_key is public, defaults will be updated with {from_key: registry_val}	None

Source code in FoSpy/blocks/blocks.py

@classmethod
def register_dispatch(cls, registry_val,
                      from_parent:type[BlockType]=None,
                      setup_from_key=None,
                      setup_allow_self=True,
                      inherit_dispatch=False,
                      defaults:dict=None):
    """
    Decorate a subclass to be dispatched from a parent class.

    The subclass will also be decorated with the parent's
    [setup_dispatch][FoSpy.blocks.blocks.SingleBlock.setup_dispatch] to set
    up its own dispatch parameters.

    Args:
        registry_val:
            The value to be found in a dispatched blockDict which will be
            mapped to the subclass in the parent class's registry.

        from_parent:
            The parent class to register the subclass to. Defaults to the
            class which calls the method, but may be overridden if a
            non-SingleBlock abstract class is the parent.

        setup_from_key:
            Passed as from_key to the parents setup_dispatch decorator.

        setup_allow_self:
            Passed as allow_self to the parent's setup_dispatch decorator.

        inherit_dispatch:
            Whether the decorated class should inherit its parent's
            `add_dispatch` method

        defaults:
            Default values that should be injected into the blockDict when
            trying to guarantee dispatching to the registered class.
            Defaults to {}. If parent's from_key is public, defaults will be
            updated with `{from_key: registry_val}`
    """
    setup = {
        "from_key": setup_from_key,
        "allow_self": setup_allow_self,
        "_defaults": defaults or {}
    }
    from_parent = from_parent or cls
    def decorator(subcls, _val=registry_val, _p=from_parent, _cls=cls, _s=setup):
        if "__dispatch__" not in _p.__dict__:
            raise Exception("You cannot register a subclass to a class that "
            f"hasn't been decorated with @setup_dispatch() or @register_dispatch() ({_p.__name__})")

        dispatch_key = _p.__dispatch__["from_key"]
        if not dispatch_key.startswith("_"):
            _s["_defaults"][dispatch_key] = _val


        _s["_dispatch_from"] = _p.__dispatch__["dispatch_from"]

        subcls = cls.setup_dispatch(subcls, **_s)
        registry = _p.__dispatch__["registry"]

        registry[registry_val] = subcls

        if not inherit_dispatch and "add_dispatch" not in subcls.__dict__:
            subcls.add_dispatch = SingleBlock.add_dispatch

        return subcls
    return decorator

rename_block(old, new)

Source code in FoSpy/blocks/blocks.py

def rename_block(self, old, new):
    validators = self.get_validators()
    req = self.get_req_validators()
    if any(name.startswith("_") for name in (old, new)):
        raise ValueError("You cannot set private attributes (starting with '_') using obj.rename_block()")

    if old in req and new in validators:
        raise ValueError(f"You cannot rename '{old}' to '{new}'. '{old}' is a required property that "
                            f"can only be renamed to an unregistered key; '{new}' is already registered "
                            "as an expected property.")

    if hasattr(self, new):
        raise ValueError(f"'{new}' is already a property for this object, you cannot overwrite it with "
                         "obj.rename_block()")

    if "rename" in (old, new):
        raise ValueError("obj.rename property cannot be set or changed by obj.rename_block()")

    if hasattr(self, "rename") and hasattr(self.rename, old):
        old = getattr(self.rename, old)()

    if old in self._key_overrides:
        val = self._key_overrides.pop(old)
        self._key_overrides[new] = val

    else:
        if not hasattr(self,"rename"):
            self.rename = {}

        rename_dict = self.rename_dict()
        rename_from = {v:k for k,v in rename_dict.items()}
        if old in rename_from:
            base = rename_from[old]
        else:
            base = old

        _debug.msg(f"Registering '{base}':'{new}' into rename block")
        setattr(self.rename, base, new)
    _debug.msg(f"Moving '{old}' over to '{new}'.")
    setattr(self,new,getattr(self, old))
    delattr(self,old)

    try:
        idx = self._key_order.index(old)
        self._key_order[idx] = new
    # TODO: Better handling
    except Exception:
        self._key_order.append(new)

rename_dict()

Source code in FoSpy/blocks/blocks.py

def rename_dict(self):
    if not hasattr(self, "rename"):
        return {}
    return self.rename.serialize(shallow=True, clean=True)

save(filepath=None, json_indent=4, **kwargs)

Sends a serialized dict to be written to file.

Parameters:

Name	Type	Description	Default
filepath	str	If specified, writes serialized dict to filepath. ks to self._sourceFile.	None
json_indent		Indent to use for json.dump when saving as json	4
**kwargs		Optional kwargs to pass to saving routine (unique to each file extension)	{}

Raises:

Type	Description
ValueError	If _sourceFile is not specified (if FileBlock was copied from another object or constructed directly from a blockDict), filepath must be specified.

Source code in FoSpy/blocks/files.py

def save(self, filepath:str=None, json_indent=4, **kwargs):
    """
    Sends a serialized dict to be written to file.

    Args:
        filepath:
            If specified, writes serialized dict to filepath. ks to `self._sourceFile`.
        json_indent:
            Indent to use for json.dump when saving as json
        **kwargs:
            Optional kwargs to pass to saving routine (unique to each file extension)

    Raises:
        ValueError:
            If _sourceFile is not specified (if `FileBlock` was copied from
            another object or constructed directly from a blockDict),
            filepath must be specified.
    """
    from warnings import warn
    saving_as = filepath is not None
    try:
        if not saving_as:
            if self._sourceFile is None:
                raise ValueError("Synthesis object was constructed without a sourceFile. A save destination must be specified.")
            else:
                filepath = self._sourceFile
        self._sourceFile = os.path.abspath(filepath)

        filepath = self._sourceFile if self._ext_file is None else self._ext_file
        if str(filepath).endswith(".fosx"):
            return self.package(filepath)
        self.refresh_attachments()
        pathstr = str(filepath)
        try:
            ext = pathstr.lower().split(".")[-1]
        except IndexError:
            raise ValueError(f"Could not determine extension for filepath: {pathstr}")


        ext = str(filepath).lower().split(".")[-1]

        if ext not in EXT_WRITE_MAP:
            raise ValueError(f"Unrecognized file extension '{ext}'. Supported extensions are: {list(EXT_WRITE_MAP.keys())}")

        blockDict = self.serialize(clean="fos" not in ext)

        EXT_WRITE_MAP[ext](blockDict, filepath, json_indent=json_indent, **kwargs)

    except Exception as e:
        if not saving_as:
            warn(f"Could not save file. Disconnected from source file for safety. Exception: {e}", RuntimeWarning)
            self._sourceFile = None
            return e
        else:
            raise e
    return True

serialize(*args, **kwargs)

Source code in FoSpy/blocks/template.py

def serialize(self, *args, **kwargs):
    serial = super().serialize(*args, **kwargs)

    out = {}

    for name, value in serial.items():
        if "$" in name:
            new_name, alias = name.split("$")
            if _is_plural(new_name, alias):
                name = new_name

        out[name] = value

    return out

set_dispatch(value=None, from_parent=None, from_key=None, allow_self=None) classmethod

Source code in FoSpy/blocks/blocks.py

@classmethod
def set_dispatch(cls, value=None, from_parent=None, from_key=None, allow_self=None):

    # Abstract classes are sometimes made without SingleBlock in MRO
    if from_parent is not None:
        target_cls = from_parent
    else:
        target_cls = cls

    if "dispatch" not in target_cls.__dict__:
        target_cls.dispatch = {}

    if from_key is not None:
        target_cls.dispatch_key = from_key

    if allow_self is not None:
        target_cls.dispatch_allow_self = allow_self

    def dispatched_cls(subcls, v=value, _cls=target_cls):
        subcls.dispatch_from = _cls
        _cls.dispatch[v] = subcls
        return subcls
    return dispatched_cls

setup_dispatch(from_key=None, allow_self=True, _dispatch_from=None, _defaults={}) staticmethod

Decorate a class to dispatch to other classes during construction.

The decorated class's add_dispatch method will be wrapped into a new method, dispatch_subclass, which is decorator as a dispatcher. The parent class's from_key is found in the blockDict passed to the constructor, and the value mapped to from_key is mapped to dispatchable subclasses in the registry.

add_dispatch returns a dictionary of values that are injected into the blockDict, either to be detected by dispatch, or to be delegated to the constructor.

This decorator should only be used directly for the start of a dispatch chain. For later dispatches, use register_dispatch

Parameters:

Name	Type	Description	Default
cls	SingleBlock subclass	The class to be decorated. If provided, the decorator is most likely being called as a bare decorator. Otherwise, the decorators is being called with other keyword arguments and returns the modified decorator.	None
from_key	str	The key to be located in the blockDict after optional injection by add_dispatch. Private from_keys will be injected and located under the __dispatch__ key which is popped before final construction.	None
allow_self	bool	When True, the decorated class will dispatch to itself if no subclasses can be found. When False, error is raised during construction if dispatchable subclass is not found.	True
_dispatch_from	SingleBlock subclass	To be passed only by register_dispatch, which decorates subclasses to populate this class's registry. Identifies the parent class that the constructor must start at. If not provided, the decorated class is assumed to be the start of a dispatch chain.	None
_defaults	dict	To be passed only by register_dispatch, which decorates subclasses to populat this class's registry. Provides default values that should be injected into the blockDict when trying to guarantee dispatching to the decorated class (usually by a template constructor).	{}

Source code in FoSpy/blocks/blocks.py

@staticmethod
def setup_dispatch(cls:type[BlockType]=None,
    from_key=None,
    allow_self=True,
    _dispatch_from=None,
    _defaults={}
):
    """
    Decorate a class to dispatch to other classes during construction.

    The decorated class's [`add_dispatch`
    method][FoSpy.blocks.blocks.SingleBlock.add_dispatch] will be wrapped
    into a new method,
    [`dispatch_subclass`][FoSpy.blocks.blocks.SingleBlock.dispatch_subclass],
    which is decorator as a
    [`dispatcher`][FoSpy.blocks.blocks.SingleBlock.dispatcher]. The parent
    class's `from_key` is found in the blockDict passed to the constructor,
    and the value mapped to `from_key` is mapped to dispatchable subclasses
    in the `registry`.

    `add_dispatch` returns a dictionary of values that are injected into the
    blockDict, either to be detected by dispatch, or to be delegated to the
    constructor.

    This decorator should only be used directly for the start of a dispatch
    chain. For later dispatches, use
    [`register_dispatch`][FoSpy.blocks.blocks.SingleBlock.register_dispatch]

    Args:
        cls (SingleBlock subclass):
            The class to be decorated. If provided, the decorator is most
            likely being called as a bare decorator. Otherwise, the
            decorators is being called with other keyword arguments and
            returns the modified decorator.

        from_key (str):
            The key to be located in the blockDict after optional injection
            by `add_dispatch`. Private `from_key`s will be injected and
            located under the `__dispatch__` key which is popped before
            final construction.

        allow_self (bool):
            When True, the decorated class will dispatch to itself if no
            subclasses can be found. When False, error is raised during
            construction if dispatchable subclass is not found.

        _dispatch_from (SingleBlock subclass):
            To be passed only by `register_dispatch`, which decorates
            subclasses to populate this class's registry. Identifies the
            parent class that the constructor must start at. If not
            provided, the decorated class is assumed to be the start of a
            dispatch chain. 
        _defaults (dict):
            To be passed only by `register_dispatch`, which decorates
            subclasses to populat this class's registry. Provides default
            values that should be injected into the blockDict when trying to
            guarantee dispatching to the decorated class (usually by a
            template constructor).
        """
    if cls is not None and not isinstance(cls, type):
        raise Exception("@setup_dispatch must be used as a bare decorator, or with "
                        "a class as the first positional argument. You may have tried "
                        "to decorate a class with positional args instead of keywords.")

    def decorator(_cls:type[BlockType], _fk=from_key, _as=allow_self, _df=_dispatch_from, _def=_defaults):
        _cls.__dispatch__ = {
            "from_key": _fk,
            "allow_self": _as,
            "dispatch_from": _df or _cls,
            "registry": {}
        }

        def inject(bD, k, v, is_default=False):
            target_dict = bD["__dispatch__"] if k.startswith("_") else bD

            if is_default and v is None and k in target_dict:
                return bD

            target_dict[k] = v

            return bD

        @classmethod
        def inject_defaults(current_cls, blockDict, _d=_def):
            d = current_cls.__dispatch__
            blk_d = blockDict.setdefault("__dispatch__", {})
            if (not d['allow_self'] and
                None not in d['registry'] and
                blockDict.get(d['from_key'],blk_d.get(d['from_key'], None)) is None):
                default_dispatch = next(iter(d['registry'].values()))
                blockDict = default_dispatch.inject_defaults(blockDict)

            for k, v in _d.items():
                blockDict = inject(blockDict, k, v, is_default=True)
            return blockDict

        @SingleBlock.dispatcher
        def dispatch_subclass(current_cls:type[BlockType], blockDict:dict, _dispatch_key=_fk, **kwargs):
            injection = current_cls.add_dispatch(blockDict, _dispatch_key, _wrapped=True, **kwargs)

            for k, v in injection.items():
                blockDict = inject(blockDict, k, v)

            return blockDict

        # inject methods
        _cls.inject_defaults = inject_defaults
        _cls.dispatch_subclass = dispatch_subclass

        return _cls

    if cls is not None:
        return decorator(cls)

    return decorator

stage_template(prop_name, template=None)

Source code in FoSpy/blocks/blocks.py

def stage_template(self, prop_name, template:Block|dict=None):
    from .template import TemplateBlock
    if template is None:
        template = {}

    if not isinstance(template, (TemplateBlock, dict)):
        raise ValueError("Template must be a TemplateBlock or dictionary. To 'stage' a ListBlock, "
                         "you can stage a SingleBlock template with a ListBlock alias. This creates "
                         "a non-template ListBlock with the template staged as its first entry.")

    alias_validator = None
    if "$" in prop_name:
        prop_name, alias = prop_name.split("$",1)
        try:
            alias_validator = self._aliases[alias]
        except KeyError as e:
            raise err.PropertyAliasError(prop_name, self, blockDict={prop_name: "<staged template>"},
                                         hint=f"Unrecognized block alias: '{alias}' assigned to property: ",
                                         posthint=f"Valid aliases: {list(self._aliases.keys())}") from e

    if hasattr(self, prop_name):
        raise ValueError(f"Property {prop_name} already exists. You cannot stage a template for a property that already exists.")

    validators = self.build_validators()
    validator = validators.get(prop_name, None)

    if validator is not None:
        alias = None

    if alias_validator is not validator and None not in (validator, alias_validator):
        raise ValueError(f"Property {prop_name} already has a validator. You cannot alias a different validator for the same property.")

    validator = next(v for v in (validator, alias_validator) if v is not None)

    if validator is None:
        try:
            if not isinstance(template, TemplateBlock):
                raise TypeError("Dictionary templates must be staged with an alias.")

            alias = next(k for k, v in self._aliases.items() if isinstance(template, v))
            validator = self._aliases[alias]
        except (TypeError,StopIteration) as e:
            raise ValueError(f"Property {prop_name} is unexpected. In order to stage a template "
                            "for and unexpected property, you must specify the validator with a '$' alias "
                            "in the property name, or stage a pre-constructed template of an aliasable validator."
                            ) from e

    if isinstance(validator, type) and issubclass(validator, ListBlock):
        # let setattr handle ListBlock construction using alias
        # this creates an empty ListBlock under self.prop_name
        # (alias stripped during setattr)
        setattr(self, prop_name+"$"+alias if alias is not None else prop_name, [])
        empty_lb = getattr(self, prop_name)
        return empty_lb.stage_template("entry0", template)

    if isinstance(template, dict):
        # reflex returns a TemplateBlock subclassed from the validator
        template = validator.reflex(serialize=False, include_temp_names=True, clean=False, **template)
        template.template_name = prop_name

    elif not isinstance(template, validator):
        val_nm = validator.__name__
        if alias is None:
            error_msg = f"The provided template is not compatible with the validator expected for property '{prop_name}' ({val_nm})."
        else:
            error_msg = f"The provided template is not compatible with the validator specified by alias '{alias}' ({val_nm})."
        raise ValueError(error_msg)


    template._staged_parent = self

    if alias is not None:
        self._key_overrides[prop_name] = validator

    self._staged_templates[prop_name] = template

    return prop_name, template

to_json(filepath=None, clean=True, indent=4, **kwargs)

Converts self into a JSON-formatted string or file.

Serializes and either returns as a JSON-formatted string or saves to a JSON file.

Parameters:

Name	Type	Description	Default
filepath	pathlike	JSON file save destination. If None, returns JSON-formatted string instead.	None
clean	bool	When True, no FOS format read/write metadata is included in the serial. FOS metadata has no impact on JSON format but may be useful to view in JSON for troubleshooting.	True
indent	int	indent value passed to json.dump for file saving.	4
**kwargs	any	other arguments passed to json.dump for file saving.	{}

Source code in FoSpy/blocks/blocks.py

def to_json(self, filepath=None, clean:bool=True, indent:int=4, **kwargs):
    """
    Converts `self` into a JSON-formatted string or file.

    [Serializes][FoSpy.blocks.blocks.SingleBlock.serialize] and either
    returns as a JSON-formatted string or saves to a JSON file.

    Args:
        filepath (pathlike):
            JSON file save destination. If `None`, returns JSON-formatted
            string instead.

        clean:
            When True, no FOS format read/write metadata is included in the
            serial. FOS metadata has no impact on JSON format but may be
            useful to view in JSON for troubleshooting.

        indent:
            `indent` value passed to `json.dump` for file saving.

        **kwargs (any):
            other arguments passed to `json.dump` for file saving.
    """
    import json
    serial = self.serialize(clean=clean)

    if filepath is None:
        return json.dumps(serial)

    with open(filepath, "w") as f:
        json.dump(serial, f, indent=indent, **kwargs)

track_attachments(new_copy='prompt', overwrite='prompt', **kwargs)

Source code in FoSpy/blocks/blocks.py

def track_attachments(self, new_copy="prompt",overwrite="prompt", **kwargs):
    self._att_new_copy = new_copy
    self._att_overwrite = overwrite