dfpyre 0.7.11__py3-none-any.whl → 0.8.0__py3-none-any.whl

dfpyre/items.py

@@ -1,5 +1,5 @@
 """
-Contains class definitions for code items.
+Class definitions for code items.
 """
 
 from enum import Enum
@@ -10,18 +10,20 @@ from dfpyre.util import PyreException, warn
 from mcitemlib.itemlib import Item as NbtItem
 
 
-NUMBER_REGEX = r'-?\d*\.?\d+'
-VAR_SHORTHAND_CHAR = '$'
+NUMBER_REGEX = r'^-?\d*\.?\d+$'
+VAR_SHORTHAND_REGEX = r'^\$([gsli]) (.+)$'
 VAR_SCOPES = {'g': 'unsaved', 's': 'saved', 'l': 'local', 'i': 'line'}
 
 
 def convert_argument(arg: Any):
     if type(arg) in {int, float}:
-        return num(arg)
+        return Number(arg)
     elif isinstance(arg, str):
-        if len(arg) > 2 and arg[0] == VAR_SHORTHAND_CHAR and arg[1] in VAR_SCOPES:
-            return var(arg[2:], VAR_SCOPES[arg[1]])
-        return text(arg)
+        shorthand_match: re.Match = re.match(VAR_SHORTHAND_REGEX, arg)
+        if shorthand_match:
+            scope = VAR_SCOPES[shorthand_match.group(1)]
+            return Variable(shorthand_match.group(2), scope)
+        return Text(arg)
     return arg
 
 
@@ -30,7 +32,7 @@ def _add_slot(d: dict, slot: int|None):
         d['slot'] = slot
 
 
-class item(NbtItem):
+class Item(NbtItem):
     """
     Represents a Minecraft item.
     """
@@ -45,7 +47,7 @@ class item(NbtItem):
         return f'{self.__class__.__name__}({self.get_id()}, {self.get_count()})'
 
 
-class string:
+class String:
     """
     Represents a DiamondFire string object. (`txt`)
     """
@@ -61,9 +63,11 @@ class string:
     
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}("{self.value}")'
+    
+Str = String  # String alias
 
 
-class text:
+class Text:
     """
     Represents a DiamondFire styled text object (`comp`)
     """
@@ -83,7 +87,7 @@ class text:
         return f'{self.__class__.__name__}("{self.value}")'
 
 
-class num:
+class Number:
     """
     Represents a DiamondFire number object.
     """
@@ -100,8 +104,10 @@ class num:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}({self.value})'
 
+Num = Number  # Number alias
+
 
-class loc:
+class Location:
     """
     Represents a DiamondFire location object.
     """
@@ -134,15 +140,20 @@ class loc:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}({self.x}, {self.y}, {self.z}, {self.pitch}, {self.yaw})'
 
+Loc = Location  # Location alias
 
-class var:
+
+class Variable:
     """
     Represents a DiamondFire variable object.
     """
     type = 'var'
 
-    def __init__(self, name: str, scope: Literal['unsaved', 'saved', 'local', 'line']='unsaved'):
+    def __init__(self, name: str, scope: Literal['unsaved', 'game', 'saved', 'local', 'line']='unsaved'):
         self.name = name
+
+        if scope == 'game':
+            scope = 'unsaved'
         self.scope = scope
 
     def format(self, slot: int|None):
@@ -153,8 +164,10 @@ class var:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}({self.scope}, "{self.name}")'
 
+Var = Variable  # Variable alias
 
-class sound:
+
+class Sound:
     """
     Represents a DiamondFire sound object.
     """
@@ -173,8 +186,10 @@ class sound:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}(pitch: {self.pitch}, volume: {self.vol})'
 
+Snd = Sound  # Sound alias
+
 
-class particle:
+class Particle:
     """
     Represents a DiamondFire particle object.
     """
@@ -191,7 +206,7 @@ class particle:
         return f'{self.__class__.__name__}({self.particle_data})'
 
 
-class potion:
+class Potion:
     """
     Represents a DiamondFire potion object.
     """
@@ -210,8 +225,10 @@ class potion:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}(effect: {self.name}, duration: {self.dur}, amplifier: {self.amp})'
 
+Pot = Potion  # Potion alias
+
 
-class gamevalue:
+class GameValue:
     """
     Represents a DiamondFire game value object.
     """
@@ -230,7 +247,7 @@ class gamevalue:
         return f'{self.__class__.__name__}({self.name}, target: {self.target})'
 
 
