This project was part of a 9-week training course I attended in 2024.

• Bootcamp: Ironhack AI Engineering bootcamp
• Date: September to November 2024
• Project topics: Python basics, OOP, inheritage

Teacher's feedback:

Good code and docstrings. You even implemented __repr()__ and fixed wargame.py. Congrats!
Final grade: 10 / 10  

---

Mini Project | Vikings

Introduction

The Vikings and the Saxons are at War. Both are Soldiers but they have their own methods to fight. Vikings are ported to Python. YAY!!

In this laboratory you will work with the concept of inheritance in Python.

Getting Started

You will find the following files in the folder of this laboratory:

• vikingsClasses.py
• 1-testSoldier.py
• 2-testVikings.py
• 3-testSaxons.py
• 4-testWar.py

You are free to use any of the code editors you have to open these files.

Challenge Question

Modify the file vikingsClasses.py so that all the tests are correct.

Submission

• Modify vikingsClasses.py and save your changes.

Tests

Best way to know how our code is doing is to work with tests. You will test the vikingsClases.py file step by step.

You will only be editing the vikingsClasses.py. The files you will running to test your code are the following: 1-testsSoldier.py, 2-testsVikings.py, 3-testsSaxons.py & 4-testsWar.py, depending on how far you have written your code.

So, let's say you have already created the class for Soldiers.

1. You wrote your code
2. Make sure you save the changes in your editor
3. In your terminal, run the test file for that class

$ python3 1-testSoldier.py --v

Correct Test

When the tests are all correct you will receive the following message in the terminal.

$ python3 1-testSoldier.py --v

testAttackHasNoParams (__main__.TestSoldier) ... ok
testAttackRetunsStrength (__main__.TestSoldier) ... ok
testAttackShouldBeFunction (__main__.TestSoldier) ... ok
testCanReceiveDamage (__main__.TestSoldier) ... ok
testConstructorSignature (__main__.TestSoldier) ... ok
testHealth (__main__.TestSoldier) ... ok
testReceiveDamageReturnNone (__main__.TestSoldier) ... ok
testReceivesDamage (__main__.TestSoldier) ... ok
testReceivesDamageHasParams (__main__.TestSoldier) ... ok
testStrength (__main__.TestSoldier) ... ok

----------------------------------------------------------------------
Ran 10 tests in 0.001s

OK

Failed Test

When any test is incorrect you will receive the following message in the terminal. It means that you must keep making changes in the vikingsClasses.py file.

$ python3 1-testSoldier.py --v

testAttackHasNoParams (__main__.TestSoldier) ... ok
testAttackRetunsStrength (__main__.TestSoldier) ... ok
testAttackShouldBeFunction (__main__.TestSoldier) ... ok
testCanReceiveDamage (__main__.TestSoldier) ... FAIL
testConstructorSignature (__main__.TestSoldier) ... ok
testHealth (__main__.TestSoldier) ... ok
testReceiveDamageReturnNone (__main__.TestSoldier) ... ok
testReceivesDamage (__main__.TestSoldier) ... ok
testReceivesDamageHasParams (__main__.TestSoldier) ... ok
testStrength (__main__.TestSoldier) ... ok

======================================================================
FAIL: testCanReceiveDamage (__main__.TestSoldier)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "1-testsSoldier.py", line 44, in testCanReceiveDamage
    self.assertEqual(self.soldier.health, self.health + 50)
AssertionError: 250 != 350

----------------------------------------------------------------------
Ran 10 tests in 0.001s

Exercise

Write the code

Now we have to write the correct code in the vikingsClasses.py file to make the test pass. The starter code you will find in the file is the following:

# Soldier
class Soldier:

# Viking
class Viking:

# Saxon
class Saxon:

# War
class War:

In this case, the test says that Soldier constructor function should receive 2 arguments (health & strength), so we have to write the correct code that passes this test. Let's make the Soldier constructor function receive two arguments:

# Soldier
class Soldier:
    def __init__(self, health, strength):
        # add code here

# Viking
class Viking:

# Saxon
class Saxon:

# War
class War:

Soldier

Modify the Soldier constructor function and add 2 methods to its prototype: attack(), and receiveDamage().

constructor function

• should receive 2 arguments (health & strength)
• should receive the health property as its 1st argument
• should receive the strength property as its 2nd argument

attack() method

• should be a function
• should receive 0 arguments
• should return the strength property of the Soldier

receiveDamage() method

• should be a function
• should receive 1 argument (the damage)
• should remove the received damage from the health property
• shouldn't return anything

---

Viking

