factorio-draftsman 2.0.0__tar.gz → 2.0.1__tar.gz

{factorio_draftsman-2.0.0/factorio_draftsman.egg-info → factorio_draftsman-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: factorio-draftsman
-Version: 2.0.0
+Version: 2.0.1
 Summary: A complete, well-tested, and up-to-date module to manipulate Factorio blueprint strings. Compatible with mods.
 Home-page: https://github.com/redruin1/factorio-draftsman
 Author: redruin1
@@ -19,6 +19,14 @@ Requires-Dist: GitPython>=3.1.43
 Requires-Dist: typing
 Requires-Dist: typing_extensions; python_version < "3.8"
 Requires-Dist: thefuzz
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
 
 # factorio-draftsman
 

factorio_draftsman-2.0.1/draftsman/_factorio_version.py

@@ -0,0 +1,4 @@
+# _factorio_version.py
+
+__factorio_version__ = "2.0.42.0"
+__factorio_version_info__ = (2, 0, 42, 0)

factorio_draftsman-2.0.1/draftsman/_version.py

@@ -0,0 +1,4 @@
+# _version.py
+
+__version__ = "2.0.1"
+__version_info__ = (2, 0, 1)

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/collection.py

@@ -795,19 +795,25 @@ class EntityCollection(metaclass=ABCMeta):
         # if not isinstance(location_2, tuple):
         #     location_2 = (location_2, "input")
 
-        if not isinstance(entity_1, EntityLike):
+        if isinstance(entity_1, EntityLike):
+            if entity_1 not in self.entities:
+                raise InvalidAssociationError(
+                    "entity_1 ({}) not contained within this collection".format(
+                        entity_1
+                    )
+                )
+        else:
             entity_1 = self.entities[entity_1]
-        if not isinstance(entity_2, EntityLike):
-            entity_2 = self.entities[entity_2]
 
-        if entity_1 not in self.entities:
-            raise InvalidAssociationError(
-                "entity_1 ({}) not contained within this collection".format(entity_1)
-            )
-        if entity_2 not in self.entities:
-            raise InvalidAssociationError(
-                "entity_2 ({}) not contained within this collection".format(entity_2)
-            )
+        if isinstance(entity_2, EntityLike):
+            if entity_2 not in self.entities:
+                raise InvalidAssociationError(
+                    "entity_2 ({}) not contained within this collection".format(
+                        entity_2
+                    )
+                )
+        else:
+            entity_2 = self.entities[entity_2]
 
         if color not in {"red", "green"}:
             raise InvalidWireTypeError(color)

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/entity.py

@@ -22,7 +22,10 @@ from draftsman.signatures import (
 from draftsman.warning import UnknownEntityWarning
 from draftsman import utils, __factorio_version_info__
 
+from draftsman.data.planets import get_surface_properties
+
 import copy
+import math
 from pydantic import (
     ConfigDict,
     Field,
@@ -108,6 +111,16 @@ class Entity(Exportable, EntityLike):
             The internal ID of the entity.
             """,
         )
+        quality: Literal[
+            "normal", "uncommon", "rare", "epic", "legendary"
+        ] = Field(  # TODO: determine these automatically
+            "normal",
+            description="""
+            The quality of the entity. Defaults to 'normal' when not specified,
+            or when quality is not present in the save being imported to /
+            exported from.
+            """,
+        )
         position: FloatPosition = Field(
             ...,
             description="""
@@ -188,6 +201,7 @@ class Entity(Exportable, EntityLike):
         self,
         name: Optional[str],
         similar_entities: list[str],
+        quality: Optional[str] = "normal",
         tile_position: IntPosition = (0, 0),
         id: str = None,
         validate: Union[
@@ -256,7 +270,13 @@ class Entity(Exportable, EntityLike):
         #     **{"position": {"x": 0, "y": 0}, "entity_number": 0, **kwargs}
         # )
         self._root = type(self).Format.model_validate(
-            {"name": name, "position": {"x": 0, "y": 0}, "entity_number": 0, **kwargs},
+            {
+                "name": name,
+                "quality": quality,
+                "position": {"x": 0, "y": 0},
+                "entity_number": 0,
+                **kwargs,
+            },
             strict=False,
             context={"construction": True, "mode": ValidationMode.NONE},
         )
@@ -276,6 +296,9 @@ class Entity(Exportable, EntityLike):
         # Name
         self.name = name
 
+        # Quality
+        self.quality = quality
+
         # ID (used in Blueprints and Groups)
         self.id = id
 
@@ -404,6 +427,26 @@ class Entity(Exportable, EntityLike):
 
     # =========================================================================
 
+    @property
+    def quality(self) -> str:  # TODO: literals
+        """
+        The quality of this entity. Can modify certain other attributes of the
+        entity in (usually) positive ways.
+        """
+        return self._root.quality
+
+    @quality.setter
+    def quality(self, value: str) -> None:  # TODO: literals
+        if self.validate_assignment:
+            result = attempt_and_reissue(
+                self, type(self).Format, self._root, "quality", value
+            )
+            self._root.quality = result
+        else:
+            self._root.quality = value
+
+    # =========================================================================
+
     @property
     def position(self) -> Vector:
         """
@@ -601,6 +644,20 @@ class Entity(Exportable, EntityLike):
 
     # =========================================================================
 
+    @property
+    def surface_conditions(self) -> Optional[dict]:
+        """
+        Gets the dictionary of surface constraints which apply when placing this
+        entity. If this entity has no constraints whatsoever, an empty
+        dictionary is returned. If this entity is unrecognized by Draftsman,
+        `None` is returned. Not exported; read only.
+        """
+        return entities.raw.get(self.name, {"surface_conditions": None}).get(
+            "surface_conditions", {}
+        )
+
+    # =========================================================================
+
     @property
     def tags(self) -> Optional[dict[str, Any]]:
         """
@@ -628,6 +685,18 @@ class Entity(Exportable, EntityLike):
 
     # =========================================================================
 
+    def is_placable_on(self, surface_name: str) -> True:
+        """
+        Check to see if this entity is placable on a particular planet/surface.
+        `surface_name` must be the name of a registered surface in `data.planets`.
+        If the `surface_properties` of this entity are unknown, then this
+        function always returns `True`.
+        """
+        surface_properties = get_surface_properties(surface_name)
+        return utils.passes_surface_conditions(
+            self.surface_conditions, surface_properties
+        )
+
     def validate(
         self, mode: ValidationMode = ValidationMode.STRICT, force: bool = False
     ) -> ValidationResult:

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/exportable.py

@@ -25,6 +25,8 @@ def attempt_and_reissue(
         "environment_version": __factorio_version_info__,
         **kwargs,
     }
+    if object.validate_assignment == ValidationMode.NONE:
+        context["construction"] = True
     try:
         result = format_model.__pydantic_validator__.validate_assignment(
             target,

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/artillery_auto_target.py

@@ -1,50 +1,50 @@
-# artillery_auto_target.py
-
-from draftsman.classes.exportable import attempt_and_reissue
-
-from pydantic import BaseModel, Field
-from typing import Optional
-
-
-class ArtilleryAutoTargetMixin:
-    """
-    Gives the entity the "artillery_auto_targeting" parameter. Used by artillery
-    turrets and artillery wagons.
-    """
-
-    class Format(BaseModel):
-        artillery_auto_targeting: Optional[bool] = Field(
-            True,
-            description="""
-            Whether or not this turret automatically targets enemy structures 
-            in its range.
-            """,
-        )
-
-    def __init__(self, name: str, similar_entities: list[str], **kwargs):
-        super().__init__(name, similar_entities, **kwargs)
-
-        self.auto_target = kwargs.get("artillery_auto_targeting", None)
-
-    # =========================================================================
-
-    @property
-    def auto_target(self) -> bool:
-        """
-        TODO
-        """
-        return self._root.artillery_auto_targeting
-
-    @auto_target.setter
-    def auto_target(self, value: Optional[bool]) -> None:
-        if self.validate_assignment:
-            result = attempt_and_reissue(
-                self,
-                self.Format,
-                self._root,
-                "artillery_auto_targeting",
-                value,
-            )
-            self._root.artillery_auto_targeting = result
-        else:
-            self._root.artillery_auto_targeting = value
+# artillery_auto_target.py
+
+from draftsman.classes.exportable import attempt_and_reissue
+
+from pydantic import BaseModel, Field
+from typing import Optional
+
+
+class ArtilleryAutoTargetMixin:
+    """
+    Gives the entity the "artillery_auto_targeting" parameter. Used by artillery
+    turrets and artillery wagons.
+    """
+
+    class Format(BaseModel):
+        artillery_auto_targeting: Optional[bool] = Field(
+            True,
+            description="""
+            Whether or not this turret automatically targets enemy structures 
+            in its range.
+            """,
+        )
+
+    def __init__(self, name: str, similar_entities: list[str], **kwargs):
+        super().__init__(name, similar_entities, **kwargs)
+
+        self.auto_target = kwargs.get("artillery_auto_targeting", None)
+
+    # =========================================================================
+
+    @property
+    def auto_target(self) -> bool:
+        """
+        TODO
+        """
+        return self._root.artillery_auto_targeting
+
+    @auto_target.setter
+    def auto_target(self, value: Optional[bool]) -> None:
+        if self.validate_assignment:
+            result = attempt_and_reissue(
+                self,
+                self.Format,
+                self._root,
+                "artillery_auto_targeting",
+                value,
+            )
+            self._root.artillery_auto_targeting = result
+        else:
+            self._root.artillery_auto_targeting = value

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/circuit_condition.py

@@ -15,7 +15,7 @@ class CircuitConditionMixin:  # (ControlBehaviorMixin)
     """
 
     class ControlFormat(BaseModel):
-        circuit_enabled: Optional[bool] = Field(
+        circuit_condition_enabled: Optional[bool] = Field(
             False,
             description="""
             Whether or not the entity is controlled by the specified circuit

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/circuit_enable.py

@@ -19,7 +19,7 @@ class CircuitEnableMixin:  # (ControlBehaviorMixin)
             False,
             description="""
             Whether or not this machine will be toggled by some circuit 
-            condition. Many machines reuse this parameter name, but others have
+            network. Many machines reuse this parameter name, but others have
             unique ones specific to their types.
             """,  # TODO: examples of different keys
         )

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/control_behavior.py

@@ -95,7 +95,11 @@ class ControlBehaviorMixin:
 
         self.control_behavior = other.control_behavior
 
-    def to_dict(self, exclude_none: bool = True, exclude_defaults: bool = True) -> dict:
+    # =========================================================================
+
+    def to_dict(
+        self, exclude_none: bool = True, exclude_defaults: bool = True
+    ) -> dict:  # TODO: FIXME
         result = super().to_dict(
             exclude_none=exclude_none, exclude_defaults=exclude_defaults
         )

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/filters.py

@@ -3,10 +3,10 @@
 from draftsman.classes.exportable import attempt_and_reissue, test_replace_me
 from draftsman.data import items, entities
 from draftsman.error import InvalidItemError, DataFormatError
-from draftsman.signatures import DraftsmanBaseModel, FilterEntry, ItemName, int64
+from draftsman.signatures import DraftsmanBaseModel, ItemFilter, ItemName, int64
 
 from pydantic import Field, ValidationError, ValidationInfo, field_validator
-from typing import Any, Optional
+from typing import Any, Literal, Optional
 
 
 class FiltersMixin:
@@ -15,7 +15,13 @@ class FiltersMixin:
     """
 
     class Format(DraftsmanBaseModel):
-        filters: Optional[list[FilterEntry]] = Field(
+        use_filters: Optional[bool] = Field(
+            False,
+            description="""
+            Whether or not this inserter should use filters
+            """,
+        )
+        filters: Optional[list[ItemFilter]] = Field(
             [],
             description="""
             Any item filters that this inserter or loader has.
@@ -57,15 +63,38 @@ class FiltersMixin:
             "filter_count", 0
         )
 
+    # =========================================================================
+
+    @property
+    def use_filters(self) -> Optional[bool]:
+        """
+        Whether or not this inserter should use filters at all. Overrided by
+        ``circuit_set_filters``, if present.
+        """
+        return self._root.use_filters
+
+    @use_filters.setter
+    def use_filters(self, value: Optional[list[ItemFilter]]):
+        test_replace_me(
+            self,
+            type(self).Format,
+            self._root,
+            "use_filters",
+            value,
+            self.validate_assignment,
+        )
+
+    # =========================================================================
+
     @property
-    def filters(self) -> Optional[list[FilterEntry]]:
+    def filters(self) -> Optional[list[ItemFilter]]:
         """
         TODO
         """
         return self._root.filters
 
     @filters.setter
-    def filters(self, value: Optional[list[FilterEntry]]):
+    def filters(self, value: Optional[list[ItemFilter]]):
         test_replace_me(
             self,
             type(self).Format,
@@ -84,7 +113,15 @@ class FiltersMixin:
 
     # =========================================================================
 
-    def set_item_filter(self, index: int64, item: ItemName):
+    def set_item_filter(
+        self,
+        index: int64,
+        item: ItemName,
+        quality: Literal[
+            "normal", "uncommon", "rare", "epic", "legendary", "any"
+        ] = "normal",
+        comparator: Literal[">", "<", "=", "==", "≥", ">=", "≤", "<=", "≠", "!="] = "=",
+    ):
         """
         Sets one of the item filters of the Entity. `index` in this function is
         in 0-based notation.
@@ -98,7 +135,9 @@ class FiltersMixin:
         """
         if item is not None:
             try:
-                new_entry = FilterEntry(index=index, name=item)
+                new_entry = ItemFilter(
+                    index=index, name=item, quality=quality, comparator=comparator
+                )
                 new_entry.index += 1
             except ValidationError as e:
                 raise DataFormatError(e) from None
@@ -124,7 +163,7 @@ class FiltersMixin:
         )
         self.filters = result
 
-    def set_item_filters(self, *filters: Optional[list[FilterEntry]]):
+    def set_item_filters(self, *filters: Optional[list[ItemFilter]]):
         """
         Sets all of the item filters of the Entity.
 

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/inventory.py

@@ -47,8 +47,12 @@ class InventoryMixin:
                 return bar
 
             warning_list: list = info.context["warning_list"]
-            entity = info.context["object"]
-            if not entity.inventory_bar_enabled:
+            entity: InventoryMixin = info.context["object"]
+
+            # Make sure to check that it's `False`; this attribute can return
+            # `None` if it doesn't recognize the entity, and in that case we
+            # don't want to issue a warning at all
+            if entity.inventory_bar_enabled is False:
                 warning_list.append(BarWarning("This entity does not have bar control"))
 
             return bar
@@ -72,19 +76,7 @@ class InventoryMixin:
     # =========================================================================
 
     @property
-    def inventory_size(self) -> uint16:
-        """
-        The number of inventory slots that this Entity has. Equivalent to the
-        ``"inventory_size"`` key in Factorio's ``data.raw``. Returns ``None`` if
-        this entity's name is not recognized by Draftsman. Not exported; read
-        only.
-        """
-        return entities.raw.get(self.name, {}).get("inventory_size", None)
-
-    # =========================================================================
-
-    @property
-    def inventory_bar_enabled(self) -> bool:
+    def inventory_bar_enabled(self) -> Optional[bool]:
         """
         Whether or not this Entity has its inventory limiting bar enabled.
         Equivalent to the ``"enable_inventory_bar"`` key in Factorio's
@@ -97,6 +89,41 @@ class InventoryMixin:
 
     # =========================================================================
 
+    @property
+    def quality_affects_inventory_size(self) -> Optional[bool]:
+        """
+        Whether or not the quality of this entity modifies its inventory size.
+        Not exported; read only.
+        """
+        return entities.raw.get(
+            self.name, {"quality_affects_inventory_size": None}
+        ).get("quality_affects_inventory_size", True)
+
+    # =========================================================================
+
+    @property
+    def inventory_size(self) -> uint16:
+        """
+        The number of inventory slots that this Entity has. Equivalent to the
+        ``"inventory_size"`` key in Factorio's ``data.raw``. Returns ``None`` if
+        this entity's name is not recognized by Draftsman. Not exported; read
+        only.
+        """
+        inventory_size = entities.raw.get(self.name, {}).get("inventory_size", None)
+        if inventory_size is None or not self.quality_affects_inventory_size:
+            return inventory_size
+        else:
+            mutlipliers = {  # TODO: grab this dynamically
+                "normal": 1.0,
+                "uncommon": 1.3,
+                "rare": 1.6,
+                "epic": 1.9,
+                "legendary": 2.5,
+            }
+            return math.floor(inventory_size * mutlipliers[self.quality])
+
+    # =========================================================================
+
     @property
     def inventory_slots_occupied(self) -> int:
         """
@@ -125,8 +152,8 @@ class InventoryMixin:
     @property
     def bar(self) -> uint16:
         """
-        The limiting bar of the inventory. Used to prevent a the final-most
-        slots in the inventory from accepting items.
+        The limiting bar of the inventory. Used to prevent the final-most
+        slots in the inventory from accepting new items.
 
         Raises :py:class:`~draftsman.warning.IndexWarning` if the set value
         exceeds the Entity's ``inventory_size`` attribute.

{factorio_draftsman-2.0.0 → factorio_draftsman-2.0.1}/draftsman/classes/mixins/inventory_filter.py

@@ -9,7 +9,7 @@ from draftsman.error import (
 )
 from draftsman.signatures import (
     DraftsmanBaseModel,
-    FilterEntry,
+    ItemFilter,
     ItemName,
     int64,
     uint16,
@@ -24,7 +24,7 @@ from pydantic import (
     validate_call,
     field_validator,
 )
-from typing import Any, Optional
+from typing import Any, Literal, Optional
 
 from typing import TYPE_CHECKING
 
@@ -39,7 +39,7 @@ class InventoryFilterMixin:
 
     class Format(BaseModel):
         class InventoryFilters(DraftsmanBaseModel):
-            filters: Optional[list[FilterEntry]] = Field(
+            filters: Optional[list[ItemFilter]] = Field(
                 None,
                 description="""
                 Any reserved item filter slots in the container's inventory.
@@ -163,14 +163,14 @@ class InventoryFilterMixin:
     # =========================================================================
 
     @property
-    def filters(self) -> Optional[list[FilterEntry]]:
+    def filters(self) -> Optional[list[ItemFilter]]:
         """
         TODO
         """
         return self.inventory.filters
 
     @filters.setter
-    def filters(self, value: Optional[list[FilterEntry]]):
+    def filters(self, value: Optional[list[ItemFilter]]):
         test_replace_me(
             self,
             type(self).Format.InventoryFilters,
@@ -233,7 +233,15 @@ class InventoryFilterMixin:
 
     # =========================================================================
 
-    def set_inventory_filter(self, index: int64, item: Optional[ItemName]):
+    def set_inventory_filter(
+        self,
+        index: int64,
+        item: Optional[ItemName],
+        quality: Literal[
+            "normal", "uncommon", "rare", "epic", "legendary", "any"
+        ] = "normal",
+        comparator: Literal[">", "<", "=", "==", "≥", ">=", "≤", "<=", "≠", "!="] = "=",
+    ):
         """
         Sets the item filter at a particular index. If ``item`` is set to
         ``None``, the item filter at that location is removed.
@@ -249,7 +257,7 @@ class InventoryFilterMixin:
         """
         if item is not None:
             try:
-                new_entry = FilterEntry(index=index, name=item)
+                new_entry = ItemFilter(index=index, name=item)
                 new_entry.index += 1
             except ValidationError as e:
                 raise DataFormatError(e) from None