sm-blueprint-lib 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

sm_blueprint_lib/__init__.py

@@ -1,138 +1,10 @@
-from dataclasses import asdict
-from json import load, dump, loads, dumps
-from math import ceil, log2
-
-from numpy import ndarray
-
-from sm_blueprint_lib.bases.parts.baseinteractablepart import BaseInteractablePart
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.barrierblock import BarrierBlock
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
-
-
-def load_blueprint(path):
-    """Load a blueprint from a path file (normally a blueprint.json).
-
-    Args:
-        path (str): The path to the json file.
-
-    Returns:
-        Blueprint: The loaded blueprint.
-    """
-    with open(path) as fp:
-        return Blueprint(**load(fp))
-
-
-def save_blueprint(path, bp: Blueprint):
-    """Save a blueprint to a file (normally a blueprint.json).
-
-    Args:
-        path (str): The path to save the json file.
-        bp (Blueprint): The blueprint to be saved.
-    """
-    with open(path, mode="w") as fp:
-        return dump(asdict(bp), fp, sort_keys=True, separators=(',', ':'))
-
-
-def load_string(str):
-    """Load a blueprint from a json string.
-
-    Args:
-        str (str): The string to be loaded.
-
-    Returns:
-        Blueprint: The loaded blueprint.
-    """
-    return Blueprint(**loads(str))
-
-
-def dump_string(bp: Blueprint):
-    """Dump a blueprint into a json-formatted string.
-
-    Args:
-        bp (Blueprint): The blueprint to be dumped.
-
-    Returns:
-        str: The json-formatted string.
-    """
-    return dumps(asdict(bp), sort_keys=True, separators=(',', ':'))
-
-
-def connect(_from, _to, *, parallel=True):
-    """Connect interactable parts together, recursively.
-
-    Args:
-        _from (Any): Must be an instance of BaseInteractablePart or a subclass.
-        Also it can be any nested iterable of instances (list of parts, list of lists of parts, etc).
-        _to (Any): Must be an instance of BaseInteractablePart or a subclass.
-        Also it can be any nested iterable of instances (list of parts, list of lists of parts, etc).
-        parallel (bool, optional): Defines the behaviour of the connections in the following way:
-
-        With parallel=False, everything connects to everything:
-            from1 🔀 to1
-
-            from2 🔀 to2
-
-        With parallel=True, every row is connected respectively:
-            from1 → to1
-
-            from2 → to2
-
-        Also, if the dimensions does not match it tries to adapt (many to one, one to many, etc)
-
-        Defaults to True.
-    """
-    if isinstance(_from, BaseInteractablePart) and isinstance(_to, BaseInteractablePart):
-        _from.connect(_to)
-        return
-    if parallel:    # Try connect things row-by-row if possible (one to one, one to many, many to many)
-        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
-            for subfrom, subto in zip(_from, _to):
-                connect(subfrom, subto, parallel=parallel)
-        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
-            for subfrom in _from:
-                connect(subfrom, _to, parallel=parallel)
-        else:                                               # Assume _to is a sequence of parts
-            for subto in _to:
-                connect(_from, subto, parallel=parallel)
-    else:           # Just connect everything to everything lol
-        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
-            for subfrom in _from:
-                for subto in _to:
-                    connect(subfrom, subto, parallel=parallel)
-        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
-            for subfrom in _from:
-                connect(subfrom, _to, parallel=parallel)
-        else:                                               # Assume _to is a sequence of parts
-            for subto in _to:
-                connect(_from, subto, parallel=parallel)
-
-
-def check_pos(pos):
-    if not isinstance(pos, Pos):
-        pos = Pos(*pos)
-    return pos
-
-
-def get_bits_required(number: int | float):
-    """Calculates how many bits are required to store this number.
-
-    Args:
-        number (int | float): The target number.
-    """
-    return ceil(log2(number))
-
-
-def num_to_bit_list(number: int, bit_length: int):
-    """Converts a number to a numpy array of its bits.
-
-    Args:
-        number (int): The number to convert.
-        bit_length (int): The number of bits the list will have.
-    """
-    output = ndarray(bit_length, dtype=bool)
-    for b in range(bit_length):
-        output[b] = bool((number >> b) & 1)
-    return output
+from .blueprint import Blueprint
+from .body import *
+from .bounds import *
+from .constants import *
+from .id import *
+from .pos import *
+from .utils import *
+
+from .parts import *
+from .prebuilds import *

