Merge pull request #32 from bosup/main

issue #9 enhancement - add give_fact attribute

Author: nickmckay

pyCatSim/api/cat.py

@@ -6,6 +6,7 @@
 
 
 from ..utils import noises
+from ..utils import facts
 
 import difflib
 
@@ -60,6 +61,24 @@ class Cat:
         nutmeg = cats.Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
     
     """
+
+    def give_fact(self):
+        """
+        calls ..utils.random_facts() and return a random fact about cats
+        
+        Returns
+        -------
+        str
+            A fact randomly chosen from a pre-defined fact pool 
+        --------
+        
+        .. jupyter-execute::
+            
+            import pyCatSim as cats
+            nutmeg = cats.Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
+            nutmeg.give_fact()
+        """ 
+        return facts.random_facts()
 
     def __init__(self, name, age=None, color=None, mood=0, hunger_level=0, 
                  energy=0, health=0):
@@ -191,4 +210,4 @@ def play(self, mood_boost=1, hunger_boost=1, energy_boost=-1):
             self.mood += mood_boost
             self.hunger_level += hunger_boost
             self.energy += energy_boost
-                        
+

pyCatSim/api/human.py

@@ -5,6 +5,7 @@
 """
 
 from ..api.cat import Cat
+from ..utils import facts
 
 class Owner:
     """
@@ -48,6 +49,27 @@ class Owner:
         print([cat.name for cat in owner2.cats_owned])
 
     """
+
+    def give_fact(self):
+        """
+        calls ..utils.random_facts() and return a random fact about cats
+        
+        Returns
+        -------
+        str
+            A fact randomly chosen from a pre-defined fact pool 
+        
+        Examples
+        --------
+        
+        .. jupyter-execute::
+            
+            import pyCatSim as cats
+            nutmeg = cats.Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
+            nutmeg.give_fact()
+        """ 
+        return facts.random_facts()
+
     def __init__(self, name, cats_owned):
 
         if isinstance(cats_owned, Cat):

pyCatSim/tests/test_api_Cat.py

@@ -89,4 +89,31 @@ def test_play_t0(self):
 
         assert cat.mood == 3
         assert cat.hunger_level == 0
-        assert cat.energy == 1  
+        assert cat.energy == 1  
+
+
+class TestcatCatFact:
+    ''' Test for the give_fact function'''
+    
+    def test_give_fact_t0(self):
+        cat=Cat(name="Boots", age=2, color="tabby", mood=2, hunger_level=-1,
+                energy = 2, health = 3)
+        
+        cat.give_fact()
+
+        assert cat.give_fact() in [
+        "Cats sleep for 70% of their lives.",
+        "A group of cats is called a clowder.",
+        "Cats can rotate their ears 180 degrees.",
+        "The world's oldest cat lived to be 38 years old.",
+        "Cats have five toes on their front paws, but only four on the back.",
+        "A cat can jump up to six times its length.",
+        "Each cat's nose print is unique, like a human fingerprint.",
+        "Cats use their whiskers to detect changes in their surroundings.",
+        "The average house cat can run at speeds up to 30 mph.",
+        "Cats meow only to communicate with humans."
+    ]
+        
+
+
+

pyCatSim/tests/test_api_Owner.py

@@ -43,6 +43,16 @@ def test_init_t1(self):
         assert len(owner1.cats_owned) == 2
 
 
+class TesthumanOwnerFact:
+    ''' Test for the give_fact function'''
+    
+    def test_give_fact_t0(self):
+        cat1 = Cat(name="Whiskers")
+        owner1 = Owner(name="Sasha", cats_owned=cat1)
+        
+        owner1.give_fact()
+        
+
 class TesthumanOwnerAdopt:
     def test_adopt_t0(self):
 
@@ -73,4 +83,4 @@ def test_groom_t0(self):
          assert cat1.mood == 8
 
 
-     
+     

pyCatSim/utils/__init__.py

@@ -4,4 +4,5 @@
 Contains all basic block functions for pyCatSim. 
 """
 
-from .noises import *
+from .noises import *
+from .facts import *

pyCatSim/utils/facts.py

@@ -0,0 +1,40 @@
+
+# __all__=['random_facts']
+
+import random
+
+def random_facts():
+    """
+    calls up random facts about cats
+
+    Returns
+    -------
+    str
+        A fact randomly chosen from a pre-defined fact pool 
+
+    Examples
+    --------
+    
+    .. jupyter-execute::
+        
+        import pyCatSim as cats
+        nutmeg = cats.Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
+        nutmeg.give_fact()
+
+    """
+
+    cat_facts = [
+        "Cats sleep for 70% of their lives.",
+        "A group of cats is called a clowder.",
+        "Cats can rotate their ears 180 degrees.",
+        "The world's oldest cat lived to be 38 years old.",
+        "Cats have five toes on their front paws, but only four on the back.",
+        "A cat can jump up to six times its length.",
+        "Each cat's nose print is unique, like a human fingerprint.",
+        "Cats use their whiskers to detect changes in their surroundings.",
+        "The average house cat can run at speeds up to 30 mph.",
+        "Cats meow only to communicate with humans."
+    ]
+    return random.choice(cat_facts)
+
+