turtleshell 1.0.0__tar.gz

turtleshell-1.0.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: turtleshell
+Version: 1.0.0
+Summary: Convenience wrapper around turtle.Turtle and turtle.Screen
+Author-email: Sam Mangan <sam.mangan2@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/SamMangan/turtleshell
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+# TurtleShell
+
+Convenience wrapper around Python turtle standard library.

turtleshell-1.0.0/README.md

@@ -0,0 +1,3 @@
+# TurtleShell
+
+Convenience wrapper around Python turtle standard library.

turtleshell-1.0.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "turtleshell"
+version = "1.0.0"
+authors = [
+  { name="Sam Mangan", email="sam.mangan2@gmail.com" },
+]
+description = "Convenience wrapper around turtle.Turtle and turtle.Screen"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.optional-dependencies]
+dev = ["bumpver", "pytest"]
+
+[project.urls]
+Homepage = "https://github.com/SamMangan/turtleshell"
+
+[tool.pytest.ini_options]
+pythonpath = "src"
+addopts = [
+    "--import-mode=importlib",
+]
+
+[tool.bumpver]
+current_version = "1.0.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message  = "Bump version {old_version} -> {new_version}"
+commit          = true
+tag             = true
+push            = false
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"', 'version = "{version}"']
+"src/turtleshell/__init__.py" = ["{version}"]

turtleshell-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

turtleshell-1.0.0/src/turtleshell/__init__.py

@@ -0,0 +1,3 @@
+from .core import Screen, Turtle
+
+__version__ = "1.0.0"

turtleshell-1.0.0/src/turtleshell/core.py