sm_blueprint_lib/bases/controllers/basecontroller.py

@@ -1,8 +1,8 @@
 from dataclasses import dataclass, field
 from typing import Any, Optional
 
-from sm_blueprint_lib.constants import get_new_id
-from sm_blueprint_lib.id import ID
+from ...constants import get_new_id
+from ...id import ID
 
 
 @dataclass

sm_blueprint_lib/bases/controllers/baselogiccontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.basecontroller import BaseController
+from .basecontroller import BaseController
 
 
 @dataclass

sm_blueprint_lib/bases/controllers/logicgatecontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.baselogiccontroller import BaseLogicController
+from .baselogiccontroller import BaseLogicController
 
 
 @dataclass

sm_blueprint_lib/bases/controllers/sensorcontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.basecontroller import BaseController
+from .basecontroller import BaseController
 
 
 @dataclass

sm_blueprint_lib/bases/controllers/timercontroller.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.controllers.baselogiccontroller import BaseLogicController
+from .baselogiccontroller import BaseLogicController
 
 
 @dataclass

sm_blueprint_lib/bases/parts/baseboundablepart.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass, field
+
+from .basepart import BasePart
+from ...bounds import Bounds
+from ...constants import AXIS
+
+
+@dataclass
+class BaseBoundablePart(BasePart):
+    """Base class for all Boundable parts (those that are draggable)
+    """
+    bounds: Bounds
+    xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS)
+    zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS)
+
+    def __post_init__(self):
+        super().__post_init__()
+        if not isinstance(self.bounds, Bounds):
+            try:
+                self.bounds = Bounds(**self.bounds)
+            except TypeError:
+                self.bounds = Bounds(
+                    self.bounds[0], self.bounds[1], self.bounds[2])

sm_blueprint_lib/bases/parts/baseinteractablepart.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass, field
+
+from ..controllers.basecontroller import BaseController
+from .basepart import BasePart
+from ...id import ID
+
+
+@dataclass
+class BaseInteractablePart(BasePart):
+    """Base class for Interactable parts
+    """
+    controller: BaseController = field(default_factory=BaseController)
+
+    def connect(self, o: "BaseInteractablePart"):
+        if not self.controller.controllers:
+            self.controller.controllers = []
+            
+        self.controller.controllers.append(ID(o.controller.id))
+        return o

sm_blueprint_lib/bases/parts/baselogicpart.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass, field
+
+from .baseinteractablepart import BaseInteractablePart
+from ..controllers.baselogiccontroller import BaseLogicController
+
+
+@dataclass
+class BaseLogicPart(BaseInteractablePart):
+    """Base class for Logic parts with active state (mostly Logic Gate and Timer)
+    """
+    controller: BaseLogicController = field(default_factory=BaseLogicController)
+    xaxis: int = field(kw_only=True, default=1)
+    zaxis: int = field(kw_only=True, default=-2)

sm_blueprint_lib/bases/parts/basepart.py

@@ -0,0 +1,34 @@
+from dataclasses import dataclass, field
+
+from ...constants import AXIS, SHAPEID
+from ...pos import Pos
+
+
+@dataclass
+class BasePart:
+    """Base class for all in-game parts
+    """
+    shapeId: str
+    pos: Pos
+    color: str
+    xaxis: int = field(kw_only=True, default=AXIS.DEFAULT_XAXIS)
+    zaxis: int = field(kw_only=True, default=AXIS.DEFAULT_ZAXIS)
+
+    def __post_init__(self):
+        # if pos given as {"x": ..., "y": ..., "z": ...} or (x, y, z) then convert to Pos class
+        if not isinstance(self.pos, Pos):
+            try:
+                self.pos = Pos(**self.pos)
+            except TypeError:
+                self.pos = Pos(self.pos[0], self.pos[1], self.pos[2])
+        # if color given as (r, g, b) then convert to hex string
+        if not isinstance(self.color, str):
+            self.color = "%02X%02X%02X" % (
+                self.color[0], self.color[1], self.color[2])
+
+    def __init_subclass__(cls):
+        super().__init_subclass__()
+        try:
+            SHAPEID.SHAPEID_TO_CLASS[cls.shapeId.default] = cls
+        except AttributeError:
+            pass

