FIT9136 S1 2024 – 教育课程

Assignment 3 - The Runner's Assertion [20%]
作业 3 - 跑步者的断言 [20%]

Description 描述

[Task 1] - The Runners Are Here (20%)
[任务 1] - 跑步者在这里（20%）

You are NOT allowed to use try/except blocks in Task 1.
不允许在任务 1 中使用 try/except 块。

Task Setup 任务设置

In this part, you are given a class called Runner that contains a few instance variables and some class variables. The purpose of each of them is defined below:
在这一部分中，您将获得一个名为 Runner 的类，该类包含一些实例变量和一些类变量。它们中每个的目的定义如下：

max_energy (int) : The maximum energy of the runner (i.e., same for all runners).
max_energy （int）：流道的最大能量（即所有流道都相同）。
name (string): The name of a runner.
name （string）：运行器的名称。
age (int): The age of the runner.
age （int）：跑步者的年龄。
country (string): The country that the runner.
country （字符串）：跑步者所在的国家/地区。
energy (int): The current level of energy for the player. It starts at max energy.
energy （int）：玩家当前的能量水平。它从最大能量开始。
sprint_speed (float): The speed at which the runner runs when participating in a short race (in meters per second).
sprint_speed （float）：跑步者在参加短距离比赛时的奔跑速度（以米/秒为单位）。
endurance_speed (float) : The speed at which the runner runs when participating in a marathon (in meters per second).
endurance_speed （float）：跑步者在参加马拉松比赛时的跑步速度（以米/秒为单位）。

What has been given (with errors)
给出了什么（有错误）

The class also contains the following methods:
该类还包含以下方法：

__init__(self, name, age, country, sprint_speed, endurance_speed) : this method creates the runner with the attributes passed to the method. There are certain limitations to the attribute values:
__init__(self, name, age, country, sprint_speed, endurance_speed) ：此方法使用传递给该方法的属性创建运行器。属性值存在某些限制：
- name must be an alphanumeric string (can contain spaces),
  name 必须是字母数字字符串（可以包含空格），
- age must be an integer between 5 and 120 (both inclusive),
  age 必须是介于 5 和 120 之间的整数（包括两者），
- country must be a string and its value must be from the ones contained in the 'name' column of the csv countries.csv provided in the directory this file is currently being run,
  country 必须是字符串，并且其值必须来自当前运行此文件的目录中提供的 CSV countries.csv 的“name”列中包含的字符串，
  NOTE : You may assume that countries.csv always exists
  注意：您可以假设 countries.csv 始终存在
- sprint_speed must be a float and its value should lie between 2.2 and 6.8 in meters per second (both inclusive),
  sprint_speed 必须是浮点数，其值应介于 2.2 到 6.8 米/秒之间（包括两者），
- endurance_speed must be a float and its value should lie between 1.8 and 5.4 in meters per second (both inclusive).
  endurance_speed 必须是浮点数，其值应介于 1.8 到 5.4 米/秒之间（包括两者）。