@@ -0,0 +1,168 @@
+"""Convenience wrappers around turtle.Turtle and turtle.Screen
+  See https://github.com/python/cpython/blob/main/Lib/turtle.py
+  """
+#TODO handle floats, randcoords, default screensize, default shape
+
+import colorsys
+from dataclasses import dataclass
+import turtle
+
+@dataclass
+class HSV:
+  hue: float
+  sat: float
+  val: float
+  def __iter__(self):
+    return iter(self.__dict__.values())
+
+def Screen():
+    """Return the singleton screen object."""
+    if Turtle._screen is None:
+        Turtle._screen = _Screen()
+    return Turtle._screen
+
+class _Screen(turtle._Screen):
+  def __init__(self):
+    super().__init__()
+    turtle.TurtleScreen.__init__(self, _Screen._canvas)
+    if turtle.Turtle._screen is None:
+      turtle.Turtle._screen = self
+    self.colormode(255)
+  
+  def _colorstr(self, color):
+    isnumber = lambda x: isinstance(x, (int, float))
+    if len(color) == 3 and all([isnumber(c) for c in color]):
+      lower, upper = 0, Turtle._screen.colormode()
+      color = [max(min(upper, round(c)), lower) for c in color]
+    return super()._colorstr(color)
+
+def _hsv_to_rgb(hsv):
+  rgb = colorsys.hsv_to_rgb(*hsv)
+  return [round(c*Turtle._screen.colormode()) for c in rgb]
+
+class Turtle(turtle.RawTurtle):
+
+  _pen = None
+  _screen = None
+
+  def __init__(self,
+              shape=turtle._CFG["shape"],
+              undobuffersize=turtle._CFG["undobuffersize"],
+              visible=turtle._CFG["visible"]):
+    if Turtle._screen is None:
+      Turtle._screen = Screen()
+    turtle.RawTurtle.__init__(self, Turtle._screen,
+                        shape=shape,
+                        undobuffersize=undobuffersize,
+                        visible=visible)
+    self.shapesize(20)
+    self._pen_hsv = HSV(0, 1, 1)
+    self._fill_hsv = HSV(0, 1, 1)
+
+  @property
+  def x(self):
+    return self.xcor()
+
+  @x.setter
+  def x(self, value):
+    self.setx(value)
+
+  @property
+  def y(self):
+    return self.ycor()
+
+  @y.setter
+  def y(self, value):
+    self.sety(value)
+
+  @property
+  def shapewidth(self):
+    xcoords = [vertex[0] for vertex in self.get_shapepoly()]
+    return max(xcoords) - min(xcoords)
+
+  @property
+  def shapeheight(self):
+    ycoords = [vertex[1] for vertex in self.get_shapepoly()]
+    return max(ycoords) - min(ycoords)
+
+  def hue(self, degrees):
+    self.penhue(degrees)
+    self.fillhue(degrees)
+
+  def penhue(self, degrees):
+    self._pen_hsv.hue = degrees/360
+    self.pencolor(_hsv_to_rgb(self._pen_hsv))
+
+  def fillhue(self, degrees):
+    self._fill_hsv.hue = degrees/360
+    self.fillcolor(_hsv_to_rgb(self._fill_hsv))
+
+  def sat(self, value):
+    self.pensat(value)
+    self.fillsat(value)
+
+  def pensat(self, value):
+    self._pen_hsv.sat = value/100
+    self.pencolor(_hsv_to_rgb(self._pen_hsv))
+
+  def fillsat(self, value):
+    self._fill_hsv.sat = value/100
+    self.fillcolor(_hsv_to_rgb(self._fill_hsv))
+
+  def val(self, value):
+    self.penval(value)
+    self.fillval(value)
+
+  def penval(self, value):
+    self._pen_hsv.val = value/100
+    self.pencolor(_hsv_to_rgb(self._pen_hsv))
+
+  def fillval(self, value):
+    self._fill_hsv.val = value/100
+    self.fillcolor(_hsv_to_rgb(self._fill_hsv))
+
+  def shapesize(self, stretch_wid=None, stretch_len=None, outline=None):
+    stretch_wid = stretch_wid/20 if stretch_wid else None
+    stretch_len = stretch_len/20 if stretch_len else None
+    super().shapesize(stretch_wid, stretch_len, outline)
+
+  def teleport(self, x, y):
+    pendown = self.isdown()
+    if pendown:
+      self.pen(pendown=False)
+    self.penup()
+    self._position = turtle.Vec2D(x, y)
+    self.pen(pendown=pendown)
+
+  def write(self, arg, move=False, align="center", font=("Arial", 18, "bold")):
+    super().write(arg, move, align, font)
+
+Pen = Turtle
+
+if __name__ == "__main__":
+  canvas = Screen()
+  canvas.bgcolor("gold")
+  pen = Turtle()
+  print(f"\n\n***\nTURTLE TYPE: {type(pen)}\nSCREEN TYPE: {type(canvas)}\n***\n")
+
+  pen.shape("square")
+  print(f"{pen.shapewidth}, {pen.shapeheight}")
+  pen.shapesize(30, 25)
+  print(f"{pen.shapewidth}, {pen.shapeheight}")
+
+  pen.hue(0)
+  pen.stamp()
+  pen.forward(50)
+  pen.hue(60)
+  pen.stamp()
+  pen.forward(50)
+  pen.hue(120)
+  pen.stamp()
+  pen.forward(50)
+  pen.hue(180)
+  pen.stamp()
+  pen.forward(50)
+  pen.hue(240)
+  pen.stamp()
+
+  canvas.exitonclick()

turtleshell-1.0.0/src/turtleshell.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: turtleshell
+Version: 1.0.0
+Summary: Convenience wrapper around turtle.Turtle and turtle.Screen
+Author-email: Sam Mangan <sam.mangan2@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/SamMangan/turtleshell
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: bumpver; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+# TurtleShell
+
+Convenience wrapper around Python turtle standard library.

turtleshell-1.0.0/src/turtleshell.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/turtleshell/__init__.py
+src/turtleshell/core.py
+src/turtleshell.egg-info/PKG-INFO
+src/turtleshell.egg-info/SOURCES.txt
+src/turtleshell.egg-info/dependency_links.txt
+src/turtleshell.egg-info/requires.txt
+src/turtleshell.egg-info/top_level.txt
+tests/test_turtle.py

