nodezator 1.5.2__tar.gz → 1.5.3__tar.gz

{nodezator-1.5.2 → nodezator-1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nodezator
-Version: 1.5.2
+Version: 1.5.3
 Summary: A generalist Python node editor
 Home-page: https://nodezator.com
 Author: Kennedy Richard

nodezator-1.5.3/nodezator/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.3"

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/appinfo.py

@@ -20,7 +20,7 @@ from collections import namedtuple
 
 AppVersion = namedtuple("AppVersion", "major minor micro release_level")
 
-APP_VERSION = AppVersion(1, 5, 2, "release_candidate")
+APP_VERSION = AppVersion(1, 5, 3, "release_candidate")
 
 
 ### titles for the application

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/data/aww/nodezator.pysite/whats-new/v1-5.htsl

@@ -15,6 +15,7 @@
     <li><a href="https://github.com/IndiePython/nodezator/releases/tag/v1.5.0">[v1.5.0] System testing, topological sorting and QOL features</a></li>
     <li><a href="https://github.com/IndiePython/nodezator/releases/tag/v1.5.1">[v1.5.1] Usability improvements and content update</a></li>
     <li><a href="https://github.com/IndiePython/nodezator/releases/tag/v1.5.2">[v1.5.2] Bug fix for nodes with keyword-variable parameters</a></li>
+    <li><a href="https://github.com/IndiePython/nodezator/releases/tag/v1.5.3">[v1.5.3] User manual utility and file manager bug fix</a></li>
 </ul>
 
 <ol>
@@ -33,6 +34,7 @@
     <li><a href="whats-new/v1-5.htsl#fixes-other-back-end-changes">Fixes and other back-end changes</a></li>
     <li><a href="whats-new/v1-5.htsl#usability-improvements-content-update">v1.5.1: Usability improvements and content update</a></li>
     <li><a href="whats-new/v1-5.htsl#bug-fix-keyword-variable">v1.5.2: Bug fix for nodes with keyword-variable parameters</a></li>
+    <li><a href="whats-new/v1-5.htsl#user-manual-utility-file-manager-fix">v1.5.3: User manual utility and file manager bug fix</a></li>
 
 </ol>
 
@@ -283,6 +285,15 @@
 <p>We also updated social media links to include the <a href="https://bsky.app/profile/kennedyrichard.com">developer's (me) Bluesky profile</a> and also point to the developer's <a href="https://kennedyrichard.com/links">links page</a>, where several other useful links/addresses are available, including email.</p>
 
 
+<h2 id="user-manual-utility-file-manager-fix">v1.5.3: User manual utility and file manager bug fix</h2>
+
+<p>Code blocks on the in-app version of the user manual now have a new button that allows users to save that code snippet on disk. This change was made because the button to copy values to the clipboard is not working properly for all users. I still have to investigate the problem to know the cause, but it looks like it is not on Nodezator's source, since it works on some machines and not on others.</p>
+
+<p>To avoid hassle to the users (one of them reported having to type the code manually), this new button now allows them to save the code directly on disk. Of course, alternatively, the users always have the <a href="https://manual.nodezator.com">online version of the manual</a> available as well.</p>
+
+<p>I also fixed a bug on the file manager that sometimes caused paths to still be submitted despite the user having pressed the <b>Cancel</b> button. Naturally, this was a clearly undesired behaviour that could cause all kinds of undesired side-effects as well.</p>
+
+
 </body>
 
 </htsl>

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/fileman/op.py

@@ -117,6 +117,10 @@ class FileManagerOperations(Object2D):
         ### alias self as the loop holder
         loop_holder = self
 
+        ### set an attribute to keep track of when the user cancelled
+        ### selecting paths
+        self.cancelled = False
+
         ### keep looping the execution of methods
         ### "handle_input", "update" and "drawing" of the
         ### loop holder until running is set to False
@@ -156,11 +160,16 @@ class FileManagerOperations(Object2D):
         ### blit smaller semi transparent object
         self.rect_size_semitransp_obj.draw()
 
-        ### if only files are expected to be selected, we must
-        ### update the selection according to the entry, since
-        ### they might be out of sync
+        ### if the user didn't cancel and only files are expected to be
+        ### selected, we must update the selection according to the entry,
+        ### since they might be out of sync
 
-        if self.expecting_files_only:
+        ### XXX review behaviour of this expecting_files_only flag.
+        ### For instance, what if the person selected folders as well?
+        ### When you do that, update docstrings and related comments
+        ### accordingly
+
+        if not self.cancelled and self.expecting_files_only:
             self.update_selection_from_entry()
 
         ### return a copy of the path selection
@@ -482,9 +491,13 @@ class FileManagerOperations(Object2D):
         Works by clearing the path selection, which causes no
         path to be returned.
 
+        The 'cancelled' attribute is also set to True, to indicate the
+        user cancelled providing path(s).
+
         The 'running' attribute is also set to False, which
         triggers the exit of the file manager loop which
         you can find on the select_paths method.
         """
         self.path_selection.clear()
+        self.cancelled = True
         self.running = False

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/htsl/codeblock.py

@@ -27,6 +27,8 @@ from ..classes2d.single import Object2D
 
 from ..surfsman.render import combine_surfaces, render_rect
 
+from ..surfsman.icon import render_layered_icon
+
 from ..surfsman.draw import draw_border
 
 from ..textman.render import render_text, get_text_size
@@ -40,7 +42,9 @@ from ..syntaxman.exception import SyntaxMappingError
 
 from ..syntaxman.utils import get_ready_theme
 
-from ..colorsman.colors import HTSL_GENERAL_TEXT_FG, HTSL_CANVAS_BG
+from ..dialog import create_and_show_dialog
+
+from ..colorsman.colors import BLACK, HTSL_GENERAL_TEXT_FG, HTSL_CANVAS_BG
 
 from .constants import (
     GENERAL_CODE_TEXT_SETTINGS,
@@ -104,6 +108,69 @@ def _get_clipboard_button_surf():
 COPY_TO_CLIPBOARD_SURF =  _get_clipboard_button_surf()
 
 
+def _get_save_button_surf():
+    """Create and return surface representing save button."""
+
+    ## text
+    text_surf = render_text(text='Save on disk', **NORMAL_TEXT_SETTINGS)
+
+    ## icon
+
+
+    _arrow_down_icon = render_layered_icon(
+        chars=[chr(ordinal) for ordinal in (50, 51)],
+        dimension_name="height",
+        dimension_value=12,
+        rotation_degrees=180,
+        colors=[
+            BLACK,
+            (30, 130, 70),
+        ],
+    )
+
+    _ssd_icon = render_layered_icon(
+        chars=[chr(ordinal) for ordinal in range(83, 87)],
+        dimension_name="width",
+        dimension_value=18,
+        colors=[
+            BLACK,
+            (255, 0, 0),
+            (0, 0, 255),
+            (140, 140, 140),
+        ],
+        background_width=20,
+        background_height=24,
+        retrieve_pos_from="midbottom",
+        assign_pos_to="midbottom",
+        offset_pos_by=(0, -2),
+    )
+
+    icon_surf = combine_surfaces(
+        [_ssd_icon, _arrow_down_icon],
+        retrieve_pos_from="midbottom",
+        assign_pos_to="midbottom",
+        offset_pos_by=(0, -10),
+    )
+
+
+    ## final combination
+
+    surf = combine_surfaces(
+        (text_surf, icon_surf),
+        retrieve_pos_from="midright",
+        assign_pos_to="midleft",
+        offset_pos_by=(4, 0),
+        padding=6,
+        background_color=HTSL_CANVAS_BG,
+    )
+
+    draw_border(surf, color=HTSL_GENERAL_TEXT_FG, thickness=2)
+
+    return surf
+
+SAVE_ON_DISK_SURF =  _get_save_button_surf()
+
+
 
 ### TODO ponder: should the code block surfaces be cached
 ### across different .htsl pages? they probably should.
@@ -359,6 +426,54 @@ def get_pre_textblock(pre_element):
 
     return obj
 
+def save_on_disk(text, extension):
+
+    ### TODO the import below is performed inside this function
+    ### temporariy, in order to avoid circular imports;
+    ###
+    ### however, given how often it is used throughout the package,
+    ## it should probably be passed around as a reference rather than
+    ### being imported, similarly to how the node manager, window manager
+    ### and editing assistant are passed around as references;
+
+    ### import select paths
+    from ..fileman.main import select_paths
+
+    ### prompt user to pick filepath from file manager
+
+    paths = (
+        select_paths(
+            caption="Save code snippet on disk",
+            path_name=f'snippet{extension}',
+            expecting_files_only=True,
+        )
+    )
+
+    ### if paths were given, it is a single one, we
+    ### should assign it to 'filepath' variable
+
+    if paths:
+        filepath = paths[0]
+
+    ### if the user didn't provide paths, though,
+    ### return earlier
+
+    else:
+
+        create_and_show_dialog("Cancelled saving snippet on disk.")
+        return
+
+    ###
+
+    try:
+        filepath.write_text(text, encoding='utf-8')
+
+    except Exception as err:
+
+        error_message = "An error occurred while trying to save snippet on disk: "
+        error_message += str(err)[:200]
+        create_and_show_dialog(error_message)
+
 def get_copy_button(text, bottomright):
 
     return Button(
@@ -368,8 +483,23 @@ def get_copy_button(text, bottomright):
 
         ## other arguments
 
-        command = (partial(put_text, text)),
+        command = partial(put_text, text),
+        coordinates_name='bottomright',
+        coordinates_value=bottomright,
+
+    )
+
+def get_save_button(text, extension, bottomright):
+
+    return Button(
+
+        ## surf
+        SAVE_ON_DISK_SURF,
+
+        ## other arguments
+
+        command = partial(save_on_disk, text, extension),
         coordinates_name='bottomright',
-        coordinates_value= bottomright,
+        coordinates_value=bottomright,
 
     )

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/htsl/constants.py

@@ -40,6 +40,8 @@ KNOWN_TAGS = (
     "dl",
 )
 
+PRE_PYTHON_TAGS = {'pre', 'python'}
+
 ### text settings
 
 ## anchor minus fg

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/htsl/main.py

@@ -454,8 +454,8 @@ class HTSLBrowser(
                             break
 
                 ### otherwise check whether the object has an on_mouse_release,
-                ### executing it and breaking out of the for-loop if it is the
-                ### case
+                ### executing it, redrawing the elements and breaking out of
+                ### the for-loop if it is the case
 
                 try:
                     method = obj.on_mouse_release
@@ -464,7 +464,9 @@ class HTSLBrowser(
                     pass
 
                 else:
+
                     method(event)
+                    self.draw_once()
                     break
 
                 ### regardless of what happened or not, break out of the

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator/htsl/prep.py

@@ -22,7 +22,12 @@ from ..classes2d.collections import List2D
 
 from ..surfdef import surfdef_obj_from_element
 
-from .constants import BROWSER_TITLE, KNOWN_TAGS, HEADING_TAGS
+from .constants import (
+    BROWSER_TITLE,
+    KNOWN_TAGS,
+    HEADING_TAGS,
+    PRE_PYTHON_TAGS,
+)
 
 from .creation import (
     TextBlock,
@@ -41,12 +46,15 @@ from .codeblock import (
     get_python_codeblock,
     get_pre_textblock,
     get_copy_button,
+    get_save_button,
 )
 
 from ..colorsman.colors import HTSL_CANVAS_BG
 
 
+
 class Preparation:
+
     def __init__(self):
         self.cache = {}
 
@@ -179,30 +187,66 @@ class Preparation:
             retrieve_pos_from="bottom", assign_pos_to="top", offset_pos_by=(0, 14)
         )
 
-        ### if clipboard functionality is available and there are pre/python
-        ### tags in the page, add "copy to clipboard" button to each pre/python
-        ### tag
+        ### if there are pre/python tags in the page...
 
-        if PUT_TEXT_AVAILABLE and pre_or_python_tags:
 
-            ##
+        if pre_or_python_tags:
+
+            ### request buttons to be added to each pre/python tag
+
+            buttons_to_add = ['save_on_disk']
+
+            ### if clipboard functionality is available, request
+            ### "copy to clipboard" buttons to be added as well
+
+            if PUT_TEXT_AVAILABLE:
+                buttons_to_add.append('copy_to_clipboard')
+
+            ### add button/buttons
 
             index_button_pairs = []
 
             y_offset = 0
             offset_increment = COPY_TO_CLIPBOARD_SURF.get_height()
 
+            buttons = []
+
             for index, obj in enumerate(self.objs):
 
-                if getattr(obj, 'tag_name', '') in {'pre', 'python'}:
+                tag_name = getattr(obj, 'tag_name', '').lower()
+
+                if tag_name in PRE_PYTHON_TAGS:
 
                     y_offset += offset_increment
 
                     obj.rect.y += y_offset
 
-                    button = get_copy_button(obj.text, bottomright=obj.rect.topright)
+                    bottomright = obj.rect.topright
+
+                    for button_name in buttons_to_add:
+
+                        if button_name == 'save_on_disk':
+
+                            extension = '.py' if tag_name == 'python' else '.txt'
+                            button = get_save_button(obj.text, extension, bottomright)
+
+                        elif button_name == 'copy_to_clipboard':
+                            button = get_copy_button(obj.text, bottomright)
+
+                        buttons.append(button)
+
+                        bottomright = button.rect.bottomleft
+
+                        index_button_pairs.append((index, button))
+
+                    left_diff =  obj.rect.left - buttons[-1].rect.left
+
+                    if left_diff > 0:
+
+                        for button in buttons:
+                            button.rect.x += left_diff
 
-                    index_button_pairs.append((index, button))
+                    buttons.clear()
 
                 else:
                     obj.rect.y += y_offset

{nodezator-1.5.2 → nodezator-1.5.3}/nodezator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nodezator
-Version: 1.5.2
+Version: 1.5.3
 Summary: A generalist Python node editor
 Home-page: https://nodezator.com
 Author: Kennedy Richard

{nodezator-1.5.2 → nodezator-1.5.3}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = nodezator
-version = 1.5.2
+version = 1.5.3
 author = Kennedy Richard
 author_email = kennedy@kennedyrichard.com
 description = A generalist Python node editor

nodezator-1.5.2/nodezator/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.5.2"