Merge pull request #21 from ballight42/main

Add adopt function

Author: nickmckay

pyCatSim/api/human.py

@@ -8,7 +8,7 @@
 
 class Owner:
     """
-    Represents a cat owner who can care for one or more cats.
+    Represents a cat owner who can care for one or more cats
 
     Parameters
     ----------
@@ -60,6 +60,55 @@ def __init__(self, name, cats_owned):
 
         self.name = name
         self.cats_owned = cats_owned
+
+    def adopt(self, cats_object):
+
+        """
+        Add a Cat object or a list of Cat objects to an owner's cats.
+
+        Parameters
+        ----------
+        cats_object: the cat to be added to the list
+
+        Raises
+        ------
+        TypeError
+                If any of the arguments are not Cat.
+        ValueError
+                If cats_object is not Cat.
+
+        Examples
+        --------
+
+        .. jupyter-execute::
+
+            import pyCatSim as cats
+
+            cat1 = cats.Cat(name="Whiskers")
+            cat2 = cats.Cat(name="Boots", color="tabby")
+            owner1 = Owner(name="Sasha", cats_owned=cat1)
+            owner2 = Owner(name="Liam", cats_owned=[cat1, cat2])
+
+            chestnut = cats.Cat(name='Chestnut', age = 4, color = 'tabby')
+            nutmeg = cats.Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
+            owner1.adopt(owner1,nutmeg)
+            owner2.adopt(owner2,[chestnug,nutmeg])
+
+            print(owner1.name)
+            print([cat.name for cat in owner2.cats_owned])
+
+
+        """
+        if isinstance(cats_object, Cat):
+            self.cats_owned.append(cats_object)
+        elif isinstance(cats_object, list):
+            if not all(isinstance(cat, Cat) for cat in cats_object):
+                raise TypeError("All elements in cats_object must be instances of Cat.")
+            else:
+                self.cats_owned+=cats_object
+        else:
+            raise TypeError("cats_owned must be a Cat instance or a list of Cat instances.")
+
 
     def groom(self,Cat):
         """

pyCatSim/tests/test_api_Owner.py

@@ -41,6 +41,25 @@ def test_init_t1(self):
         assert owner1.name == 'Liam'
         assert type(owner1.cats_owned) is list
         assert len(owner1.cats_owned) == 2
+
+
+class TesthumanOwnerAdopt:
+    def test_adopt_t0(self):
+        
+        cat1 = Cat(name="Whiskers")
+        cat2 = Cat(name="Boots", color="tabby")
+        owner1 = Owner(name="Sasha", cats_owned=cat1)
+        owner2 = Owner(name="Liam", cats_owned=[cat1, cat2])
+        chestnut = Cat(name='Chestnut', age = 4, color = 'tabby')
+        nutmeg = Cat(name='Nutmeg', age = 3, color = 'tortoiseshell')
+
+        new_cat=chestnut
+        owner1.adopt(new_cat)
+        assert owner1.cats_owned[-1] == new_cat
+
+        new_cat=[chestnut,nutmeg]
+        owner2.adopt(new_cat)
+        assert owner2.cats_owned[-len(new_cat):]==new_cat
 
 class TesthumanActions:
     ''' Test for Owner action success '''
@@ -54,8 +73,4 @@ def test_groom_t0(self):
          assert cat1.mood == 8
 
 
-        
-        
-        
-        
-        
+