Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[자동차 경주] 원영진 과제 제출합니다. #5

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

[자동차 경주] 원영진 과제 제출합니다. #5

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d940bdb
feat: racingcar 초기 모델
AI-WonYJ Feb 10, 2025
6777750
style: trailing-whitespace 제거
AI-WonYJ Feb 10, 2025
9fe0556
style: PEP8 Style로 코드 변경
AI-WonYJ Feb 10, 2025
3f62a82
style: PEP8 Style로 코드 변경
AI-WonYJ Feb 10, 2025
861042a
fix: is_number()함수 기능 오류 해결
AI-WonYJ Feb 10, 2025
03da6a4
refactor: 게임 실행 결과 출력 기능 분리
AI-WonYJ Feb 12, 2025
d85918f
refactor: Change parameter to lowercase
AI-WonYJ Feb 12, 2025
0965297
fix: Add validation for empty names
AI-WonYJ Feb 12, 2025
5126876
refactor: Write variable names more clearly
AI-WonYJ Feb 12, 2025
094c440
refactor: Write variable names more clearly
AI-WonYJ Feb 12, 2025
67c5fa0
fix: Add validation for number of attempts
AI-WonYJ Feb 12, 2025
e82f4d5
refactor: Change to magic number constant & PEP8 Style
AI-WonYJ Feb 12, 2025
57d31a6
refactor: Change to PEP8 Style
AI-WonYJ Feb 12, 2025
54e5d17
refactor: Change the validation method for entering of attempts
AI-WonYJ Feb 13, 2025
7d5ff05
refactor: Separater car name input function
AI-WonYJ Feb 13, 2025
48ac549
docs: Write functional documentation
AI-WonYJ Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 60 additions & 1 deletion src/racingcar/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,69 @@
import random

def is_number (Data):
"""
Data가 숫자인지 확인하는 함수.
숫자가 아니면 ValueError를 발생시킴.
"""
try:
str(Data) # Data가 int 형식인지 확인
except ValueError as e:
raise ValueError("숫자만 입력해주세요.") from e # 숫자가 아닌 값 입력시 예외 처리

Check warning on line 11 in src/racingcar/main.py

View check run for this annotation

Codecov / codecov/patch

src/racingcar/main.py#L10-L11 

Added lines #L10 - L11 were not covered by tests
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

함수 로직과 스타일 개선이 필요합니다.

다음과 같은 문제점들이 있습니다:

  1. 숫자 검증 로직이 부적절합니다 - str()은 문자열 변환만 확인하고 실제 숫자 여부는 확인하지 않습니다
  2. PEP8 스타일 가이드를 준수하지 않습니다

아래와 같이 수정해주세요:

-def is_number (Data):
+def is_number(data):
     """
     Data가 숫자인지 확인하는 함수.
     숫자가 아니면 ValueError를 발생시킴.
     """
     try:
-        str(Data)  # Data가 int 형식인지 확인
+        int(data)  # 문자열을 정수로 변환 시도
     except ValueError as e:
         raise ValueError("숫자만 입력해주세요.") from e
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
def is_number (Data):
"""
Data가 숫자인지 확인하는 함수.
숫자가 아니면 ValueError를 발생시킴.
"""
try:
str(Data) # Data가 int 형식인지 확인
except ValueError as e:
raise ValueError("숫자만 입력해주세요.") from e # 숫자가 아닌 값 입력시 예외 처리
def is_number(data):
"""
Data가 숫자인지 확인하는 함수.
숫자가 아니면 ValueError를 발생시킴.
"""
try:
int(data) # 문자열을 정수로 변환 시도
except ValueError as e:
raise ValueError("숫자만 입력해주세요.") from e
🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 10-11: src/racingcar/main.py#L10-L11
Added lines #L10 - L11 were not covered by tests

🪛 GitHub Actions: Check PEP8 Style

[error] 3-3: E302 expected 2 blank lines, found 1

[error] 3-3: E211 whitespace before '('


def validate_input(Data):
for i in range(len(Data)):
if len(Data[i]) > 5:
raise ValueError("이름은 5자 이하만 가능합니다.")
Data[i] = [Data[i], 0]
return Data
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

입력 검증 로직을 개선해주세요.

