amulet-core 2.0a7__cp311-cp311-win_amd64.whl → 2.0.1a2.post250529084738__cp311-cp311-win_amd64.whl

amulet/selection/group.py

@@ -1,481 +0,0 @@
-from __future__ import annotations
-
-import numpy
-
-from typing import Iterable, Iterator, overload, Any
-import warnings
-
-from amulet.data_types import (
-    BlockCoordinates,
-    ChunkCoordinates,
-    SubChunkCoordinates,
-    FloatTriplet,
-)
-from amulet.data_types import (
-    PointCoordinates,
-    PointCoordinatesArray,
-)
-from .abstract_selection import AbstractBaseSelection
-from .box import SelectionBox
-
-
-class SelectionGroup(AbstractBaseSelection, Iterable[SelectionBox]):
-    """
-    A container for zero or more :class:`SelectionBox` instances.
-
-    This allows for non-rectangular and non-contiguous selections.
-    """
-
-    _selection_boxes: tuple[SelectionBox, ...]
-
-    def __init__(self, selection_boxes: SelectionBox | Iterable[SelectionBox] = ()):
-        """
-        Construct a new :class:`SelectionGroup` class from the given data.
-
-        >>> SelectionGroup(SelectionBox((0, 0, 0), (1, 1, 1)))
-        >>> SelectionGroup([
-        >>>     SelectionBox((0, 0, 0), (1, 1, 1)),
-        >>>     SelectionBox((1, 1, 1), (2, 2, 2))
-        >>> ])
-
-        :param selection_boxes: A :class:`SelectionBox` or iterable of :class:`SelectionBox` classes.
-        """
-        if isinstance(selection_boxes, SelectionBox):
-            self._selection_boxes = (selection_boxes,)
-        else:
-            self._selection_boxes = tuple(
-                box for box in selection_boxes if isinstance(box, SelectionBox)
-            )
-
-    def __repr__(self) -> str:
-        boxes = ", ".join([repr(box) for box in self.selection_boxes])
-        return f"SelectionGroup([{boxes}])"
-
-    def __str__(self) -> str:
-        boxes = ", ".join([str(box) for box in self.selection_boxes])
-        return f"[{boxes}]"
-
-    def __eq__(self, other: Any) -> bool:
-        """
-        Does the contents of this :class:`SelectionGroup` match the other :class:`SelectionGroup`.
-
-        Note if the boxes do not exactly match this will return False even if the volume represented is the same.
-
-        :param other: The other :class:`SelectionGroup` to compare with.
-        :return: True if the boxes contained match.
-        """
-        if not isinstance(other, SelectionGroup):
-            return NotImplemented
-        return self.selection_boxes_sorted == other.selection_boxes_sorted
-
-    def __add__(self, boxes: Iterable[SelectionBox]) -> SelectionGroup:
-        """
-        Add an iterable of :class:`SelectionBox` classes to this :class:`SelectionGroup`.
-
-        Note this will construct a new :class:`SelectionGroup` because it is immutable so cannot be modified in place.
-
-        >>> group1 = SelectionGroup(SelectionBox((-1, -1, -1), (0, 0, 0)))
-        >>> group2 = SelectionGroup([
-        >>>     SelectionBox((0, 0, 0), (1, 1, 1)),
-        >>>     SelectionBox((1, 1, 1), (2, 2, 2))
-        >>> ])
-        >>> group1 + group2
-        SelectionGroup([SelectionBox((-1, -1, -1), (0, 0, 0)), SelectionBox((0, 0, 0), (1, 1, 1)), SelectionBox((1, 1, 1), (2, 2, 2))])
-        >>> group1 += group2
-        >>> group1
-        SelectionGroup([SelectionBox((-1, -1, -1), (0, 0, 0)), SelectionBox((0, 0, 0), (1, 1, 1)), SelectionBox((1, 1, 1), (2, 2, 2))])
-
-        :param boxes: An iterable of boxes to add to this group.
-        :return: A new :class:`SelectionGroup` class containing the boxes from this instance and those in ``boxes``.
-        """
-        try:
-            boxes = tuple(boxes)
-        except:
-            return NotImplemented
-        if not all(isinstance(b, SelectionBox) for b in boxes):
-            return NotImplemented
-        return SelectionGroup(tuple(self) + boxes)
-
-    def __iter__(self) -> Iterator[SelectionBox]:
-        """An iterable of all the :class:`SelectionBox` classes in the group."""
-        yield from self._selection_boxes
-
-    def __len__(self) -> int:
-        """The number of :class:`SelectionBox` classes in the group."""
-        return len(self._selection_boxes)
-
-    def contains_block(self, x: int, y: int, z: int) -> bool:
-        return any(box.contains_block(x, y, z) for box in self._selection_boxes)
-
-    def contains_point(self, x: float, y: float, z: float) -> bool:
-        return any(box.contains_point(x, y, z) for box in self._selection_boxes)
-
-    @property
-    def blocks(self) -> Iterator[BlockCoordinates]:
-        """
-        The location of every block in the selection.
-
-        >>> group: SelectionGroup
-        >>> for x, y, z in group.blocks:
-        >>>     ...
-
-        Note: if boxes intersect, the blocks in the intersected region will be included multiple times.
-
-        If this behaviour is not desired the :meth:`merge_boxes` method will return a new SelectionGroup with no intersections.
-
-        >>> for x, y, z in group.merge_boxes().blocks:
-        >>>     ...
-
-        :return: An iterable of block locations.
-        """
-        for box in self.selection_boxes:
-            for coord in box.blocks:
-                yield coord
-
-    def __bool__(self) -> bool:
-        """Are there any boxes in the group."""
-        return bool(self._selection_boxes)
-
-    @overload
-    def __getitem__(self, item: int) -> SelectionBox: ...
-
-    @overload
-    def __getitem__(self, item: slice) -> SelectionGroup: ...
-
-    def __getitem__(self, item: int | slice) -> SelectionBox | SelectionGroup:
-        """Get the selection box at the given index."""
-        val = self._selection_boxes[item]
-        if isinstance(val, tuple):
-            return SelectionGroup(val)
-        else:
-            return val
-
-    @property
-    def min(self) -> BlockCoordinates:
-        """The minimum point of all the boxes in the group."""
-        return tuple(self.min_array.tolist())
-
-    @property
-    def min_array(self) -> numpy.ndarray:
-        """The minimum point of all the boxes in the group as a numpy array."""
-        if self._selection_boxes:
-            return numpy.min(numpy.array([box.min for box in self._selection_boxes]), 0)  # type: ignore
-        else:
-            raise ValueError("SelectionGroup does not contain any SelectionBoxes")
-
-    @property
-    def min_x(self) -> int:
-        return int(self.min_array[0])
-
-    @property
-    def min_y(self) -> int:
-        return int(self.min_array[1])
-
-    @property
-    def min_z(self) -> int:
-        return int(self.min_array[2])
-
-    @property
-    def max(self) -> BlockCoordinates:
-        """The maximum point of all the boxes in the group."""
-        return tuple(self.max_array.tolist())
-
-    @property
-    def max_array(self) -> numpy.ndarray:
-        """The maximum point of all the boxes in the group as a numpy array."""
-        if self._selection_boxes:
-            return numpy.max(numpy.array([box.max for box in self._selection_boxes]), 0)  # type: ignore
-        else:
-            raise ValueError("SelectionGroup does not contain any SelectionBoxes")
-
-    @property
-    def max_x(self) -> int:
-        return int(self.max_array[0])
-
-    @property
-    def max_y(self) -> int:
-        return int(self.max_array[1])
-
-    @property
-    def max_z(self) -> int:
-        return int(self.max_array[2])
-
-    @property
-    def bounds(self) -> tuple[BlockCoordinates, BlockCoordinates]:
-        return self.min, self.max
-
-    @property
-    def bounds_array(self) -> numpy.ndarray:
-        return numpy.array([self.min_array, self.max_array])
-
-    def to_box(self) -> SelectionBox:
-        """Create a `SelectionBox` based off the bounds of the boxes in the group."""
-        warnings.warn(
-            "to_box is depceciated. Use bounding_box instead.", DeprecationWarning
-        )
-        return self.bounding_box()
-
-    def bounding_box(self) -> SelectionBox:
-        return SelectionBox(self.min, self.max)
-
-    def selection_group(self) -> SelectionGroup:
-        return self
-
-    def merge_boxes(self) -> SelectionGroup:
-        """
-        Take the boxes as they were given to this class, merge neighbouring boxes and remove overlapping regions.
-
-        The result should be a SelectionGroup containing one or more SelectionBox classes that represents the same
-        volume as the original but with no overlapping boxes.
-        """
-        # remove duplicates
-        selection_boxes: list[SelectionBox] = []
-        for box in self.selection_boxes:
-            if not any(box == box_ for box_ in selection_boxes):
-                selection_boxes.append(box)
-
-        if len(selection_boxes) >= 2:
-            merge_boxes = True
-            while merge_boxes:
-                # find two neighbouring boxes and merge them
-                merge_boxes = False  # if two boxes get merged this will be set back to True and this will run again.
-                box_index = 0  # the index of the first box
-                while box_index < len(selection_boxes):
-                    box = selection_boxes[box_index]
-                    other_index = box_index + 1  # the index of the second box.
-                    # This always starts at one greater than box_index because
-                    # the lower values were already checked the other way around
-                    while other_index < len(selection_boxes):
-                        other = selection_boxes[other_index]
-                        x_dim = box.min_x == other.min_x and box.max_x == other.max_x
-                        y_dim = box.min_y == other.min_y and box.max_y == other.max_y
-                        z_dim = box.min_z == other.min_z and box.max_z == other.max_z
-
-                        x_border = box.max_x == other.min_x or other.max_x == box.min_x
-                        y_border = box.max_y == other.min_y or other.max_y == box.min_y
-                        z_border = box.max_z == other.min_z or other.max_z == box.min_z
-
-                        if (
-                            (x_dim and y_dim and z_border)
-                            or (x_dim and z_dim and y_border)
-                            or (y_dim and z_dim and x_border)
-                        ):
-                            selection_boxes.pop(other_index)
-                            selection_boxes.pop(box_index)
-                            selection_boxes.append(
-                                SelectionBox(
-                                    numpy.min([box.min, other.min], 0),
-                                    numpy.max([box.max, other.max], 0),
-                                )
-                            )
-                            merge_boxes = True
-                            box = selection_boxes[box_index]
-                            other_index = box_index + 1
-                        else:
-                            other_index += 1
-                    box_index += 1
-        return SelectionGroup(selection_boxes)
-
-    @property
-    def is_contiguous(self) -> bool:
-        """
-        Does the SelectionGroup represent one connected region (True) or multiple separated regions (False).
-
-        If two boxes are touching at the corners this is classed as contiguous.
-        """
-        # TODO: This needs some work. It will only work if the selections touch in a chain
-        #  it does not care if it loops back and intersects itself. Does intersecting count as being contiguous?
-        #  I would say yes
-        if len(self._selection_boxes) == 1:
-            return True
-
-        for i in range(len(self._selection_boxes) - 1):
-            sub_box: SelectionBox = self._selection_boxes[i]
-            next_box: SelectionBox = self._selection_boxes[i + 1]
-            if not sub_box.touches(next_box):
-                return False
-
-        return True
-
-    @property
-    def is_rectangular(self) -> bool:
-        """
-        Checks if the SelectionGroup is a rectangle
-
-        :return: True is the selection is a rectangle, False otherwise
-        """
-        return (
-            len(self._selection_boxes) == 1
-            or len(self.merge_boxes().selection_boxes) == 1
-        )
-
-    @property
-    def selection_boxes(self) -> tuple[SelectionBox, ...]:
-        """
-        A tuple of the :class:`SelectionBox` instances stored for this group.
-        """
-        return self._selection_boxes
-
-    @property
-    def selection_boxes_sorted(self) -> list[SelectionBox]:
-        """
-        A list of the :class:`SelectionBox` instances for this group sorted by their hash.
-        """
-        return sorted(self._selection_boxes, key=hash)
-
-    def chunk_count(self, sub_chunk_size: int = 16) -> int:
-        return len(self.chunk_locations(sub_chunk_size))
-
-    def chunk_locations(self, sub_chunk_size: int = 16) -> set[ChunkCoordinates]:
-        return set(
-            location
-            for box in self.selection_boxes
-            for location in box.chunk_locations(sub_chunk_size)
-        )
-
-    def chunk_boxes(
-        self, sub_chunk_size: int = 16
-    ) -> Iterator[tuple[ChunkCoordinates, SelectionBox]]:
-        for box in self.selection_boxes:
-            yield from box.chunk_boxes(sub_chunk_size)
-
-    def sub_chunk_count(self, sub_chunk_size: int = 16) -> int:
-        return len(self.sub_chunk_locations(sub_chunk_size))
-
-    def sub_chunk_locations(self, sub_chunk_size: int = 16) -> set[SubChunkCoordinates]:
-        return set(
-            location
-            for box in self.selection_boxes
-            for location in box.sub_chunk_locations(sub_chunk_size)
-        )
-
-    def sub_chunk_boxes(
-        self, sub_chunk_size: int = 16
-    ) -> Iterator[tuple[SubChunkCoordinates, SelectionBox]]:
-        for box in self.selection_boxes:
-            for (cx, cy, cz), sub_box in box.sub_chunk_boxes(sub_chunk_size):
-                yield (cx, cy, cz), box
-
-    def _intersects(self, other: AbstractBaseSelection) -> bool:
-        if isinstance(other, SelectionBox):
-            return any(self_box.intersects(other) for self_box in self.selection_boxes)
-        elif isinstance(other, SelectionGroup):
-            return any(
-                self_box.intersects(other_box)
-                for self_box in self.selection_boxes
-                for other_box in other.selection_boxes
-            )
-        return NotImplemented
-
-    def intersection(self, other: AbstractBaseSelection) -> SelectionGroup:
-        return self._intersection(other)
-
-    def _intersection(self, other: AbstractBaseSelection) -> SelectionGroup:
-        group = other.selection_group()
-        intersection: list[SelectionBox] = []
-        for self_box in self.selection_boxes:
-            for other_box in group:
-                if self_box.intersects(other_box):
-                    intersection.append(self_box.intersection(other_box))
-        return SelectionGroup(intersection)
-
-    def subtract(self, other: AbstractBaseSelection) -> SelectionGroup:
-        """
-        Returns a new :class:`SelectionGroup` containing the volume that does not intersect with other.
-
-        This may be empty if other fully contains self or equal to self if they do not intersect.
-
-        :param other: The :class:`SelectionBox` or :class:`SelectionGroup` to subtract.
-        """
-        return self._subtract(other)
-
-    def _subtract(self, other: AbstractBaseSelection) -> SelectionGroup:
-        group = other.selection_group()
-        selections = self
-        for other_box in group:
-            # for each box in other
-            selections_new = SelectionGroup()
-            for self_box in selections:
-                selections_new += self_box.subtract(other_box)
-            selections = selections_new
-            if not selections:
-                break
-        return selections
-
-    def union(self, other: AbstractBaseSelection) -> SelectionGroup:
-        """
-        Returns a new SelectionGroup containing the volume of self and other.
-
-        :param other: The other selection to add to this one.
-        """
-        group = other.selection_group()
-        if group.is_subset(self):
-            return self
-        else:
-            return self.subtract(group) + group
-
-    def is_subset(self, other: AbstractBaseSelection) -> bool:
-        """
-        Is this selection completely contained within ``other``.
-
-        :param other: The other selection to test against.
-        :return: True if this selection completely fits in other.
-        """
-        return not self.subtract(other.selection_group())
-
-    def closest_vector_intersection(
-        self,
-        origin: PointCoordinates | PointCoordinatesArray,
-        direction: PointCoordinates | PointCoordinatesArray,
-    ) -> tuple[int | None, float]:
-        """
-        Returns the index for the closest box in the look vector and the multiplier of the look vector to get there.
-
-        :param origin: The origin of the vector
-        :param direction: The vector magnitude in x, y and z
-        :return: Index for the closest box and the multiplier of the vector to get there. None, inf if no intersection.
-        """
-        index_return = None
-        multiplier = float("inf")
-        for index, box in enumerate(self._selection_boxes):
-            mult = box.intersects_vector(origin, direction)
-            if mult is not None and mult < multiplier:
-                multiplier = mult
-                index_return = index
-        return index_return, multiplier
-
-    def transform(
-        self, scale: FloatTriplet, rotation: FloatTriplet, translation: FloatTriplet
-    ) -> SelectionGroup:
-        """
-        Creates a new :class:`SelectionGroup` transformed by the given inputs.
-
-        :param scale: A tuple of scaling factors in the x, y and z axis.
-        :param rotation: The rotation about the x, y and z axis in radians.
-        :param translation: The translation about the x, y and z axis.
-        :return: A new :class:`~amulet.api.selection.SelectionGroup` representing the transformed selection.
-        """
-        selection_group = SelectionGroup()
-        for selection in self.selection_boxes:
-            selection_group += selection.transform(scale, rotation, translation)
-        return selection_group
-
-    @property
-    def volume(self) -> int:
-        return sum(box.volume for box in self.selection_boxes)
-
-    @property
-    def footprint_area(self) -> int:
-        """
-        The 2D area that the selection fills when looking at the selection from above.
-        """
-        return (
-            SelectionGroup(
-                [
-                    SelectionBox((box.min_x, 0, box.min_z), (box.max_x, 1, box.max_z))
-                    for box in self.selection_boxes
-                ]
-            )
-            .merge_boxes()
-            .volume
-        )

amulet/utils/__init__.pyi

@@ -1,23 +0,0 @@
-from __future__ import annotations
-
-from . import (
-    call_spec,
-    matrix,
-    numpy,
-    shareable_lock,
-    signal,
-    task_manager,
-    weakref,
-    world_utils,
-)
-
-__all__ = [
-    "call_spec",
-    "matrix",
-    "numpy",
-    "shareable_lock",
-    "signal",
-    "task_manager",
-    "weakref",
-    "world_utils",
-]

amulet/utils/call_spec/__init__.py

@@ -1,24 +0,0 @@
-from ._call_spec import (
-    AbstractArg,
-    AbstractHashableArg,
-    ConstantArg,
-    StringArg,
-    FilePathArg,
-    DirectoryPathArg,
-    BytesArg,
-    BoolArg,
-    IntArg,
-    FloatArg,
-    TupleArg,
-    HashableTupleArg,
-    SequenceArg,
-    DictArg,
-    UnionArg,
-    HashableUnionArg,
-    CallableArg,
-    HashableCallableArg,
-    PositionalArgs,
-    CallSpec,
-    callable_spec,
-    method_spec,
-)