From eccd9c348459a6cf4400d196f6144ed6c2181380 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Schr=C3=B6der?=
<fschroeder@techfak.uni-bielefeld.de>
Date: Mon, 4 Mar 2024 11:21:12 +0100
Subject: [PATCH] Refactor argument naming and method signatures
Modified url_and_port_arguments to follow cli args standards in cooperative_cuisine/utils.py, changing '-study' to '-s' and '-game' to '-g'. Adjusted the placement of 'player' argument in the methods in cooperative_cuisine/counters.py. Also, refactored the method _do_single_tool_interaction to be a static method.
---
cooperative_cuisine/counters.py | 6 +++---
cooperative_cuisine/utils.py | 5 ++---
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/cooperative_cuisine/counters.py b/cooperative_cuisine/counters.py
index 04ee69c6..2853e59e 100644
--- a/cooperative_cuisine/counters.py
+++ b/cooperative_cuisine/counters.py
@@ -181,7 +181,6 @@ class Counter:
Args:
item: The item for which to check, if it can be placed on the counter.
- player: The player name that tries to drop something on the counter.
Returns: True if the item can be placed on the counter, False if not.
@@ -194,7 +193,7 @@ class Counter:
Args:
item: The item to be placed on the counter.
-
+ player: The player name that tries to drop something on the counter.
Returns:
Item or None what should be put back on the players hand, e.g., the cooking equipment.
@@ -232,8 +231,9 @@ class Counter:
if not successful:
self._do_single_tool_interaction(passed_time, tool, self)
+ @staticmethod
def _do_single_tool_interaction(
- self, passed_time: timedelta, tool: Item, target: Item | Counter
+ passed_time: timedelta, tool: Item, target: Item | Counter
) -> bool:
suitable_effects = [
e for e in target.active_effects if e.name in tool.item_info.needs
diff --git a/cooperative_cuisine/utils.py b/cooperative_cuisine/utils.py
index 7d57d5c6..d6e0bfdb 100644
--- a/cooperative_cuisine/utils.py
+++ b/cooperative_cuisine/utils.py
@@ -191,9 +191,8 @@ def setup_logging(enable_websocket_logging=False):
def url_and_port_arguments(
parser, server_name="game server", default_study_port=8080, default_game_port=8000
):
- # TODO follow cli args standards: https://askubuntu.com/questions/711702/when-are-command-options-prefixed-with-two-hyphens
parser.add_argument(
- "-study",
+ "-s",
"--study-url",
"--study-host",
type=str,
@@ -208,7 +207,7 @@ def url_and_port_arguments(
help=f"Port number for the {server_name}",
)
parser.add_argument(
- "-game",
+ "-g",
"--game-url",
"--game-host",
type=str,
--
GitLab