TurtleExtension 2.1.0__tar.gz → 2.2.0__tar.gz

{turtleextension-2.1.0 → turtleextension-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TurtleExtension
-Version: 2.1.0
+Version: 2.2.0
 Summary: A Python utility library providing turtle extensions on top of Python's original turtle feature.
 Author-email: "Miah M. Sabiq" <miah.sabiq@gibs.at>
 Requires-Python: >=3.14

{turtleextension-2.1.0 → turtleextension-2.2.0}/TurtleExtension.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TurtleExtension
-Version: 2.1.0
+Version: 2.2.0
 Summary: A Python utility library providing turtle extensions on top of Python's original turtle feature.
 Author-email: "Miah M. Sabiq" <miah.sabiq@gibs.at>
 Requires-Python: >=3.14

{turtleextension-2.1.0 → turtleextension-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "TurtleExtension"
-version = "2.1.0"
+version = "2.2.0"
 description = "A Python utility library providing turtle extensions on top of Python's original turtle feature."
 readme = "README.md"
 requires-python = ">= 3.14"

{turtleextension-2.1.0 → turtleextension-2.2.0}/turtle_extension/foundations/custom_turtle_shapes.pyi

@@ -24,6 +24,7 @@ class UserShape:
     def custom_circle() -> ReturnShapeType:
         """
         Creates a custom circle turtle shape.
+
         :return: the custom shape
         """
 
@@ -31,6 +32,7 @@ class UserShape:
     def custom_square() -> ReturnShapeType:
         """
         Creates a custom square turtle shape.
+
         :return: the custom shape
         """
 
@@ -38,6 +40,7 @@ class UserShape:
     def custom_triangle() -> ReturnShapeType:
         """
         Creates a custom equilateral triangle turtle shape.
+
         :return: the custom shape
         """
 
@@ -45,6 +48,7 @@ class UserShape:
     def custom_poly() -> ReturnShapeType:
         """
         Creates a custom regular polygon turtle shape.
+
         :return: the custom shape
         """
 
@@ -52,19 +56,22 @@ class UserShape:
     def custom_SOD() -> ReturnShapeType:
         """
         Creates a custom star of David turtle shape.
+
         :return: the custom shape
         """
 
     @classmethod
     def list_shapes(cls) -> UserShapeDictType:
         """
-        Creates a dictionary with the functions in UserShape and returns it
+        Creates a dictionary with the functions in UserShape and returns it.
+
         :return: dictionary containing function names -> function
         """
 
 def get_UserShape_dict() -> UserShapeDictType:
     """
-    Takes all custom turtle functions in UserShape and returns a dictionary with them
+    Takes all custom turtle functions in UserShape and returns a dictionary with them.
+
     :return: dictionary mapping function names to functions
     """
 

{turtleextension-2.1.0 → turtleextension-2.2.0}/turtle_extension/foundations/global_functions.pyi

@@ -9,31 +9,36 @@ from ..turtle_heart import ChainTurtle, tl
 def get_screen() -> tl.Screen:
     """
     Initiates the turtle screen when the function is called.
+
     :return: turtle screen object
     """
 
 def SU() -> None:
     """
     This function updates the turtle screen.
+
     :return: None
     """
 
 def mainloop() -> None:
     """
     This function keeps the turtle screen open.
+
     :return: None
     """
 
 type TurtleListType = list[ChainTurtle]
 
 def tls_color(**options) -> int | tuple[TurtleListType, int] | TurtleListType | None:
-    """This function creates a turtle list with their colors or adds newly creates turtles to the UV["tls"] list
+    """
+    This function creates a turtle list with their colors or adds newly creates turtles to the UV["tls"] list
     to be used for the user_drawing_ft()
 
     USERS NOTICE: it is HIGHLY recommended to NOT enter a turtles count of MORE than a few hundred (max. 200) unless required!!!
 
     :param options: tl_num -> number of turtles to create, entry -> input string, index -> number of turtles to be created for user_drawing_ft()
     & it returns the index of the last turtle
+
     :return: tls_num: turtle list with colored turtles, entry: list with colored turtles + number of turtles ,otherwise: index of last turtle
     """
 
@@ -42,6 +47,7 @@ def reset_tls(tls_list: TurtleListType) -> list:
     This function deletes the drawings of given turtle list + turtles
 
     >>> tls = [ChainTurtle(), ChainTurtle()]
+    
     >>> reset_tls(tls)
     []
 

{turtleextension-2.1.0 → turtleextension-2.2.0}/turtle_extension/foundations/turtle_functions.pyi

@@ -13,7 +13,9 @@ class TurtleFct:
     def change_shape(cls, tls_num: ChainTurtle|None = None) -> ChainTurtle | str:
         """
         This function lets the user choose different turtles shapes, including a custom option.
+
         :param tls_num: ChainTurtle() or None
+
         :return: ChainTurtle() if tls_num is a ChainTurtle(), otherwise None
         """
 
@@ -21,6 +23,8 @@ class TurtleFct:
     def user_tls_shape_ft(tls_num: ChainTurtle | None = None) -> ChainTurtle | str:
         """
         This function lets the user create custom turtle shapes.
+
         :param tls_num: ChainTurtle() or None
+        
         :return: ChainTurtle() if tls_num is a ChainTurtle(), otherwise None
         """

{turtleextension-2.1.0 → turtleextension-2.2.0}/turtle_extension/turtle_heart/turtle_skeleton.pyi

@@ -9,97 +9,123 @@ from numbers import Real
 tl = tl
 
 class ChainTurtle:
-    """This class adds chaining functionality to turtle.Turtle"""
+    """
+    This class adds chaining functionality to turtle.Turtle
+    
+    """
     def fd(self, distance: Real) -> ChainTurtle:
         """
         Makes the turtle go forward with trace.
+
         :param distance: distance in pixels
+
         :return: ChainTurtle()
         """
 
     def fd_inv(self, distance: Real) -> ChainTurtle:
         """
         Makes the turtle go forward with no trace.
+
         :param distance: distance in pixels
+
         :return: ChainTurtle()
         """
 
     def bk(self, distance: Real) -> ChainTurtle:
         """
         Makes the turtle go backwards with trace.
+
         :param distance: distance in pixels
+
         :return: ChainTurtle()
         """
 
     def bk_inv(self, distance: Real) -> ChainTurtle:
         """
         Makes the turtle go backward with no trace.
+
         :param distance: distance in pixels
+
         :return: ChainTurtle()
         """
 
     def rt(self, angle: Real) -> ChainTurtle:
         """
         Makes the turtle turn right.
+
         :param angle: angle in degrees
+
         :return: ChainTurtle()
         """
 
     def lt(self, angle: Real) -> ChainTurtle:
         """
         Makes the turtle turn left.
+
         :param angle: angle in degrees
+
         :return: ChainTurtle()
         """
 
     def setpos(self, x_val: Real, y_val: Real) -> ChainTurtle:
         """
         Makes the turtle go to a specific position with a trace.
+
         :param x_val: x position in pixels
+
         :param y_val: y position in pixels
+
         :return: ChainTurtle()
         """
 
     def pu(self) -> ChainTurtle:
         """
         Puts the pen down to leave a trace.
+
         :return: ChainTurtle()
         """
 
     def pd(self) -> ChainTurtle:
         """
         Puts the pen up to not leave a trace.
+
         :return: ChainTurtle()
         """
 
     def seth(self, direction: Real) -> ChainTurtle:
         """
         Sets the direction of the turtle starting East, going counterclockwise.
+
         :param direction: direction in degrees
+
         :return: ChainTurtle()
         """
 
     def home(self) -> ChainTurtle:
         """
         Sets the position of the turtle to home (0, 0) with trace, heading = 0 .
+
         :return: ChainTurtle()
         """
 
     def home_inv(self) -> ChainTurtle:
         """
         Sets the position of the turtle to home (0, 0) without trace, heading = 0 .
+
         :return: ChainTurtle()
         """
 
     def begin_fill(self) -> ChainTurtle:
         """
         Makes the turtle begin fill for a closed shape.
+
         :return: ChainTurtle()
         """
 
     def end_fill(self) -> ChainTurtle:
         """
         Ends the turtle fill for a closed shape, therefore fills the shapes.
+
         :return: ChainTurtle()
         """
 
@@ -109,9 +135,13 @@ class ChainTurtle:
                steps: int | None = None) -> ChainTurtle:
         """
         Makes the turtle draw a circle
+
         :param radius: radius in pixels
+
         :param extent: extent in degrees
+
         :param steps: number of sides
+
         :return: ChainTurtle()
         """
 
@@ -121,56 +151,72 @@ class ChainTurtle:
                     sides: int | None = None) -> ChainTurtle:
         """
         Makes the turtle draw a circle and fills it
+
         :param radius: radius in degrees
+
         :param angle: angle in degrees
+
         :param sides: number of sides
+
         :return: ChainTurtle()
         """
 
     def dot(self, radius: Real) -> ChainTurtle:
         """
         Makes the turtle draw a colored dot
+
         :param radius: radius in pixels
+
         :return: ChainTurtle()
         """
 
     def color(self, turtle_color: str) -> ChainTurtle:
         """
         Lets the user change the color of the turtle trace and turtle color itself
+
         :param turtle_color: valid turtle color
+
         :return: ChainTurtle()
         """
 
     def teleport(self, x: Real, y: Real, *, fill_gap: bool = False) -> ChainTurtle:
         """
         Makes the turtle to go a specific coordinate with no trace
+
         :param x: x position in pixels
+
         :param y: y position in pixels
+
         :return: ChainTurtle()
         """
 
     def shape(self, shape_name: str) -> ChainTurtle:
         """
         Changes the shape of the turtle shape
+
         :param shape_name: name of the shape
+
         :return: ChainTurtle()
         """
 
     def undo(self) -> ChainTurtle:
         """
         Undoes the last turtle command.
+
         :return: ChainTurtle()
         """
 
     def clear(self) -> ChainTurtle:
         """
         Deletes the turtles drawings.
+
         :return: ChainTurtle()
         """
 
     def ht(self) -> ChainTurtle:
         """
         Hides the turtle.
+
         :return: ChainTurtle()
         """
 
@@ -178,5 +224,6 @@ class ChainTurtle:
     def list_methods(cls) -> dict[str, Callable]:
         """
         Creates a dictionary with all ChainTurtle methods and returns it
+        
         :return: dictionary
         """