-class vector:
+class Vector:
     """
     Represents a DiamondFire vector object.
     """
@@ -249,6 +266,8 @@ class vector:
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}({self.x}, {self.y}, {self.z})'
 
+Vec = Vector  # Vector alias
+
 
 PARAMETER_TYPE_LOOKUP = ['txt', 'comp', 'num', 'loc', 'vec', 'snd', 'part', 'pot', 'item', 'any', 'var', 'list', 'dict']
 
@@ -270,7 +289,7 @@ class ParameterType(Enum):
     def get_string_value(self) -> str:
         return PARAMETER_TYPE_LOOKUP[self.value]
 
-class parameter:
+class Parameter:
     """
     Represents a DiamondFire parameter object.
     """
@@ -316,58 +335,62 @@ class parameter:
         return f'{self.__class__.__name__}({self.name}, type: {raw_type})'
 
 
-def _some_or(value: Any, none_value: Any):
-    """
-    Returns `none_value` if `value` is None, otherwise returns `value`.
-    """
-    if value is None:
-        return none_value
-    return value
-
-
 def item_from_dict(item_dict: dict) -> object:
     item_id = item_dict['id']
     item_data = item_dict['data']
 
     if item_id == 'item':
-        return item.from_nbt(item_data['item'])
+        return Item.from_nbt(item_data['item'])
+    
     elif item_id == 'txt':
-        return string(item_data['name'])
+        return String(item_data['name'])
+    
     elif item_id == 'comp':
-        return text(item_data['name'])
+        return Text(item_data['name'])
+    
     elif item_id == 'num':
         num_value = item_data['name']
         if re.match(NUMBER_REGEX, num_value):
             num_value = float(item_data['name'])
             if num_value % 1 == 0:
                 num_value = int(num_value)
-            return num(num_value)
-        return num(num_value)
+            return Number(num_value)
+        return Number(num_value)
+    
     elif item_id == 'loc':
         item_loc = item_data['loc']
-        return loc(item_loc['x'], item_loc['y'], item_loc['z'], item_loc['pitch'], item_loc['yaw'])
+        return Location(item_loc['x'], item_loc['y'], item_loc['z'], item_loc['pitch'], item_loc['yaw'])
+    
     elif item_id == 'var':
-        return var(item_data['name'], item_data['scope'])
+        return Variable(item_data['name'], item_data['scope'])
+    
     elif item_id == 'snd':
-        return sound(item_data['sound'], item_data['pitch'], item_data['vol'])
+        return Sound(item_data['sound'], item_data['pitch'], item_data['vol'])
+    
     elif item_id == 'part':
-        return particle(item_data)
+        return Particle(item_data)
+    
     elif item_id == 'pot':
-        return potion(item_data['pot'], item_data['dur'], item_data['amp'])
+        return Potion(item_data['pot'], item_data['dur'], item_data['amp'])
+    
     elif item_id == 'g_val':
-        return gamevalue(item_data['type'], item_data['target'])
+        return GameValue(item_data['type'], item_data['target'])
+    
     elif item_id == 'vec':
-        return vector(item_data['x'], item_data['y'], item_data['z'])
+        return Vector(item_data['x'], item_data['y'], item_data['z'])
+    
     elif item_id == 'pn_el':
-        description = _some_or(item_data.get('description'), '')
-        note = _some_or(item_data.get('note'), '')
+        description = item_data.get('description') or ''
+        note = item_data.get('note') or ''
         param_type = ParameterType(PARAMETER_TYPE_LOOKUP.index(item_data['type']))
         if item_data['optional']:
             if 'default_value' in item_data:
-                return parameter(item_data['name'], param_type, item_data['plural'], True, description, note, item_from_dict(item_data['default_value']))
-            return parameter(item_data['name'], param_type, item_data['plural'], True, description, note)
-        return parameter(item_data['name'], param_type, item_data['plural'], False, description, note)
-    elif item_id in {'bl_tag', 'hint'}:
+                return Parameter(item_data['name'], param_type, item_data['plural'], True, description, note, item_from_dict(item_data['default_value']))
+            return Parameter(item_data['name'], param_type, item_data['plural'], True, description, note)
+        return Parameter(item_data['name'], param_type, item_data['plural'], False, description, note)
+    
+    elif item_id in {'bl_tag', 'hint'}:  # Ignore tags and hints
         return
+    
     else:
         raise PyreException(f'Unrecognized item id `{item_id}`')