Merge branch 'main' into bathe-feature

Author: khider

pyCatSim/api/cat.py

@@ -6,8 +6,10 @@
 
 
 from ..utils import noises
+from ..utils import display
 from ..utils import facts
 
+import random
 import difflib
 import math
 
@@ -237,6 +239,25 @@ def bathe(self):
         self.mood -= 1
         self.health += 1
 
+        
+    def show(self):
+        """
+        
+
+        Returns
+        -------
+        None.
+
+        """
+        
+        possible_colors = ['tabby', 'black', 'orange', 'tortoiseshell', 'tuxedo']
+        
+        try:
+            display.show(self.color)
+        except:        
+            color = random.choice(possible_colors)
+            display.show(color)
+       
 
     def groom(self):
 

pyCatSim/images/black.jpg

@@ -21,6 +21,7 @@
 import pytest
 import sys
 from pyCatSim import Cat
+from PIL import Image
 
 class TestcatCatInit:
     ''' Test for Cat instantiation '''
@@ -99,6 +100,29 @@ def test_bathe_t0(self):
         cat.bathe()
         assert cat.mood == 1
         assert cat.health == 5
+
+
+class TestcatCatShow:
+    ''' Tests for the Cat.show() method '''
+
+    def test_show_no_color_returns_image(self):
+        """ test that show() returns an image when color is None (random) """
+        cat = Cat(name="Boots", color=None)
+        img = cat.show()
+        assert isinstance(img, Image.Image)  # PIL image check
+
+    @pytest.mark.parametrize("color", ['tabby', 'black', 'orange', 'tortoiseshell', 'tuxedo'])  # Example colors
+    def test_show_with_color_returns_image(self, color):
+        """ test that show() returns an image for specified color """
+        cat = Cat(name="Boots", color=color)
+        img = cat.show()
+        assert isinstance(img, Image.Image)
+
+    def test_show_invalid_color_raises(self):
+        """ test that show() raises ValueError for invalid color """
+        cat = Cat(name="Boots", color="invalid_color")
+        with pytest.raises(ValueError):
+            cat.show()  
 
 class TestcatCatGroom:
     ''' Test for the groom function'''

pyCatSim/images/orange.jpg

@@ -5,4 +5,5 @@
 """
 
 from .noises import *
+from .display import *
 from .facts import *

pyCatSim/images/tabby.jpg

@@ -0,0 +1,37 @@
+import os
+import random
+from pathlib import Path
+import matplotlib.pyplot as plt
+import matplotlib.image as mpimg
+
+__all__=['show']
+
+# Path to the sound files
+IMG_DIR = Path(__file__).parents[1].joinpath("images").resolve()
+
+
+def show(color):
+    """
+    
+
+    Parameters
+    ----------
+    color : TYPE
+        DESCRIPTION. 
+
+    Returns
+    -------
+    None.
+
+    """
+    
+
+
+    filename = f"{color}.jpg"
+    image_path = os.path.join(IMG_DIR, filename)
+    
+
+    img = mpimg.imread(image_path)
+    plt.imshow(img)
+    plt.axis('off')
+    plt.show()

pyCatSim/images/tortoiseshell.jpg

@@ -12,6 +12,9 @@
 from playsound import playsound
 import os
 from pathlib import Path 
+import random
+import matplotlib.pyplot as plt
+import matplotlib.image as mpimg
 
 # Path to the sound files
 SOUND_DIR = Path(__file__).parents[1].joinpath("sounds").resolve()