Class ProjectBody

scratchattach/other/project_json_capabilities.py:22–431

        component.from_json(element)
        target_list.append(component)
class ProjectBody:
    class BaseProjectBodyComponent(ABC):
        def __init__(self, **entries):
            # Attributes every object needs to have:
            self.id = None
            # Update attributes from entries dict:
            self.__dict__.update(entries)
        @abstractmethod
        def from_json(self, data: dict):
            pass
        @abstractmethod
        def to_json(self):
            pass
        def _generate_new_id(self):
            """
            Generates a new id and updates the id.
            Warning:
                When done on Block objects, the next_id attribute of the parent block and the parent_id attribute of the next block will NOT be updated by this method.
            """
            self.id = ''.join(random.choices(string.ascii_letters + string.digits, k=20))
    class Block(BaseProjectBodyComponent):
        # Thanks to @MonkeyBean2 for some scripts
        def from_json(self, data: dict):
            self.opcode = data["opcode"]  # The name of the block
            self.next_id = data.get("next", None)  # The id of the block attached below this block
            self.parent_id = data.get("parent", None)  # The id of the block that this block is attached to
            self.input_data = data.get("inputs", None)  # The blocks inside of the block (if the block is a loop or an if clause for example)
            self.fields = data.get("fields", None)  # The values inside the block's inputs
            self.shadow = data.get("shadow", False)  # Whether the block is displayed with a shadow
            self.topLevel = data.get("topLevel", False)  # Whether the block has no parent
            self.mutation = data.get("mutation", None)  # For custom blocks
            self.x = data.get("x", None)  # x position if topLevel
            self.y = data.get("y", None)  # y position if topLevel
        def to_json(self):
            output = {"opcode": self.opcode, "next": self.next_id, "parent": self.parent_id, "inputs": self.input_data,
                      "fields": self.fields, "shadow": self.shadow, "topLevel": self.topLevel,
                      "mutation": self.mutation, "x": self.x, "y": self.y}
            return {k: v for k, v in output.items() if v}
        def attached_block(self):
            return self.sprite.block_by_id(self.next_id)
        def previous_block(self):
            return self.sprite.block_by_id(self.parent_id)
        def top_level_block(self):
            block = self
            return block
        def previous_chain(self):
            # to implement: a method that detects circular block chains (to make sure this method terminates)
            chain = []
            block = self
            while block.parent_id is not None:
                block = block.previous_block()
                chain.insert(0, block)
            return chain
        def attached_chain(self):
            chain = []
            block = self
            while block.next_id is not None:
                block = block.attached_block()