mcdex 0.1.0.dev0__py3-none-any.whl

mcdex/pig_sound_variants/__init__.py

@@ -0,0 +1,16 @@
+"""
+The 'mcdex.pig_sound_variants' package provides the pig sound variants of the
+game: the 'MCPigSoundVariants' catalogue, an enumeration of every pig sound
+variant of the data file 'pig_sound_variants.json' that ships with the package.
+
+- MCPigSoundVariants
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from ._mc_pig_sound_variants import MCPigSoundVariants
+
+__all__ = (
+  'MCPigSoundVariants',
+)

mcdex/pig_sound_variants/_mc_pig_sound_variants.py

@@ -0,0 +1,48 @@
+"""
+MCPigSoundVariants is the catalogue of the game's pig sound variants: an
+enumeration with one member for every pig sound variant of the data file that
+ships with mcdex, each the same pig sound variant in every version, with the id
+each version knows it by: what /summon takes for a pig of that sound variant.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from worktoy.keenum import Kee
+
+from ..base import MCThing, PigSoundVariantId
+
+
+class MCPigSoundVariants(MCThing):
+  """
+  The catalogue of the game's pig sound variants, each a member, found by its
+  name in capitals, in any case, or by its unique name:
+
+    mini = MCPigSoundVariants.MINI
+    mini is MCPigSoundVariants['mini']  # True
+    mini['26.1']
+    # PigSoundVariantId('mini',
+    #   'minecraft:pig{sound_variant:"minecraft:mini"}')
+    len(MCPigSoundVariants)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'pig_sound_variants.json' beside this
+  module. mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'pig_sound_variants.json'
+  __data_key__ = 'pig_sound_variants'
+  __id_class__ = PigSoundVariantId
+  __kind__ = 'pig sound variant'
+
+  #  Members, one for every name of 'pig_sound_variants.json'
+  BIG = Kee[str]('big')
+  CLASSIC = Kee[str]('classic')
+  MINI = Kee[str]('mini')

mcdex/pig_sound_variants/pig_sound_variants.json

@@ -0,0 +1,30 @@
+{
+ "covers": [
+  "1.7.2",
+  "26.3"
+ ],
+ "legend": {
+  "": "vanilla has no such pig sound variant in this version"
+ },
+ "pig_sound_variants": {
+  "big": {
+   "ids": {
+    "1.7.2": "",
+    "26.1": "minecraft:pig{sound_variant:\"minecraft:big\"}"
+   }
+  },
+  "classic": {
+   "ids": {
+    "1.7.2": "Pig",
+    "1.11": "minecraft:pig",
+    "26.1": "minecraft:pig{sound_variant:\"minecraft:classic\"}"
+   }
+  },
+  "mini": {
+   "ids": {
+    "1.7.2": "",
+    "26.1": "minecraft:pig{sound_variant:\"minecraft:mini\"}"
+   }
+  }
+ }
+}

mcdex/pig_variants/__init__.py

@@ -0,0 +1,16 @@
+"""
+The 'mcdex.pig_variants' package provides the pig variants of the game: the
+'MCPigVariants' catalogue, an enumeration of every pig variant of the data file
+'pig_variants.json' that ships with the package.
+
+- MCPigVariants
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from ._mc_pig_variants import MCPigVariants
+
+__all__ = (
+  'MCPigVariants',
+)

mcdex/pig_variants/_mc_pig_variants.py

@@ -0,0 +1,46 @@
+"""
+MCPigVariants is the catalogue of the game's pig variants: an enumeration with
+one member for every pig variant of the data file that ships with mcdex, each
+the same pig variant in every version, with the id each version knows it by:
+what /summon takes for a pig of that variant.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from worktoy.keenum import Kee
+
+from ..base import MCThing, PigVariantId
+
+
+class MCPigVariants(MCThing):
+  """
+  The catalogue of the game's pig variants, each a member, found by its name in
+  capitals, in any case, or by its unique name:
+
+    temperate = MCPigVariants.TEMPERATE
+    temperate is MCPigVariants['temperate']  # True
+    temperate['1.12.2']  # PigVariantId('temperate', 'minecraft:pig')
+    len(MCPigVariants)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'pig_variants.json' beside this module.
+  mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'pig_variants.json'
+  __data_key__ = 'pig_variants'
+  __id_class__ = PigVariantId
+  __kind__ = 'pig variant'
+
+  #  Members, one for every name of 'pig_variants.json'
+  COLD = Kee[str]('cold')
+  TEMPERATE = Kee[str]('temperate')
+  WARM = Kee[str]('warm')

mcdex/pig_variants/pig_variants.json

