nodezator 1.5.4__tar.gz → 1.5.5__tar.gz

{nodezator-1.5.4 → nodezator-1.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: nodezator
-Version: 1.5.4
+Version: 1.5.5
 Summary: A generalist Python node editor
 Author-email: Kennedy Richard <kennedy@kennedyrichard.com>
 License: Unlicense
@@ -64,7 +64,9 @@ main_callable = get_circle_area
 
 ![node image](https://nodezator.com/images/get_circle_area_node.png)
 
-You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder (more about that further ahead in another section).
+You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder. This small video (~2min) actually shows you how to define and load a node in **less than 60 seconds**:
+
+[![video: Defining and loading a node in less than 60 seconds](https://img.youtube.com/vi/cMfoaEs0fGY/hqdefault.jpg)](https://www.youtube.com/watch?v=cMfoaEs0fGY)
 
 You can actually turn **any** callable into a node very easily: classes, methods, etc. All callables available in the Python ecosystem can be turned into a node (even the ones defined in C, for instance).
 
@@ -108,7 +110,7 @@ On top of making it very easy to define nodes, Nodezator comes packed full of us
 
 As we said before, Nodezator allows you to convert callables from third-party libraries with minimal effort. Here are just a few screenshots showing the usage of Nodezator with different libraries.
 
-Here's is a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
+Here's a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
 
 ![Pillow demonstration](https://nodezator.com/images/nodezator_pillow_demo.png)
 
@@ -246,6 +248,8 @@ However, users are encouraged to define their own nodes for their specific purpo
 
 ![A user-defined node](https://nodezator.com/images/node.png)
 
+In case you missed it at the beginning of this README, here's the link to a small video demonstrating how to define and load a node in less than 60 seconds: https://www.youtube.com/watch?v=cMfoaEs0fGY
+
 Nodes are created from Python scripts organized within folders that we call **node packs**. You can create a node pack folder **anywhere you want in your disk**. Under the hood, Nodezator treats it as a package in some contexts, so you can name that folder whatever you like, as long as it is a Python identifier. That is, it must start with a letter or underscore and contain only letters, digits and underscores.
 
 In other words, you **create nodes by writing Python functions/callables using your preferred text editor or IDE** and only then you **launch Nodezator in order to load them as nodes**, so you can create, edit and execute graphs.

{nodezator-1.5.4 → nodezator-1.5.5}/README.md

@@ -32,7 +32,9 @@ main_callable = get_circle_area
 
 ![node image](https://nodezator.com/images/get_circle_area_node.png)
 
-You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder (more about that further ahead in another section).
+You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder. This small video (~2min) actually shows you how to define and load a node in **less than 60 seconds**:
+
+[![video: Defining and loading a node in less than 60 seconds](https://img.youtube.com/vi/cMfoaEs0fGY/hqdefault.jpg)](https://www.youtube.com/watch?v=cMfoaEs0fGY)
 
 You can actually turn **any** callable into a node very easily: classes, methods, etc. All callables available in the Python ecosystem can be turned into a node (even the ones defined in C, for instance).
 
@@ -76,7 +78,7 @@ On top of making it very easy to define nodes, Nodezator comes packed full of us
 
 As we said before, Nodezator allows you to convert callables from third-party libraries with minimal effort. Here are just a few screenshots showing the usage of Nodezator with different libraries.
 
-Here's is a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
+Here's a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
 
 ![Pillow demonstration](https://nodezator.com/images/nodezator_pillow_demo.png)
 
@@ -214,6 +216,8 @@ However, users are encouraged to define their own nodes for their specific purpo
 
 ![A user-defined node](https://nodezator.com/images/node.png)
 
+In case you missed it at the beginning of this README, here's the link to a small video demonstrating how to define and load a node in less than 60 seconds: https://www.youtube.com/watch?v=cMfoaEs0fGY
+
 Nodes are created from Python scripts organized within folders that we call **node packs**. You can create a node pack folder **anywhere you want in your disk**. Under the hood, Nodezator treats it as a package in some contexts, so you can name that folder whatever you like, as long as it is a Python identifier. That is, it must start with a letter or underscore and contain only letters, digits and underscores.
 
 In other words, you **create nodes by writing Python functions/callables using your preferred text editor or IDE** and only then you **launch Nodezator in order to load them as nodes**, so you can create, edit and execute graphs.

{nodezator-1.5.4 → nodezator-1.5.5}/nodezator/appinfo.py

@@ -20,7 +20,7 @@ from collections import namedtuple
 
 AppVersion = namedtuple("AppVersion", "major minor micro release_level")
 
-APP_VERSION = AppVersion(1, 5, 4, "release_candidate")
+APP_VERSION = AppVersion(1, 5, 5, "release_candidate")
 
 MINIMAL_VERSION_STRING = '.'.join(map(str, APP_VERSION[:3]))
 

{nodezator-1.5.4 → nodezator-1.5.5}/nodezator/data/aww/nodezator.pysite/whats-new/v1-5.htsl

@@ -17,6 +17,7 @@
     <li><a href="https://github.com/IndieSmiths/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/IndieSmiths/nodezator/releases/tag/v1.5.3">[v1.5.3] User manual utility and file manager bug fix</a></li>
     <li><a href="https://github.com/IndieSmiths/nodezator/releases/tag/v1.5.4">[v1.5.4] Renamed parent project, bug fixes and more</a></li>
+    <li><a href="https://github.com/IndieSmiths/nodezator/releases/tag/v1.5.5">[v1.5.5] Quick patch to prevent crash on launch</a></li>
 </ul>
 
 <ol>
@@ -37,6 +38,7 @@
     <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>
     <li><a href="whats-new/v1-5.htsl#renamed-parent-project-bug-fixes-more">[v1.5.4] Renamed parent project, bug fixes and more</a></li>
+    <li><a href="whats-new/v1-5.htsl#quick-patch-prevent-crash-on-launch">[v1.5.5] Quick patch to prevent crash on launch</a></li>
 
 </ol>
 
@@ -307,6 +309,18 @@
 
 <p>Finally, we now also suppress a warning raised by pygame-ce versions 2.5.2 and 2.5.3 in specific circumstances. Such warning is actually a bug, which was already reported on their repository. Other than the misplaced warning, the bug is harmless though, so thankfully we only needed to suppress the warning so it doesn't confuse the users.</p>
 
+<h2 id="quick-patch-prevent-crash-on-launch">v1.5.5: Quick patch to prevent crash on launch</h2>
+
+<p>As usual, since this was a quick and simple fix/patch, I'll use an excerpt of the commit explaining the fix:</p>
+
+<blockquote>
+
+    <p>In summary, a change in pygame-ce 2.5.7 seems to have slightly changed how text is rendered, causing differences in the dimensions of the rendered characters (or at least in their bounding boxes) and those differences were raising an exception due to the discrepancy (and causing the app to crash on launch).</p>
+
+    <p>Rather than changing the values, we decided to remove the check altogether and adjust the code accordingly because the condition being flagged as an error (and thus raising an exception) wasn't as serious as we initially thought it to be.</p>
+
+</blockquote>
+
 </body>
 
 </htsl>

{nodezator-1.5.4 → nodezator-1.5.5}/nodezator/surfsman/icon.py

@@ -92,7 +92,7 @@ def render_layered_icon(
     ### the bounding rect represents the area from which
     ### to crop the character surface
 
-    font, bounding_rect = get_objs_for_icon_rendering(
+    font, bounding_rect, highest_achieved = get_objs_for_icon_rendering(
         font_path, stroke_char, dimension_name, dimension_value
     )
 
@@ -127,11 +127,49 @@ def render_layered_icon(
 
     ### background
 
+    ## because the actual desired value for the given dimension
+    ## can't always be guaranteed, if it is the case that it isn't
+    ## acheived, here we ensure that we use the actual desired value
+    ## as a fallback value if the respective background dimension
+    ## isn't provided; otherwise, the dimension of the bounding rect
+    ## is used
+    ##
+    ## this is needed because a change introduced in pygame-ce==2.5.7
+    ## slightly changed how text is rendered, turning it impossible for
+    ## some icons to achieve the desired value (which was also causing
+    ## exceptions to be raised, crashing the app, due to the strict
+    ## requirement that the desired value must be achieved);
+    ##
+    ## because of that, we had to adjust; as a result, some of the icons
+    ## may look just slightly off, but we checked and it is not ugly or
+    ## distracting, just different;
+    ##
+    ## regardless, icon rendering in future versions of this app will
+    ## likely rely on SVG rendering, rather than text rendering, which
+    ## should be way easier to deal with and provide better results too;
+    ## so this change, despite not being ideal, prevents the crash, doesn't
+    ## make the app look ugly nor makes it any harder to be used and
+    ## will be completely removed anyway when icon rendering is updated
+    ## to rely on SVG.
+
+    fallback_width = bounding_rect.width
+    fallback_height = bounding_rect.height
+
+    if highest_achieved != dimension_value:
+
+        if dimension_name == 'width':
+            fallback_width = dimension_value
+
+        else:
+            fallback_height = dimension_value
+
+    ## calculate the size
+
     size = tuple(
         dimension + (padding * 2)
         for dimension in (
-            background_width or bounding_rect.width,
-            background_height or bounding_rect.height,
+            background_width or fallback_width,
+            background_height or fallback_height,
         )
     )
 
@@ -323,21 +361,25 @@ def get_objs_for_icon_rendering(font_path, char, dimension_name, dimension_value
             chosen_font = font
             chosen_bounding_rect = bounding_rect
 
-    ### if the highest dimension achieved isn't the same as
-    ### the desired one, raise an error to notify the user
 
-    if dimension_value != highest_dimension:
-
-        message = (
-            f"couldn't get icon of {dimension_name}"
-            f" {dimension_value} from {Path(font_path).name}"
-            " font file"
-        )
+    ### note: at this spot, outside the while loop, there was a check that
+    ### raised an error when the desired value for the given dimension wasn't
+    ### achieved; this check was removed in order to prevent a crash because
+    ### the condition it was avoiding wasn't as serious as we thought at first
+    ### and the whole icon rendering operation will be updated some time in
+    ### the future anyway;
+    ###
+    ### as a result, this function also added a third element to the tuple
+    ### returned: the highest dimension achieved (which might be the desired
+    ### one or smaller); there's a comment in the render_layered_icon function
+    ### provides additional info on the context/reasoning behind this change;
+    ### you can find it in the "if" clause where the given dimension value is
+    ### compared with the highest dimension returned by this function;
 
-        raise ValueError(message)
 
-    ### finally, return the chosen font and bounding rect
-    return chosen_font, chosen_bounding_rect
+    ### finally, return the chosen font, bounding rect and highest
+    ### achieved value for the given dimension
+    return chosen_font, chosen_bounding_rect, highest_dimension
 
 
 ### small utility

{nodezator-1.5.4 → nodezator-1.5.5}/nodezator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: nodezator
-Version: 1.5.4
+Version: 1.5.5
 Summary: A generalist Python node editor
 Author-email: Kennedy Richard <kennedy@kennedyrichard.com>
 License: Unlicense
@@ -64,7 +64,9 @@ main_callable = get_circle_area
 
 ![node image](https://nodezator.com/images/get_circle_area_node.png)
 
-You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder (more about that further ahead in another section).
+You can store these functions/node definitions anywhere you want in your disk and once you launch Nodezator just provide the path so Nodezator can load them. The only requirement is that you organize these nodes definitions in separate files and store them in a folder. This small video (~2min) actually shows you how to define and load a node in **less than 60 seconds**:
+
+[![video: Defining and loading a node in less than 60 seconds](https://img.youtube.com/vi/cMfoaEs0fGY/hqdefault.jpg)](https://www.youtube.com/watch?v=cMfoaEs0fGY)
 
 You can actually turn **any** callable into a node very easily: classes, methods, etc. All callables available in the Python ecosystem can be turned into a node (even the ones defined in C, for instance).
 
@@ -108,7 +110,7 @@ On top of making it very easy to define nodes, Nodezator comes packed full of us
 
 As we said before, Nodezator allows you to convert callables from third-party libraries with minimal effort. Here are just a few screenshots showing the usage of Nodezator with different libraries.
 
-Here's is a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
+Here's a simple graph showing Nodezator usage with the [Pillow](https://python-pillow.org/) library.
 
 ![Pillow demonstration](https://nodezator.com/images/nodezator_pillow_demo.png)
 
@@ -246,6 +248,8 @@ However, users are encouraged to define their own nodes for their specific purpo
 
 ![A user-defined node](https://nodezator.com/images/node.png)
 
+In case you missed it at the beginning of this README, here's the link to a small video demonstrating how to define and load a node in less than 60 seconds: https://www.youtube.com/watch?v=cMfoaEs0fGY
+
 Nodes are created from Python scripts organized within folders that we call **node packs**. You can create a node pack folder **anywhere you want in your disk**. Under the hood, Nodezator treats it as a package in some contexts, so you can name that folder whatever you like, as long as it is a Python identifier. That is, it must start with a letter or underscore and contain only letters, digits and underscores.
 
 In other words, you **create nodes by writing Python functions/callables using your preferred text editor or IDE** and only then you **launch Nodezator in order to load them as nodes**, so you can create, edit and execute graphs.