Skip to content

Commit d0a4c05

Browse files
committed
Update Appendix.md
1 parent 9c7dd95 commit d0a4c05

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

docs/Appendix.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# **Appendix: Pythonic Best Practices**
22

3-
이 문서는 Python 프로젝트를 보다 효과적으로 관리하고 Pythonic한 코드를 작성하는 데 도움이 되는 여러 가지 권장 사항을 다룬다.
3+
Python 프로젝트를 보다 Pythonic하게 유지하기 위해 다음과 같은 권장 사항을 따르면 좋다.
4+
5+
- Poetry 또는 UV를 사용하여 Python 버전과 의존성을 관리한다.
6+
- 타입 힌트를 활용하여 코드의 가독성을 높인다.
7+
- Linter와 Formatter를 사용하여 코드 스타일을 유지한다.
8+
- `unittest`보다 `pytest`를 사용하여 간결한 테스트 코드를 작성한다.
9+
- Pythonic한 코딩 스타일을 유지하기 위해 리스트 컴프리헨션, f-string, 컨텍스트 매니저 등을 적극적으로 활용한다.
10+
11+
이러한 원칙을 따르면 코드의 유지보수성이 향상되고, 협업이 더욱 원활해질 것이다.
412

5-
## **1. Python 버전 및 프로젝트 관리 도구 사용**
13+
---
14+
15+
## **Python 버전 및 프로젝트 관리 도구 사용**
616

717
Python 프로젝트를 효율적으로 관리하려면 **Poetry** 또는 **UV**와 같은 Python 버전 및 패키지 관리 도구를 사용하는 것이 좋다.
818

@@ -16,7 +26,7 @@ poetry add requests # 패키지 추가
1626
poetry run python main.py # 가상 환경에서 실행
1727
```
1828

19-
## **2. 타입 힌트(Type Hints) 활용**
29+
## **타입 힌트(Type Hints) 활용**
2030

2131
Python은 동적 타입 언어이지만, **타입 힌트를 활용하면 코드의 가독성을 높이고 버그를 줄일 수 있다.**
2232
Python 3.5에서 도입.
@@ -33,7 +43,7 @@ def fetch_data(url: str) -> dict[str, str]:
3343
- 타입 힌트를 사용하면 코드 자동 완성과 정적 분석이 더 효과적으로 동작한다.
3444
- `mypy` 같은 정적 분석 도구를 사용하면 타입 관련 오류를 미리 감지할 수 있다.
3545

36-
## **3. 코드 스타일 유지: Linter 및 Formatter 사용**
46+
## **코드 스타일 유지: Linter 및 Formatter 사용**
3747

3848
일관된 코드 스타일을 유지하려면 **Linter****Formatter**를 활용하는 것이 중요하다.
3949

@@ -47,7 +57,7 @@ black my_script.py # 코드 자동 포맷팅
4757
flake8 my_script.py # 코드 스타일 검사
4858
```
4959

50-
## 4. `unittest` 대신 `pytest` 사용
60+
## **`unittest` 대신 `pytest` 사용**
5161

5262
Python의 기본 테스트 프레임워크인 `unittest`보다 **`pytest`**를 사용하는 것이 더 간편하고 강력하다.
5363

@@ -67,15 +77,3 @@ pytest test_example.py # 테스트 실행
6777

6878
- `pytest``assert` 문을 활용하여 간결한 테스트 작성이 가능하다.
6979
- 다양한 플러그인을 통해 테스트 기능을 확장할 수 있다.
70-
71-
---
72-
73-
Python 프로젝트를 보다 Pythonic하게 유지하기 위해 다음과 같은 권장 사항을 따르면 좋다.
74-
75-
- Poetry 또는 UV를 사용하여 Python 버전과 의존성을 관리한다.
76-
- 타입 힌트를 활용하여 코드의 가독성을 높인다.
77-
- Linter와 Formatter를 사용하여 코드 스타일을 유지한다.
78-
- `unittest`보다 `pytest`를 사용하여 간결한 테스트 코드를 작성한다.
79-
- Pythonic한 코딩 스타일을 유지하기 위해 리스트 컴프리헨션, f-string, 컨텍스트 매니저 등을 적극적으로 활용한다.
80-
81-
이러한 원칙을 따르면 코드의 유지보수성이 향상되고, 협업이 더욱 원활해질 것이다.

0 commit comments

Comments
 (0)