sm_blueprint_lib/blueprint.py

@@ -1,8 +1,8 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.parts.basepart import BasePart
-from sm_blueprint_lib.body import Body
-from sm_blueprint_lib.constants import VERSION
+from .bases.parts.basepart import BasePart
+from .body import Body
+from .constants import VERSION
 
 
 @dataclass

sm_blueprint_lib/body.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
 
-from sm_blueprint_lib.bases.parts.basepart import BasePart
-from sm_blueprint_lib.constants import SHAPEID
+from .bases.parts.basepart import BasePart
+from .constants import SHAPEID
 
 
 @dataclass

sm_blueprint_lib/parts/barrierblock.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baseboundablepart import BaseBoundablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class BarrierBlock(BaseBoundablePart):
+    shapeId: str = field(kw_only=True, default=SHAPEID.BARRIER_BLOCK)

sm_blueprint_lib/parts/logicgate.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..bases.controllers.logicgatecontroller import LogicGateController
+from ..constants import SHAPEID
+
+
+@dataclass
+class LogicGate(BaseLogicPart):
+    controller: LogicGateController = field(
+        default_factory=LogicGateController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.LOGIC_GATE)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can specify mode as a dict, a tuple (mode,) or just the parameter mode
+        if not isinstance(self.controller, LogicGateController):
+            try:
+                self.controller = LogicGateController(**self.controller)
+            except TypeError:
+                try:
+                    self.controller = LogicGateController(*self.controller)
+                except TypeError:
+                    self.controller = LogicGateController(self.controller)

sm_blueprint_lib/parts/sensor.py

@@ -0,0 +1,24 @@
+from dataclasses import dataclass, field
+
+from ..bases.controllers.sensorcontroller import SensorController
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Sensor5(BaseInteractablePart):
+    controller: SensorController = field(
+        default_factory=SensorController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.SENSOR5)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can specify sensor controller as a dict, a tuple (audioEnable, buttonMode, color, colorMode, range) or just the parameter mode
+        if not isinstance(self.controller, SensorController):
+            try:
+                self.controller = SensorController(**self.controller)
+            except TypeError:
+                try:
+                    self.controller = SensorController(*self.controller)
+                except TypeError:
+                    self.controller = SensorController(self.controller)

sm_blueprint_lib/parts/switch.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass, field
+
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Switch(BaseInteractablePart):
+    raise NotImplemented

sm_blueprint_lib/parts/timer.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass, field
+
+from ..bases.controllers.timercontroller import TimerController
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..constants import SHAPEID
+
+
+@dataclass
+class Timer(BaseLogicPart):
+    controller: TimerController = field(default_factory=TimerController)
+    shapeId: str = field(kw_only=True, default=SHAPEID.TIMER)
+
+    def __post_init__(self):
+        super().__post_init__()
+        # Can provide seconds and ticks as a the TimerController class itself, a dict or a tuple (seconds, tick)
+        if not isinstance(self.controller, TimerController):
+            try:
+                self.controller = TimerController(**self.controller)
+            except TypeError:
+                self.controller = TimerController(*self.controller)