turtleshell-1.0.0/src/turtleshell.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

turtleshell-1.0.0/src/turtleshell.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[dev]
+bumpver
+pytest

turtleshell-1.0.0/src/turtleshell.egg-info/top_level.txt

@@ -0,0 +1 @@
+turtleshell

turtleshell-1.0.0/tests/test_turtle.py

@@ -0,0 +1,106 @@
+import pytest
+from turtleshell import Screen, Turtle
+
+BLACK = (0, 0, 0)
+WHITE = (255, 255, 255)
+RED = (255, 0, 0)
+GREEN = (0, 255, 0)
+BLUE = (0, 0, 255)
+
+@pytest.fixture
+def pen():
+  Screen().tracer(0)
+  _pen = Turtle(visible=False)
+  return _pen
+
+@pytest.fixture
+def screen():
+  return Screen()
+
+def test_x(pen):
+  pen.setx(100)
+  assert pen.x == 100
+
+def test_y(pen):
+  pen.sety(200)
+  assert pen.y == 200
+
+def test_shapesize(pen):
+  pen.shape("square")
+  pen.shapesize(30,40)
+  assert pen.shapewidth == 30
+  assert pen.shapeheight == 40
+
+def test_teleport(pen):
+  assert pen.position() == (0, 0)
+  pen.pendown()
+  pen.teleport(100, 200)
+  assert pen.position() == (100, 200) 
+  assert len(pen.currentLine) == 1 # single point => no line drawn
+  assert pen.isdown() # pen still down
+
+def test_hsv_hue(pen):
+  # pencolor
+  pen.penhue(0)
+  assert pen.pencolor() == RED
+  pen.penhue(120)
+  assert pen.pencolor() == GREEN
+  pen.penhue(240)
+  assert pen.pencolor() == BLUE
+
+  # fillcolor
+  pen.fillhue(0)
+  assert pen.fillcolor() == RED
+  pen.fillhue(120)
+  assert pen.fillcolor() == GREEN
+  pen.fillhue(240)
+  assert pen.fillcolor() == BLUE
+  
+def test_hsv_saturation(pen):
+  # pencolor
+  pen.pensat(0)
+  assert pen.pencolor() == WHITE
+  pen.pensat(50)
+  assert pen.pencolor() == (255, 128, 128) # light red
+  pen.pensat(100)
+  assert pen.pencolor() == RED
+  
+  # fillcolor
+  pen.fillsat(0)
+  assert pen.fillcolor() == WHITE
+  pen.fillsat(50)
+  assert pen.fillcolor() == (255, 128, 128) # light red
+  pen.fillsat(100)
+  assert pen.fillcolor() == RED
+  
+def test_hsv_value(pen):
+  # pencolor
+  pen.penval(0)
+  assert pen.pencolor() == BLACK
+  pen.penval(50)
+  assert pen.pencolor() == (128, 0, 0) # dark red
+  pen.penval(100)
+  assert pen.pencolor() == RED
+  
+  # fillcolor
+  pen.fillval(0)
+  assert pen.fillcolor() == BLACK
+  pen.fillval(50)
+  assert pen.fillcolor() == (128, 0, 0) # dark red
+  pen.fillval(100)
+  assert pen.fillcolor() == RED
+    
+def test_color(pen, screen):
+  # Colors are clamped to [0, 255]
+  pen.pencolor(-20, -5, 0)
+  assert pen.pencolor() == BLACK
+
+  pen.pencolor(300, 300, 300)
+  assert pen.pencolor() == WHITE
+
+  # Floats are rounded
+  screen.bgcolor(255, 0.3, 0)
+  assert screen.bgcolor() == (255, 0, 0)
+
+  screen.bgcolor(255, 0.7, 0)
+  assert screen.bgcolor() == (255, 1, 0)