현재 구현에서 개선이 필요한 부분들이 있습니다:

  1. 빈 입력이나 빈 이름에 대한 검증이 없습니다
  2. 파이썬스러운 방식으로 개선할 수 있습니다

다음과 같이 수정을 제안합니다:

 def validate_input(Data):
+    if not Data:
+        raise ValueError("자동차 이름을 입력해주세요.")
+    
-    for i in range(len(Data)):
-        if len(Data[i]) > 5:
+    for name in Data:
+        if not name.strip():
+            raise ValueError("빈 이름은 허용되지 않습니다.")
+        if len(name) > 5:
             raise ValueError("이름은 5자 이하만 가능합니다.")
-        Data[i] = [Data[i], 0]
-    return Data
+    return [[name, 0] for name in Data]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
def validate_input(Data):
for i in range(len(Data)):
if len(Data[i]) > 5:
raise ValueError("이름은 5자 이하만 가능합니다.")
Data[i] = [Data[i], 0]
return Data
def validate_input(Data):
if not Data:
raise ValueError("자동차 이름을 입력해주세요.")
for name in Data:
if not name.strip():
raise ValueError("빈 이름은 허용되지 않습니다.")
if len(name) > 5:
raise ValueError("이름은 5자 이하만 가능합니다.")
return [[name, 0] for name in Data]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

빈 이름에 대한 검증이 힘들 것 같네요.


def try_input():
print("시도할 횟수는 몇 회인가요?")
n = input()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코딩테스트가 아닌 경우에는 변수명을 더 명확히 작성해주는 것이 좋습니다.

is_number(n)
return int(n)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

시도 횟수 검증을 강화해주세요.

시도 횟수에 대한 추가 검증이 필요합니다:

  1. 음수나 0 입력 방지
  2. 최대 시도 횟수 제한

다음과 같이 수정을 제안합니다:

 def try_input():
     print("시도할 횟수는 몇 회인가요?")
     n = input()
     is_number(n)
-    return int(n)
+    n = int(n)
+    if n <= 0:
+        raise ValueError("시도 횟수는 1 이상이어야 합니다.")
+    if n > 100:  # 적절한 상한선 설정
+        raise ValueError("시도 횟수가 너무 많습니다. (최대: 100)")
+    return n
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
def try_input():
print("시도할 횟수는 몇 회인가요?")
n = input()
is_number(n)
return int(n)
def try_input():
print("시도할 횟수는 몇 회인가요?")
n = input()
is_number(n)
n = int(n)
if n <= 0:
raise ValueError("시도 횟수는 1 이상이어야 합니다.")
if n > 100: # 적절한 상한선 설정
raise ValueError("시도 횟수가 너무 많습니다. (최대: 100)")
return n

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

시도 횟수에 대한 추가 검증이 있다면 좋을 것 같네요.


def play_1set_of_game(Data):
for i in range(len(Data)):
value = random.randint(0, 10)
if value >= 4:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

숫자상수는, 매직넘버상수로 바꾸고 전방선언 해주는 것이 좋습니다.

Data[i][1] += 1
return Data
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

상수 정의와 Python 스타일을 개선해주세요.

  1. 매직 넘버를 상수로 정의해주세요
  2. Python 스타일의 반복문을 사용해주세요
  3. 함수 이름을 더 명확하게 해주세요
+# 상수 정의
+RANDOM_MAX = 10
+FORWARD_THRESHOLD = 4
+
-def play_1set_of_game(Data):
+def play_game_round(cars):
-    for i in range(len(Data)):
-        value = random.randint(0, 10)
-        if value >= 4:
-            Data[i][1] += 1
-    return Data
+    for car in cars:
+        if random.randint(0, RANDOM_MAX) >= FORWARD_THRESHOLD:
+            car[1] += 1
+    return cars
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
def play_1set_of_game(Data):
for i in range(len(Data)):
value = random.randint(0, 10)
if value >= 4:
Data[i][1] += 1
return Data
RANDOM_MAX = 10
FORWARD_THRESHOLD = 4
def play_game_round(cars):
for car in cars:
if random.randint(0, RANDOM_MAX) >= FORWARD_THRESHOLD:
car[1] += 1
return cars


def check_winner(Data):
win_list, winner_count = list(), 0
for i in range(len(Data)):
if Data[i][1] > winner_count:
win_list, winner_count = [Data[i][0]], Data[i][1]
elif Data[i][1] == winner_count:
win_list.append(Data[i][0])