sm_blueprint_lib/prebuilds/adder.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def simple_adder_subtractor(bp: Blueprint,

sm_blueprint_lib/prebuilds/barrel_shifter.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def barrel_shifter(bp: Blueprint, bit_length: int, num_bit_shift: int, pos: Pos | Sequence = (0, 0, 0)):

sm_blueprint_lib/prebuilds/clock40hz.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def clock40hz(bp: Blueprint, bit_length: int, pos: Pos | Sequence = (0, 0, 0)):

sm_blueprint_lib/prebuilds/comparator.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def comparator(bp: Blueprint,

sm_blueprint_lib/prebuilds/counter.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def counter(bp: Blueprint,

sm_blueprint_lib/prebuilds/decoder.py

@@ -1,9 +1,9 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
 
 
 def decoder(bp: Blueprint, num_address: int, pos: Pos | Sequence = (0, 0, 0),

sm_blueprint_lib/prebuilds/distance_sensor.py

@@ -1,11 +1,11 @@
 from typing import Sequence
 from numpy import array, ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.sensor import Sensor5
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..parts.sensor import Sensor5
+from ..parts.timer import Timer
+from ..pos import Pos
 
 
 def distance_sensor(bp: Blueprint,

sm_blueprint_lib/prebuilds/ram.py

@@ -1,11 +1,11 @@
 from itertools import cycle
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.decoder import decoder
+from ..utils import get_bits_required, check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
+from ..prebuilds.decoder import decoder
 
 
 def ram(bp: Blueprint, bit_length: int, num_address: int, pos: Pos | Sequence = (0, 0, 0),

sm_blueprint_lib/prebuilds/register.py

@@ -1,10 +1,10 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import check_pos
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.counter import counter, counter_decrement
+from ..utils import check_pos
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..pos import Pos
+from ..prebuilds.counter import counter, counter_decrement
 
 
 def register(bp: Blueprint,

sm_blueprint_lib/prebuilds/rom.py

@@ -2,12 +2,12 @@ from itertools import batched, cycle
 from math import ceil
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..prebuilds.decoder import decoder
+from ..parts.timer import Timer
+from ..pos import Pos
 
 
 def rom(

sm_blueprint_lib/prebuilds/timer_ram_cached.py

@@ -1,19 +1,19 @@
 from itertools import cycle
 from typing import Sequence
 from numpy import array, clip, ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect, num_to_bit_list
-from sm_blueprint_lib.bases.parts.baseinteractablepart import BaseInteractablePart
-from sm_blueprint_lib.bases.parts.baselogicpart import BaseLogicPart
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.constants import TICKS_PER_SECOND
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.clock40hz import clock40hz
-from sm_blueprint_lib.prebuilds.counter import counter
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.prebuilds.ram import ram
-from sm_blueprint_lib.prebuilds.register import register
+from ..utils import get_bits_required, check_pos, connect, num_to_bit_list
+from ..bases.parts.baseinteractablepart import BaseInteractablePart
+from ..bases.parts.baselogicpart import BaseLogicPart
+from ..blueprint import Blueprint
+from ..constants import TICKS_PER_SECOND
+from ..parts.logicgate import LogicGate
+from ..parts.timer import Timer
+from ..pos import Pos
+from ..prebuilds.clock40hz import clock40hz
+from ..prebuilds.counter import counter
+from ..prebuilds.decoder import decoder
+from ..prebuilds.ram import ram
+from ..prebuilds.register import register
 
 
 def timer_ram_cached(

sm_blueprint_lib/prebuilds/timer_ram_multiclient.py

@@ -1,14 +1,14 @@
 from typing import Sequence
 from numpy import ndarray
-from sm_blueprint_lib import get_bits_required, check_pos, connect
-from sm_blueprint_lib.blueprint import Blueprint
-from sm_blueprint_lib.parts.logicgate import LogicGate
-from sm_blueprint_lib.parts.timer import Timer
-from sm_blueprint_lib.pos import Pos
-from sm_blueprint_lib.prebuilds.clock40hz import clock40hz
-from sm_blueprint_lib.prebuilds.decoder import decoder
-from sm_blueprint_lib.prebuilds.ram import ram
-from sm_blueprint_lib.prebuilds.register import register
+from ..utils import get_bits_required, check_pos, connect
+from ..blueprint import Blueprint
+from ..parts.logicgate import LogicGate
+from ..parts.timer import Timer
+from ..pos import Pos
+from ..prebuilds.clock40hz import clock40hz
+from ..prebuilds.decoder import decoder
+from ..prebuilds.ram import ram
+from ..prebuilds.register import register
 
 
 def timer_ram_multiclient(bp: Blueprint, bit_length: int, num_address: int, num_clients=1, pos: Pos | Sequence = (0, 0, 0)):

sm_blueprint_lib/utils.py

@@ -0,0 +1,138 @@
+from dataclasses import asdict
+from json import load, dump, loads, dumps
+from math import ceil, log2
+
+from numpy import ndarray
+
+from .bases.parts.baseinteractablepart import BaseInteractablePart
+from .blueprint import Blueprint
+from .parts.barrierblock import BarrierBlock
+from .parts.logicgate import LogicGate
+from .parts.timer import Timer
+from .pos import Pos
+
+
+def load_blueprint(path):
+    """Load a blueprint from a path file (normally a blueprint.json).
+
+    Args:
+        path (str): The path to the json file.
+
+    Returns:
+        Blueprint: The loaded blueprint.
+    """
+    with open(path) as fp:
+        return Blueprint(**load(fp))
+
+
+def save_blueprint(path, bp: Blueprint):
+    """Save a blueprint to a file (normally a blueprint.json).
+
+    Args:
+        path (str): The path to save the json file.
+        bp (Blueprint): The blueprint to be saved.
+    """
+    with open(path, mode="w") as fp:
+        return dump(asdict(bp), fp, sort_keys=True, separators=(',', ':'))
+
+
+def load_string(str):
+    """Load a blueprint from a json string.
+
+    Args:
+        str (str): The string to be loaded.
+
+    Returns:
+        Blueprint: The loaded blueprint.
+    """
+    return Blueprint(**loads(str))
+
+
+def dump_string(bp: Blueprint):
+    """Dump a blueprint into a json-formatted string.
+
+    Args:
+        bp (Blueprint): The blueprint to be dumped.
+
+    Returns:
+        str: The json-formatted string.
+    """
+    return dumps(asdict(bp), sort_keys=True, separators=(',', ':'))
+
+
+def connect(_from, _to, *, parallel=True):
+    """Connect interactable parts together, recursively.
+
+    Args:
+        _from (Any): Must be an instance of BaseInteractablePart or a subclass.
+        Also it can be any nested iterable of instances (list of parts, list of lists of parts, etc).
+        _to (Any): Must be an instance of BaseInteractablePart or a subclass.
+        Also it can be any nested iterable of instances (list of parts, list of lists of parts, etc).
+        parallel (bool, optional): Defines the behaviour of the connections in the following way:
+
+        With parallel=False, everything connects to everything:
+            from1 🔀 to1
+
+            from2 🔀 to2
+
+        With parallel=True, every row is connected respectively:
+            from1 → to1
+
+            from2 → to2
+
+        Also, if the dimensions does not match it tries to adapt (many to one, one to many, etc)
+
+        Defaults to True.
+    """
+    if isinstance(_from, BaseInteractablePart) and isinstance(_to, BaseInteractablePart):
+        _from.connect(_to)
+        return
+    if parallel:    # Try connect things row-by-row if possible (one to one, one to many, many to many)
+        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
+            for subfrom, subto in zip(_from, _to):
+                connect(subfrom, subto, parallel=parallel)
+        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
+            for subfrom in _from:
+                connect(subfrom, _to, parallel=parallel)
+        else:                                               # Assume _to is a sequence of parts
+            for subto in _to:
+                connect(_from, subto, parallel=parallel)
+    else:           # Just connect everything to everything lol
+        if not isinstance(_from, BaseInteractablePart) and not isinstance(_to, BaseInteractablePart):   # Assume both are sequence of parts
+            for subfrom in _from:
+                for subto in _to:
+                    connect(subfrom, subto, parallel=parallel)
+        elif not isinstance(_from, BaseInteractablePart):   # Assume _from is a sequence of parts
+            for subfrom in _from:
+                connect(subfrom, _to, parallel=parallel)
+        else:                                               # Assume _to is a sequence of parts
+            for subto in _to:
+                connect(_from, subto, parallel=parallel)
+
+
+def check_pos(pos):
+    if not isinstance(pos, Pos):
+        pos = Pos(*pos)
+    return pos
+
+
+def get_bits_required(number: int | float):
+    """Calculates how many bits are required to store this number.
+
+    Args:
+        number (int | float): The target number.
+    """
+    return ceil(log2(number))
+
+
+def num_to_bit_list(number: int, bit_length: int):
+    """Converts a number to a numpy array of its bits.
+
+    Args:
+        number (int): The number to convert.
+        bit_length (int): The number of bits the list will have.
+    """
+    output = ndarray(bit_length, dtype=bool)
+    for b in range(bit_length):
+        output[b] = bool((number >> b) & 1)
+    return output

{sm_blueprint_lib-0.0.4.dist-info → sm_blueprint_lib-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sm_blueprint_lib
-Version: 0.0.4
+Version: 0.0.6
 Summary: Scrap Mechanic Library for Blueprint manipulation.
 Project-URL: Homepage, https://github.com/MauriceTZ/sm_blueprint_lib
 Project-URL: Issues, https://github.com/MauriceTZ/sm_blueprint_lib/issues

sm_blueprint_lib-0.0.6.dist-info/RECORD

@@ -0,0 +1,38 @@
+sm_blueprint_lib/__init__.py,sha256=yTdxFiDVUYCQoW_vakHBbtoQQfHhYkyGlziEO_BIRWE,215
+sm_blueprint_lib/blueprint.py,sha256=fmdB4XKXF-f-iSoq5ckcLdQAX90ftkfvDuOSzHTB_44,1080
+sm_blueprint_lib/body.py,sha256=sjnS0e1V0bZEhODA6XOxPH2oCt3xrFLQZ47PGhKjD_w,365
+sm_blueprint_lib/bounds.py,sha256=fH-i8PdlZVg8qlEd3FmIf5mbx4RKhdBOFRAe5cSWWiI,183
+sm_blueprint_lib/constants.py,sha256=mll05HrWLGCETzvQlkDPRMBe5HJLAGn5rRkxs5gJ71E,710
+sm_blueprint_lib/id.py,sha256=5sBHC8qZJnCaizSBs4KGS1dnZHOSdoq5wkuIpuYNRnw,71
+sm_blueprint_lib/pos.py,sha256=W0yaIg_nYgRqFwSkHlpd7Tfr69XSVwjTY1DfICHXoDo,411
+sm_blueprint_lib/utils.py,sha256=g3psyklJ6D1PvyL-MQPDN1TqW7Q1JVr1eSuoIdJy0Ro,4819
+sm_blueprint_lib/bases/controllers/basecontroller.py,sha256=VFS5J7kGQ8vfWBFjiTPVfXXjyMwJ1VqA3mYuh7Z_8ak,624
+sm_blueprint_lib/bases/controllers/baselogiccontroller.py,sha256=lDoDt9NKFu01CqyJE09_bq9oDeYK7T-fERO54kd-sFA,290
+sm_blueprint_lib/bases/controllers/logicgatecontroller.py,sha256=wzw8kdt65Zg6ucNNy47V3-okYod_ea2NH8erfjRu7uw,223
+sm_blueprint_lib/bases/controllers/sensorcontroller.py,sha256=Do8TJbnm7EhAMqGPprO9lTxAuNQMOFsSo-FslZZWnqk,710
+sm_blueprint_lib/bases/controllers/timercontroller.py,sha256=GcGzSicm0oGMP3gsuOA5t6PqEhRAsUVHWaCjhClbfMI,229
+sm_blueprint_lib/bases/parts/baseboundablepart.py,sha256=jNx_btmkCTksT6FcpHQxEVJXzN1a3DwwHS-2GdTy2CE,744
+sm_blueprint_lib/bases/parts/baseinteractablepart.py,sha256=VXINrObIr6Y2tFIOI59cB_-625rPwtKZdGDmaa3EgQ8,574
+sm_blueprint_lib/bases/parts/baselogicpart.py,sha256=al9nLCg8YiLKWd_c_ZQmq9f6sazjF6RNbuGGbYROOps,498
+sm_blueprint_lib/bases/parts/basepart.py,sha256=hzJBcB4uol65THzEZEGq4d2N9SbK1S4XiMghEuB6cuc,1126
+sm_blueprint_lib/parts/barrierblock.py,sha256=GPI8ArKKvzO6wnHfBfgmU4Ezcrw9SmtKR0p4mWczYiw,267
+sm_blueprint_lib/parts/logicgate.py,sha256=In7-d-lCx1zJIT-7S0Mh7s32lj7xZ6wxObJMnKJKQQ4,960
+sm_blueprint_lib/parts/sensor.py,sha256=ZJY5xo0NB6wAwgzS7EO-xgsukXYbwV7ptbGOqLfeBKQ,1008
+sm_blueprint_lib/parts/switch.py,sha256=3Yo1xMKV5kWnptgnAA1XR_VU2ft-10EuKR62nzvZ0gI,225
+sm_blueprint_lib/parts/timer.py,sha256=gw9XaWvP2yW3egT72BGowMu-CZFUY-Hke-Dwg0lsxjM,806
+sm_blueprint_lib/prebuilds/adder.py,sha256=Rq-006N_oD5ExIwQelgfrBKd7g8zFVxk4tj2lZEp82w,1750
+sm_blueprint_lib/prebuilds/barrel_shifter.py,sha256=BOvsUg9o6YzVrclmGNzhSbt9eQL23GJHHVyNxkXbcaE,3556
+sm_blueprint_lib/prebuilds/clock40hz.py,sha256=ygG8ieqpFzGMnuY5CBTs60liAYyAsBx-YIlb0gl3SXM,844
+sm_blueprint_lib/prebuilds/comparator.py,sha256=qUvW1MisQMODLz0BdPp1dQbDQQjSYQ0ro6Rsy6ELDjQ,2205
+sm_blueprint_lib/prebuilds/counter.py,sha256=-gQQWvFsNHrCe0SGwNuU3VWkKiXZNx0ippnaz5bfegw,2548
+sm_blueprint_lib/prebuilds/decoder.py,sha256=cvs2JomBfSLc3mwkrHk3z-qRUAgVwrLjgIYV6tdmQ1g,2077
+sm_blueprint_lib/prebuilds/distance_sensor.py,sha256=ooohDPSXtsPO2Hj5YL-kbeWJ_HgqGULqjR5WNOErIPo,1737
+sm_blueprint_lib/prebuilds/ram.py,sha256=YVhswLxG06Ypp8M_PY9PIQdJSbM9I13ktKN6yIgdZ5U,4212
+sm_blueprint_lib/prebuilds/register.py,sha256=MAiplmiA2L_VJaxCX2E8QuancnoqvyLY-vXuaP5bppw,2675
+sm_blueprint_lib/prebuilds/rom.py,sha256=4dxAaNxRX60kDW17NKew-TJkPB7EMfHuK_zVIm6N-jo,3700
+sm_blueprint_lib/prebuilds/timer_ram_cached.py,sha256=PG53hDKYS00fur5vazh7iOs2Gm4G_URJLX7d9xWJOe4,19057
+sm_blueprint_lib/prebuilds/timer_ram_multiclient.py,sha256=NlQeJB6ilEGJDrIOfkFmPWd7afDR_0CUZH7RQpjyA4s,4200
+sm_blueprint_lib-0.0.6.dist-info/METADATA,sha256=PuNO-nrz_OB8Iq0BGapU0yrouBhfC5d0bbkxfkv8yXM,611
+sm_blueprint_lib-0.0.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sm_blueprint_lib-0.0.6.dist-info/licenses/LICENSE,sha256=DWhaodryTSEv07KdWbanCMaEujOXYxnj-IEhmgTkOq0,1084
+sm_blueprint_lib-0.0.6.dist-info/RECORD,,

sm_blueprint_lib-0.0.4.dist-info/RECORD

@@ -1,28 +0,0 @@
-sm_blueprint_lib/__init__.py,sha256=9ktxwUvthBopqAAg6vPnLAwiOP97nnLpPcH2wY-weG0,4915
-sm_blueprint_lib/blueprint.py,sha256=foTUnSeMMcpfTKL-NnhkYE9vUX8QqG5qndTDVnaJ8Ps,1128
-sm_blueprint_lib/body.py,sha256=6Daa4mjUwrBYQjowTbDozEWsESVTtkhqW4441TwZJDM,397
-sm_blueprint_lib/bounds.py,sha256=fH-i8PdlZVg8qlEd3FmIf5mbx4RKhdBOFRAe5cSWWiI,183
-sm_blueprint_lib/constants.py,sha256=mll05HrWLGCETzvQlkDPRMBe5HJLAGn5rRkxs5gJ71E,710
-sm_blueprint_lib/id.py,sha256=5sBHC8qZJnCaizSBs4KGS1dnZHOSdoq5wkuIpuYNRnw,71
-sm_blueprint_lib/pos.py,sha256=W0yaIg_nYgRqFwSkHlpd7Tfr69XSVwjTY1DfICHXoDo,411
-sm_blueprint_lib/bases/controllers/basecontroller.py,sha256=wWz2dMvBzBG9Zn1l_sZf5L-L5lwNRMhNTynFSLC4KPs,652
-sm_blueprint_lib/bases/controllers/baselogiccontroller.py,sha256=PNQhukaP8jceHs7O3b33xbKalS1Bym8x5T4ZN7XNGyQ,324
-sm_blueprint_lib/bases/controllers/logicgatecontroller.py,sha256=g-Cla8kvFA77KQkAMbRxfyS_tvjFaIf6GJjOfsQ1FsY,257
-sm_blueprint_lib/bases/controllers/sensorcontroller.py,sha256=K_nE8RmQSCxXAEiwpWeMSpeZtxXePbn_BDbgkkgMtEM,744
-sm_blueprint_lib/bases/controllers/timercontroller.py,sha256=q0eusjpJ2EQ82mfxMHJP6ok5QH29eqIUpkzNfGLGsAQ,263
-sm_blueprint_lib/prebuilds/adder.py,sha256=eWABQFvpuB2hHosMzD2LgJkdn_rLh00Wptc75UR8eT4,1804
-sm_blueprint_lib/prebuilds/barrel_shifter.py,sha256=soDQWvOCfSNo3G3HXjglIfjte-QCil72SpwQDDDS7UE,3610
-sm_blueprint_lib/prebuilds/clock40hz.py,sha256=XOEe1pthSGnVznU64itpzUMYCNsAJS-nrNxftgY-vJ0,898
-sm_blueprint_lib/prebuilds/comparator.py,sha256=FuEz72Bh7G5yKHiuApnaF_mjuW-fwikxgjOUXK2H4UE,2259
-sm_blueprint_lib/prebuilds/counter.py,sha256=zsfC6UKDH9PPrb9dDcM8G80_-QIPk9wAFYlu4US6eao,2602
-sm_blueprint_lib/prebuilds/decoder.py,sha256=Ofso078Llj5Wu__9k0E_Q9-rREZu294piifdpA4mqGM,2131
-sm_blueprint_lib/prebuilds/distance_sensor.py,sha256=RWvaoPYJySkjcrD6gfugho26QxQGc1Ub-Wmox8gUtdI,1821
-sm_blueprint_lib/prebuilds/ram.py,sha256=YGzalt72H5vYKxcVqNkXLm_VbcoyebGlmRRp8oiTfZM,4281
-sm_blueprint_lib/prebuilds/register.py,sha256=Y66NazPvjhajMQqBA4dwtdoFAxiwpeHBu8WMqbymUAA,2744
-sm_blueprint_lib/prebuilds/rom.py,sha256=74rNXxVUCqvdsPhsUW7gLI-f2-jQa4-CWT04uyUAQAE,3784
-sm_blueprint_lib/prebuilds/timer_ram_cached.py,sha256=EFEQP-fOt9M5U_tM3WdwwPFjr70BzbD_U1Ay4jfCTzo,19246
-sm_blueprint_lib/prebuilds/timer_ram_multiclient.py,sha256=76domx9N9WelMIxIxTX4i-S66B6wTItOPIlXj1KIYdE,4329
-sm_blueprint_lib-0.0.4.dist-info/METADATA,sha256=0rNXUr3hq67wWgIsIaPu1UQgnFsvtnhboAwuUSbCpuo,611
-sm_blueprint_lib-0.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sm_blueprint_lib-0.0.4.dist-info/licenses/LICENSE,sha256=DWhaodryTSEv07KdWbanCMaEujOXYxnj-IEhmgTkOq0,1084
-sm_blueprint_lib-0.0.4.dist-info/RECORD,,