dfpyre 0.8.13__tar.gz → 0.8.15__tar.gz

{dfpyre-0.8.13 → dfpyre-0.8.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dfpyre
-Version: 0.8.13
+Version: 0.8.15
 Summary: A package for creating and modifying code templates for the DiamondFire Minecraft server.
 Home-page: https://github.com/Amp63/pyre
 License: MIT

{dfpyre-0.8.13 → dfpyre-0.8.15}/dfpyre/actiondump.py

@@ -52,20 +52,22 @@ def parse_actiondump() -> ActiondumpResult:
     codeblock_data = {n: {} for n in CODEBLOCK_NAME_LOOKUP.values()}
     codeblock_data['else'] = {'tags': []}
 
-
     if not os.path.exists(ACTIONDUMP_PATH):
         warn('data.json not found -- Item tags and error checking will not work.')
         return {}, set()
     
     with open(ACTIONDUMP_PATH, 'r', encoding='utf-8') as f:
         actiondump = json.loads(f.read())
-    
     for action_data in actiondump['actions']:
         action_tags = get_action_tags(action_data)
-        parsed_action_data = {'tags': action_tags}
+        parsed_action_data = {'tags': action_tags, 'required_rank': 'None'}
         if dep_note := action_data['icon']['deprecatedNote']:
             parsed_action_data['deprecatedNote'] = ' '.join(dep_note)
         
+        required_rank = action_data['icon']['requiredRank']
+        if required_rank:
+            parsed_action_data['required_rank'] = required_rank
+        
         codeblock_name = CODEBLOCK_NAME_LOOKUP[action_data['codeblockName']]
         codeblock_data[codeblock_name][action_data['name']] = parsed_action_data
         if aliases := action_data['aliases']:

{dfpyre-0.8.13 → dfpyre-0.8.15}/dfpyre/pyre.py

@@ -339,19 +339,22 @@ class DFTemplate:
         return template_item.send_to_minecraft()
     
     
-    def generate_script(self, output_path: str, indent_size: int=4, literal_shorthand: bool=True, var_shorthand: bool=False, preserve_slots: bool=False):
+    def generate_script(self, indent_size: int=4, literal_shorthand: bool=True, var_shorthand: bool=False, 
+                        preserve_slots: bool=False, assign_variable: bool=False, include_import: bool=True, 
+                        build_and_send: bool=False) -> str:
         """
         Generate an equivalent python script for this template.
-
-        :param str output_path: The file path to write the script to.
+        
         :param int indent_size: The multiple of spaces to add when indenting lines.
-        :param bool literal_shorthand: If True, `text` and `num` items will be written as strings and ints respectively.
+        :param bool literal_shorthand: If True, `Text` and `Number` items will be written as strings and ints respectively.
         :param bool var_shorthand: If True, all variables will be written using variable shorthand.
         :param bool preserve_slots: If True, the positions of items within chests will be saved.
+        :param bool assign_variable: If True, the generated template will be assigned to a variable.
+        :param bool include_import: If True, the `dfpyre` import statement will be added.
+        :param bool build_and_send: If True, `.build_and_send()` will be added to the end of the generated template.
         """
-        flags = GeneratorFlags(indent_size, literal_shorthand, var_shorthand, preserve_slots)
-        with open(output_path, 'w', encoding='utf-8') as f:
-            f.write(generate_script(self, flags))
+        flags = GeneratorFlags(indent_size, literal_shorthand, var_shorthand, preserve_slots, assign_variable, include_import, build_and_send)
+        return generate_script(self, flags)
 
 
 def _assemble_template(starting_block: CodeBlock, codeblocks: list[CodeBlock], author: str|None) -> DFTemplate:

{dfpyre-0.8.13 → dfpyre-0.8.15}/dfpyre/scriptgen.py

@@ -4,7 +4,7 @@ from dfpyre.items import *
 from dfpyre.actiondump import get_default_tags
 
 
-SCRIPT_START = '''from dfpyre import *\n\n'''
+IMPORT_STATEMENT = 'from dfpyre import *'
 
 TEMPLATE_FUNCTION_LOOKUP = {
     'event': 'player_event',
@@ -38,6 +38,9 @@ class GeneratorFlags:
     literal_shorthand: bool
     var_shorthand: bool
     preserve_slots: bool
+    assign_variable: bool
+    include_import: bool
+    build_and_send: bool
 
 
 def item_to_string(class_name: str, i: Item, slot_argument: str):
@@ -123,6 +126,14 @@ def argument_item_to_string(flags: GeneratorFlags, arg_item: object) -> str:
         return f'{class_name}({arg_item.x}, {arg_item.y}, {arg_item.z}{slot_argument})'
 
 
+def string_to_python_name(string: str) -> str:
+    """Converts `string` into a valid python identifier."""
+    string = string.strip()
+    if string[0].isnumeric():
+        string = '_' + string
+    return ''.join(c if c.isalnum() else '_' for c in string)
+
+
 def add_script_line(flags: GeneratorFlags, script_lines: list[str], indent_level: int, line: str, add_comma: bool=True):
     added_line = ' '*flags.indent_size*indent_level + line
     if add_comma and indent_level > 0:
@@ -133,9 +144,23 @@ def add_script_line(flags: GeneratorFlags, script_lines: list[str], indent_level
 def generate_script(template, flags: GeneratorFlags) -> str:
     indent_level = 0
     script_lines = []
+    variable_assigned = False
 
+    if flags.include_import:
+        script_lines.append(IMPORT_STATEMENT + '\n')
+        
     def remove_comma_from_last_line():
         script_lines[-1] = script_lines[-1][:-1]
+    
+    def get_var_assignment_snippet() -> str:
+        first_block_data = template.codeblocks[0].data
+        if 'data' in first_block_data:
+            name = first_block_data['data']
+            var_name = name if name else 'unnamed_template'
+        else:
+            var_name = first_block_data['block'] + '_' + first_block_data['action']
+        return f'{string_to_python_name(var_name)} = '
+
 
     for codeblock in template.codeblocks:
         # Handle closing brackets
@@ -150,6 +175,12 @@ def generate_script(template, flags: GeneratorFlags) -> str:
         function_name = TEMPLATE_FUNCTION_LOOKUP[codeblock.type]
         function_args = [f'"{codeblock.action_name}"']
 
+        # Add variable assignment if necessary
+        var_assignment_snippet = ''
+        if flags.assign_variable and not variable_assigned:
+            var_assignment_snippet = get_var_assignment_snippet()
+            variable_assigned = True
+
         # Set function or process name if necessary
         if codeblock.action_name == 'dynamic':
             function_args[0] = f'"{codeblock.data["data"]}"'
@@ -178,13 +209,14 @@ def generate_script(template, flags: GeneratorFlags) -> str:
         if codeblock.data.get('attribute') == 'NOT':
             function_args.append('inverted=True')
 
+        # Create and add the final line
         if codeblock.type in CONTAINER_CODEBLOCKS:
             if codeblock.type == 'else':
                 line = f'{function_name}(['
             elif codeblock.type in {'event', 'entity_event'}:
                 line = f'{function_name}({", ".join(function_args)}, ['  # omit `codeblocks=` when we don't need it
             else:
-                line = f'{function_name}({", ".join(function_args)}, codeblocks=['
+                line = f'{var_assignment_snippet}{function_name}({", ".join(function_args)}, codeblocks=['
             add_script_line(flags, script_lines, indent_level, line, False)
             indent_level += 1
         else:
@@ -194,4 +226,9 @@ def generate_script(template, flags: GeneratorFlags) -> str:
     remove_comma_from_last_line()
     indent_level -= 1
     add_script_line(flags, script_lines, indent_level, '])')  # add final closing brackets
-    return SCRIPT_START + '\n'.join(script_lines)
+
+    # Add `.build_and_send()` if necessary
+    if flags.build_and_send:
+        script_lines[-1] += '.build_and_send()'
+    
+    return '\n'.join(script_lines)

{dfpyre-0.8.13 → dfpyre-0.8.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dfpyre"
-version = "0.8.13"
+version = "0.8.15"
 description = "A package for creating and modifying code templates for the DiamondFire Minecraft server."
 authors = ["Amp"]
 readme = "README.md"