Check warning on line 39 in src/racingcar/main.py

View check run for this annotation

Codecov / codecov/patch

src/racingcar/main.py#L39 

Added line #L39 was not covered by tests
return win_list


def main():
"""
프로그램의 진입점 함수.
여기에서 전체 프로그램 로직을 시작합니다.
"""
# 프로그램의 메인 로직을 여기에 구현
print("프로그램이 시작되었습니다.")
print("경주할 자동차 이름을 입력하세요.(이름은 쉼표로 구분)")
name_list = validate_input(list(map(str, input().split(","))))
n = try_input()
print()
print("실행 결과")

for i in range(n):
name_list = play_1set_of_game(name_list)
for i in range(len(name_list)):
print("{0} : {1}".format(name_list[i][0], "-" * name_list[i][1]))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

함수로 바꾸는 게 더 가독성이 좋을 것 같습니다.

print()

win_list = check_winner(name_list)

print("최종 우승자 : {0}".format(', '.join(win_list)))

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

메인 함수의 개선이 필요합니다.

  1. 에러 처리가 누락되었습니다
  2. 출력 메시지가 더 상세할 수 있습니다
  3. 불필요한 공백 라인이 있습니다

아래와 같이 수정을 제안합니다:

 def main():
     """
     프로그램의 진입점 함수.
     여기에서 전체 프로그램 로직을 시작합니다.
     """
-    # 프로그램의 메인 로직을 여기에 구현
-    print("경주할 자동차 이름을 입력하세요.(이름은 쉼표로 구분)")
-    name_list = validate_input(list(map(str, input().split(","))))
-    n = try_input()
-    print()
-    print("실행 결과")
+    try:
+        print("경주할 자동차 이름을 입력하세요 (이름은 쉼표로 구분)")
+        name_list = validate_input(list(map(str, input().strip().split(","))))
+        
+        n = try_input()
+        print("\n실행 결과")
 
-    for i in range(n):
-        name_list = play_1set_of_game(name_list)
-        for i in range(len(name_list)):
-            print("{0} : {1}".format(name_list[i][0], "-" * name_list[i][1]))
-        print()
+        for _ in range(n):
+            name_list = play_game_round(name_list)
+            for name, score in name_list:
+                print(f"{name} : {'-' * score}")
+            print()
 
-    win_list = check_winner(name_list)
-       
-    print("최종 우승자 : {0}".format(', '.join(win_list)))
+        win_list = check_winner(name_list)
+        print(f"최종 우승자 : {', '.join(win_list)}")
+    except ValueError as e:
+        print(f"오류: {e}")
+        return 1
+    return 0
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
def main():
"""
프로그램의 진입점 함수.
여기에서 전체 프로그램 로직을 시작합니다.
"""
# 프로그램의 메인 로직을 여기에 구현
print("프로그램이 시작되었습니다.")
print("경주할 자동차 이름을 입력하세요.(이름은 쉼표로 구분)")
name_list = validate_input(list(map(str, input().split(","))))
n = try_input()
print()
print("실행 결과")
for i in range(n):
name_list = play_1set_of_game(name_list)
for i in range(len(name_list)):
print("{0} : {1}".format(name_list[i][0], "-" * name_list[i][1]))
print()
win_list = check_winner(name_list)
print("최종 우승자 : {0}".format(', '.join(win_list)))
def main():
"""
프로그램의 진입점 함수.
여기에서 전체 프로그램 로직을 시작합니다.
"""
try:
print("경주할 자동차 이름을 입력하세요 (이름은 쉼표로 구분)")
name_list = validate_input(list(map(str, input().strip().split(","))))
n = try_input()
print("\n실행 결과")
for _ in range(n):
name_list = play_game_round(name_list)
for name, score in name_list:
print(f"{name} : {'-' * score}")
print()
win_list = check_winner(name_list)
print(f"최종 우승자 : {', '.join(win_list)}")
except ValueError as e:
print(f"오류: {e}")
return 1
return 0
🧰 Tools
🪛 GitHub Actions: Check Indentation Depth

[warning] 62-62: Trailing whitespace

🪛 GitHub Actions: Check PEP8 Style

[warning] 62-62: W293 blank line contains whitespace





if __name__ == "__main__":
Expand Down
Loading