@@ -0,0 +1,30 @@
+{
+ "covers": [
+  "1.7.2",
+  "26.3"
+ ],
+ "legend": {
+  "": "vanilla has no such pig variant in this version"
+ },
+ "pig_variants": {
+  "cold": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.5": "minecraft:pig{variant:\"minecraft:cold\"}"
+   }
+  },
+  "temperate": {
+   "ids": {
+    "1.7.2": "Pig",
+    "1.11": "minecraft:pig",
+    "1.21.5": "minecraft:pig{variant:\"minecraft:temperate\"}"
+   }
+  },
+  "warm": {
+   "ids": {
+    "1.7.2": "",
+    "1.21.5": "minecraft:pig{variant:\"minecraft:warm\"}"
+   }
+  }
+ }
+}

mcdex/potions/__init__.py

@@ -0,0 +1,20 @@
+"""
+The 'mcdex.potions' package provides the potions of the game: the 'MCPotions'
+catalogue, an enumeration of every potion of the data file 'potions.json' that
+ships with the package; and the 'ModifiedPotion', a long or a strong potion,
+which the catalogue gives for a base potion with a modifier.
+
+- MCPotions
+- ModifiedPotion
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from ._modified_potion import ModifiedPotion
+from ._mc_potions import MCPotions
+
+__all__ = (
+  'MCPotions',
+  'ModifiedPotion',
+)

mcdex/potions/_mc_potions.py

@@ -0,0 +1,101 @@
+"""
+MCPotions is the catalogue of the game's potions: an enumeration with one
+member for every potion of the data file that ships with mcdex, each the same
+potion in every version, with the id each version knows it by: the potion an
+item is made with: from 1.9 its name, before it the potion item's damage value.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from worktoy.keenum import Kee
+
+from ..base import MCThing, PotionId, PotionModifier
+from ._modified_potion import ModifiedPotion
+
+if TYPE_CHECKING:  # pragma: no cover, no mutate
+  from typing import Any
+
+
+class MCPotions(MCThing):
+  """
+  The catalogue of the game's potions, each a member, found by its name in
+  capitals, in any case, or by its unique name:
+
+    swiftness = MCPotions.SWIFTNESS
+    swiftness is MCPotions['swiftness']  # True
+    swiftness['1.8.9']  # PotionId('swiftness', '2')
+    len(MCPotions)
+
+  Implementation
+  --------------
+
+  All of it is 'MCThing's, reading 'potions.json' beside this module.
+  mcdex's tools write the members, one for every name of that file.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Class Variables
+  __data_file__ = 'potions.json'
+  __data_key__ = 'potions'
+  __id_class__ = PotionId
+  __kind__ = 'potion'
+
+  #  Private Variables
+  __modified_potions__: dict = {}
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  Python API   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  @classmethod
+  def __class_resolve__(cls, identifier: Any) -> Any:
+    """
+    A potion by its unique name, as in any catalogue; or a base potion
+    with a modifier, 'MCPotions[MCPotions.NIGHT_VISION,
+    PotionModifier.LONG]' or 'MCPotions["night_vision", "long"]': the
+    long or strong potion, a 'ModifiedPotion', the same object every
+    time. A base potion the game has no such potion of raises 'KeyError'.
+    """
+    if not isinstance(identifier, tuple) or len(identifier) != 2:
+      return super().__class_resolve__(identifier)
+    base, modifier = cls(identifier[0]), PotionModifier(identifier[1])
+    key = (base.name, modifier.name)
+    if key not in cls.__modified_potions__:
+      if modifier.value not in base._record():
+        infoSpec = """mcdex has no %s %s potion"""
+        raise KeyError(infoSpec % (modifier.value, base.uniqueName))
+      cls.__modified_potions__[key] = ModifiedPotion(base, modifier)
+    return cls.__modified_potions__[key]
+
+  #  Members, one for every name of 'potions.json'
+  AWKWARD = Kee[str]('awkward')
+  EMPTY = Kee[str]('empty')
+  FIRE_RESISTANCE = Kee[str]('fire_resistance')
+  HARMING = Kee[str]('harming')
+  HEALING = Kee[str]('healing')
+  INFESTED = Kee[str]('infested')
+  INVISIBILITY = Kee[str]('invisibility')
+  LEAPING = Kee[str]('leaping')
+  LUCK = Kee[str]('luck')
+  MUNDANE = Kee[str]('mundane')
+  NIGHT_VISION = Kee[str]('night_vision')
+  OOZING = Kee[str]('oozing')
+  POISON = Kee[str]('poison')
+  REGENERATION = Kee[str]('regeneration')
+  SLOW_FALLING = Kee[str]('slow_falling')
+  SLOWNESS = Kee[str]('slowness')
+  STRENGTH = Kee[str]('strength')
+  SWIFTNESS = Kee[str]('swiftness')
+  THICK = Kee[str]('thick')
+  TURTLE_MASTER = Kee[str]('turtle_master')
+  WATER = Kee[str]('water')
+  WATER_BREATHING = Kee[str]('water_breathing')
+  WEAKNESS = Kee[str]('weakness')
+  WEAVING = Kee[str]('weaving')
+  WIND_CHARGED = Kee[str]('wind_charged')

mcdex/potions/_modified_potion.py

@@ -0,0 +1,129 @@
+"""
+ModifiedPotion is a long or a strong potion: a base potion of
+'MCPotions' with a 'PotionModifier', and the id each version knows it by.
+"""
+#  Apache-2.0 license
+#  Copyright (c) 2026 Asger Jon Vistisen
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from worktoy.desc import Field, FixBox
+from worktoy.mcls import BaseObject
+
+from ..base import MCThing, NotInVersion, PotionId, PotionModifier, Version
+
+if TYPE_CHECKING:  # pragma: no cover, no mutate
+  from typing import Any, TypeAlias
+
+  VersionIds: TypeAlias = dict[Version, str]
+  Changes: TypeAlias = tuple[tuple[int, str], ...]
+
+
+class ModifiedPotion(BaseObject):
+  """
+  A long or a strong potion is its base potion with a modifier, as the
+  game makes it, and has an id of its own in each version: the long
+  night vision is 'minecraft:long_night_vision' in 1.12.2 and '70' in
+  1.8.9, the night vision's 6 with the bit for long. 'MCPotions' gives
+  it, the same object every time:
+
+    longNightVision = MCPotions[MCPotions.NIGHT_VISION, PotionModifier.LONG]
+    longNightVision['1.12.2']
+    # PotionId('night_vision', 'minecraft:long_night_vision')
+    longNightVision.base        # <MCPotions>.NIGHT_VISION
+    longNightVision.modifier    # <PotionModifier>.LONG
+
+  Implementation
+  --------------
+
+  Its 'uniqueName' is its base potion's, and its ids are the table the
+  data file keeps under the modifier in the base potion's record, read
+  at the first use and checked as any thing's ids. Indexing it by a
+  version, and 'versionIds', are as for a member of a catalogue.
+  """
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  NAMESPACE  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  #  Private Variables
+  __potion_changes__: Changes = ()
+
+  #  Public Variables
+  base = FixBox[MCThing]()
+  modifier = FixBox[PotionModifier]()
+  uniqueName: Field[str] = Field()
+  versionIds: Field[VersionIds] = Field()
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  GETTERS  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  @uniqueName.GET
+  def _getUniqueName(self, ) -> str:
+    """The base potion's unique name, as 'night_vision'."""
+    return self.base.uniqueName
+
+  @versionIds.GET
+  def _getVersionIds(self, ) -> VersionIds:
+    """
+    The id of the potion in every version from the first version of the
+    data, as a new dict, '' where vanilla has no such potion.
+    """
+    return self.base._tableOf(self._changes())
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  Python API   # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  def __str__(self, ) -> str:
+    """"MCPotions[<MCPotions>.NIGHT_VISION, <PotionModifier>.LONG]"."""
+    clsName = type(self.base).__name__
+    return '%s[%s, %s]' % (clsName, self.base, self.modifier)
+
+  __repr__ = __str__
+
+  def __getitem__(self, version: Any) -> PotionId:
+    """
+    The 'PotionId' of the potion in the given version.
+
+    Raises
+    ------
+    NotInVersion
+      Vanilla has no such potion in that version.
+    ValueError
+      The version is earlier than the data.
+    """
+    version_ = Version(version)
+    position = self.base._position(version_)
+    changes = self._changes()
+    first, _ = changes[0]
+    if position < first:
+      infoSpec = """mcdex has no data on %s before %s"""
+      info = infoSpec % (self, self.base._versions()[first].value)
+      raise ValueError(info)
+    id_ = self.base._valueIn(changes, position)
+    if not id_:
+      raise NotInVersion(self, version_)
+    return PotionId(self.uniqueName, id_)
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  CONSTRUCTORS   # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  def __init__(self, base: MCThing, modifier: PotionModifier) -> None:
+    self.base = base
+    self.modifier = modifier
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  #  DOMAIN SPECIFIC  # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  def _changes(self, ) -> Changes:
+    """The changes of the potion's ids, read and checked at the first call."""
+    if not self.__potion_changes__:
+      record = self.base._record()[self.modifier.value]
+      self.__potion_changes__ = self.base._readIds(
+        str(self), self.uniqueName, record.get('ids', {}))
+    return self.__potion_changes__