drain_energy(self, drain_points) : this method gets an integer and drains the energy of the runner by the value of drain_points passed. The value of drain points cannot be less than 0 or more than the max_energy value of the runner. Also, the leftover energy of the player once the energy is drained cannot be less than 0. After this method concludes, the energy of the player should have been reduced by the value passed in the function.
drain_energy(self, drain_points) ：此方法获取一个整数，并通过传递的 drain_points 值消耗运行器的能量。排水点的值不能小于 0 或大于流道 max_energy 的值。此外，一旦能量耗尽，玩家的剩余能量不能小于0。此方法结束后，玩家的能量应该已经减少函数中传递的值。
recover_energy(self, recovery_amount) : this method gets an integer and recovers the energy of the player by the value of recovery_amount passed. The value of the energy of the player cannot exceed the maximum energy. If the energy of the player after adding recovery_amount goes over the max_energy then you should set the energy to the max_energy. You should also note that recovery_amount should not be more than max_energy.
recover_energy(self, recovery_amount) ：此方法获取一个整数，并通过 passed 的 recovery_amount 值恢复玩家的 energy 。玩家的值 energy 不能超过最大能量。 energy 如果添加 recovery_amount 后的播放器超过， max_energy 则应将 energy 设置为 max_energy .您还应该注意， recovery_amount 不应超过 max_energy 。
run_race(self, race_type, distance) -> float : this method takes in the race type (either "short" or "long" ) and distance (in kilometers) of the race and is a float value. It then returns the floating value of the time taken (in seconds; rounded to 2 decimal places) to complete the race. After this method concludes, there should be no change in the stats of the player. Please note that if the race is a short race, use the sprint speed of the runner. If the race is a marathon, then use the endurance speed of the runner.
run_race(self, race_type, distance) -> float ：此方法采用比赛的种族类型（或 "short" ） "long" 和距离（以公里为单位），并且是浮点值。然后，它返回完成比赛所用时间的浮点值（以秒为单位;四舍五入到小数点后 2 位）。此方法结束后，玩家的统计数据应该没有变化。请注意，如果比赛是短距离比赛，请使用跑步者的冲刺速度。如果比赛是马拉松，那么使用跑步者的耐力速度。
__str__(self) : this method just returns the details of the runner. You don't need to test this method.
__str__(self) ：此方法仅返回运行器的详细信息。您无需测试此方法。

Remember! You may need to validate the input that these methods receive and raise relevant errors. ~~You will also need to assert the post conditions of these methods, that are mentioned above.~~
记得！您可能需要验证这些方法接收的输入并引发相关错误。您还需要断言上述这些方法的 post 条件。

For You To Do 为你做

Most of the code has already been done for you. However, your TAs have become lazy and made code mistakes. :(
大部分代码已经为您完成。但是，您的助教变得懒惰并犯了代码错误。:(

You are tasked with the following:
您的任务如下：

Fix the errors made in the class, variables, and methods based on the descriptions mentioned above.
根据上述描述修复类、变量和方法中的错误。
Check the pre-conditions ~~and post-conditions~~ for each of the methods. Make sure to raise the relevant errors if incorrect values are passed to the functions.
检查每种方法的前置条件和后置条件。如果将不正确的值传递给函数，请确保引发相关错误。
Document your code including type-hinting for all variables, arguments for functions and methods, and relevant docstrings for each method and class.
记录您的代码，包括所有变量的类型提示、函数和方法的参数以及每个方法和类的相关文档字符串。
Build on the unit tests that have already been given to you in the file test_runner.py. You are expected to create at least three tests for each method. You should create these additional tests in a separate testing function in the given class.
基于文件中 test_runner.py 已提供给您的单元测试进行构建。应为每种方法创建至少三个测试。您应该在给定类的单独测试函数中创建这些附加测试。

Important Points 要点

Remember, it is YOUR RESPONSIBILITY to ensure that a proper custom error is raised when an invalid input is received. Here are some pointers:
请记住，您有责任确保在收到无效输入时引发正确的自定义错误。以下是一些提示：

If the value received by a method is invalid or not what the method expects, then you should raise a CustomValueError.
如果方法接收的值无效或不符合该方法的预期值，则应引发 CustomValueError .
If the type of value received by a method is invalid or not what the method expects, then you should raise a CustomTypeError.
如果方法接收的值类型无效或不符合方法的预期值，则应引发 CustomTypeError .
If the value being passed to the method is not an attribute of the class, then you should raise an CustomAttributeError.
如果传递给方法的值不是类的属性，则应引发 CustomAttributeError .
If the method is trying to get a value from a dictionary that shouldn't be returned, you should raise a CustomKeyError.
如果该方法尝试从字典中获取不应返回的值，则应引发 CustomKeyError .

Description 描述

test_runner.py

runner.py

/home/runner.py /首页/runner.py All changes saved 装载。。。

Console will be displayed here after running your code

Workspace 工作