A Viking is a Soldier with an additional property, their name. They also have a different receiveDamage() method and new method, battleCry().

Modify the Viking constructor function, have it inherit from Soldier, reimplement the receiveDamage() method for Viking, and add a new battleCry() method.

inheritance

• Viking should inherit from Soldier

constructor function

• should receive 3 arguments (name, health & strength)
• should receive the name property as its 1st argument
• should receive the health property as its 2nd argument
• should receive the strength property as its 3rd argument

attack() method

(This method should be inherited from Soldier, no need to reimplement it.)

• should be a function
• should receive 0 arguments
• should return the strength property of the Viking

receiveDamage() method

(This method needs to be reimplemented for Viking because the Viking version needs to have different return values.)

• should be a function
• should receive 1 argument (the damage)
• should remove the received damage from the health property
• if the Viking is still alive, it should return "NAME has received DAMAGE points of damage"
• if the Viking dies, it should return "NAME has died in act of combat"

battleCry() method

Learn more about battle cries.

• should be a function
• should receive 0 arguments
• should return "Odin Owns You All!"

---

Saxon

A Saxon is a weaker kind of Soldier. Unlike a Viking, a Saxon has no name. Their receiveDamage() method will also be different than the original Soldier version.

Modify the Saxon, constructor function, have it inherit from Soldier and reimplement the receiveDamage() method for Saxon.

inheritance

• Saxon should inherit from Soldier

constructor function

• should receive 2 arguments (health & strength)
• should receive the health property as its 1st argument
• should receive the strength property as its 2nd argument

attack() method

(This method should be inherited from Soldier, no need to reimplement it.)

• should be a function
• should receive 0 arguments
• should return the strength property of the Saxon

receiveDamage() method

(This method needs to be reimplemented for Saxon because the Saxon version needs to have different return values.)

• should be a function
• should receive 1 argument (the damage)
• should remove the received damage from the health property
• if the Saxon is still alive, it should return "A Saxon has received DAMAGE points of damage"
• if the Saxon dies, it should return "A Saxon has died in combat"

---

War

Now we get to the good stuff: WAR! Our War constructor function will allow us to have a Viking army and a Saxon army that battle each other.

Modify the War constructor and add 5 methods to its prototype:

• addViking()
• addSaxon()
• vikingAttack()
• saxonAttack()
• showStatus()

constructor function

When we first create a War, the armies should be empty. We will add soldiers to the armies later.

• should receive 0 arguments
• should assign an empty array to the vikingArmy property
• should assign an empty array to the saxonArmy property

addViking() method

Adds 1 Viking to the vikingArmy. If you want a 10 Viking army, you need to call this 10 times.

• should be a function
• should receive 1 argument (a Viking object)
• should add the received Viking to the army
• shouldn't return anything

addSaxon() method

The Saxon version of addViking().

• should be a function
• should receive 1 argument (a Saxon object)
• should add the received Saxon to the army
• shouldn't return anything

vikingAttack() method

A Saxon (chosen at random) has their receiveDamage() method called with the damage equal to the strength of a Viking (also chosen at random). This should only perform a single attack and the Saxon doesn't get to attack back.

• should be a function
• should receive 0 arguments
• should make a Saxon receiveDamage() equal to the strength of a Viking
• should remove dead saxons from the army
• should return result of calling receiveDamage() of a Saxon with the strength of a Viking

saxonAttack() method

The Saxon version of vikingAttack(). A Viking receives the damage equal to the strength of a Saxon.

• should be a function
• should receive 0 arguments
• should make a Viking receiveDamage() equal to the strength of a Saxon
• should remove dead vikings from the army
• should return result of calling receiveDamage() of a Viking with the strength of a Saxon

showStatus() method

Returns the current status of the War based on the size of the armies.

• should be a function
• should receive 0 arguments
• if the Saxon array is empty, should return "Vikings have won the war of the century!"
• if the Viking array is empty, should return "Saxons have fought for their lives and survive another day..."
• if there are at least 1 Viking and 1 Saxon, should return "Vikings and Saxons are still in the thick of battle."

BONUS

Create a game using the classes you defined. For this, you will need to:

• Create a new file.py
• Import the classes you defined earlier
• Define functions to create the workflow of the game: i.e. functions to create teams (maybe you can create random teams with your classmates' names), run the game, etc.

Deliverables

• REQUIRED: vikingsClases.py modified with your solution to the challenge question.

Resources

• https://docs.python.org/3/library/unittest.html
• https://www.python-course.eu/python3_inheritance.php

Additional Challenge for the Nerds

You can try to make your own tests for your code by creating another test file.