WeniVooks

# 좋은 예시
user_name = "홍길동"
total_count = 100
MAX_CONNECTIONS = 50
 
def calculate_total(items):
    pass
 
class UserProfile:
    pass
 
# 나쁜 예시
userName = "홍길동"      # camelCase는 변수에 사용하지 않음
TotalCount = 100         # PascalCase는 클래스에만 사용
max_connections = 50     # 상수는 대문자로

# 좋은 예시
user_name = "홍길동"
total_count = 100
MAX_CONNECTIONS = 50
 
def calculate_total(items):
    pass
 
class UserProfile:
    pass
 
# 나쁜 예시
userName = "홍길동"      # camelCase는 변수에 사용하지 않음
TotalCount = 100         # PascalCase는 클래스에만 사용
max_connections = 50     # 상수는 대문자로

# 좋은 예시
def function(arg1, arg2):
    result = arg1 + arg2
    return result
 
my_list = [1, 2, 3]
my_dict = {'key': 'value'}
 
if x == 4:
    print(x)
 
# 나쁜 예시
def function( arg1 , arg2 ):  # 괄호 안쪽 공백
    result=arg1+arg2          # 연산자 주변 공백 없음
    return result
 
my_list = [ 1,2,3 ]           # 일관성 없는 공백
my_dict = { 'key' : 'value' } # 불필요한 공백

# 좋은 예시
def function(arg1, arg2):
    result = arg1 + arg2
    return result
 
my_list = [1, 2, 3]
my_dict = {'key': 'value'}
 
if x == 4:
    print(x)
 
# 나쁜 예시
def function( arg1 , arg2 ):  # 괄호 안쪽 공백
    result=arg1+arg2          # 연산자 주변 공백 없음
    return result
 
my_list = [ 1,2,3 ]           # 일관성 없는 공백
my_dict = { 'key' : 'value' } # 불필요한 공백

# 좋은 예시
import os
import sys
 
import requests
import numpy as np
 
from my_module import my_function
 
 
class MyClass:
    """클래스 설명"""
 
    def method_one(self):
        pass
 
    def method_two(self):
        pass
 
 
def standalone_function():
    pass

# 좋은 예시
import os
import sys
 
import requests
import numpy as np
 
from my_module import my_function
 
 
class MyClass:
    """클래스 설명"""
 
    def method_one(self):
        pass
 
    def method_two(self):
        pass
 
 
def standalone_function():
    pass

# 파이썬의 철학 확인하기
import this

# 파이썬의 철학 확인하기
import this

# 나쁜 주석 - 코드가 이미 설명하고 있는 내용
x = x + 1  # x에 1을 더한다
 
# 좋은 주석 - 왜 이 코드가 필요한지 설명
x = x + 1  # 0-based 인덱스를 1-based로 변환 (사용자 표시용)
 
# 나쁜 주석 - 명백한 내용
def get_user(user_id):
    # 사용자를 가져온다
    return db.query(User).get(user_id)
 
# 좋은 주석 - 비즈니스 로직 설명
def get_user(user_id):
    # 탈퇴 회원도 포함하여 조회 (관리자 기능)
    return db.query(User).get(user_id)

# 나쁜 주석 - 코드가 이미 설명하고 있는 내용
x = x + 1  # x에 1을 더한다
 
# 좋은 주석 - 왜 이 코드가 필요한지 설명
x = x + 1  # 0-based 인덱스를 1-based로 변환 (사용자 표시용)
 
# 나쁜 주석 - 명백한 내용
def get_user(user_id):
    # 사용자를 가져온다
    return db.query(User).get(user_id)
 
# 좋은 주석 - 비즈니스 로직 설명
def get_user(user_id):
    # 탈퇴 회원도 포함하여 조회 (관리자 기능)
    return db.query(User).get(user_id)

def calculate_area(radius):
    """
    원의 면적을 계산하는 함수.
 
    파라미터:
        radius (float): 원의 반지름
 
    반환값:
        float: 원의 면적
 
    예시:
        >>> calculate_area(5)
        78.53981633974483
    """
    return 3.14159 * radius * radius
 
# 함수 사용 예시
area = calculate_area(5)
print("Area:", area)

def calculate_area(radius):
    """
    원의 면적을 계산하는 함수.
 
    파라미터:
        radius (float): 원의 반지름
 
    반환값:
        float: 원의 면적
 
    예시:
        >>> calculate_area(5)
        78.53981633974483
    """
    return 3.14159 * radius * radius
 
# 함수 사용 예시
area = calculate_area(5)
print("Area:", area)

# 나쁜 예시 - 매직 넘버 사용
if user.age >= 19:
    allow_adult_content()
 
if retry_count > 3:
    raise MaxRetryError()
 
discount = price * 0.15
 
# 좋은 예시 - 의미 있는 상수 사용
ADULT_AGE = 19
MAX_RETRY_COUNT = 3
DISCOUNT_RATE = 0.15
 
if user.age >= ADULT_AGE:
    allow_adult_content()
 
if retry_count > MAX_RETRY_COUNT:
    raise MaxRetryError()
 
discount = price * DISCOUNT_RATE

# 나쁜 예시 - 매직 넘버 사용
if user.age >= 19:
    allow_adult_content()
 
if retry_count > 3:
    raise MaxRetryError()
 
discount = price * 0.15
 
# 좋은 예시 - 의미 있는 상수 사용
ADULT_AGE = 19
MAX_RETRY_COUNT = 3
DISCOUNT_RATE = 0.15
 
if user.age >= ADULT_AGE:
    allow_adult_content()
 
if retry_count > MAX_RETRY_COUNT:
    raise MaxRetryError()
 
discount = price * DISCOUNT_RATE

# 일관성 있는 따옴표 사용 (홑따옴표 스타일)
name = 'hello'
message = 'world'
 
# 일관성 있는 따옴표 사용 (쌍따옴표 스타일)
name = "hello"
message = "world"
 
# 문자열 안에 따옴표가 있는 경우
message = "It's a beautiful day"  # 내부에 홑따옴표
html = '<div class="container">'  # 내부에 쌍따옴표

# 일관성 있는 따옴표 사용 (홑따옴표 스타일)
name = 'hello'
message = 'world'
 
# 일관성 있는 따옴표 사용 (쌍따옴표 스타일)
name = "hello"
message = "world"
 
# 문자열 안에 따옴표가 있는 경우
message = "It's a beautiful day"  # 내부에 홑따옴표
html = '<div class="container">'  # 내부에 쌍따옴표

# 나쁜 예시 - 너무 넓은 범위와 일반적인 예외
try:
    data = load_data()
    processed = process_data(data)
    result = calculate(processed)
    save_result(result)
except Exception as e:
    print("에러 발생")
 
# 좋은 예시 - 적절한 범위와 구체적인 예외
try:
    data = load_data()
except FileNotFoundError as e:
    logging.error(f"데이터 파일을 찾을 수 없습니다: {e}")
    raise
 
try:
    result = calculate(data)
except ValueError as e:
    logging.error(f"계산 중 오류 발생: {e}")
    raise
 
# 사용자 정의 예외 사용
class DataValidationError(Exception):
    """데이터 검증 실패 예외"""
    pass
 
def validate_data(data):
    if not data:
        raise DataValidationError("데이터가 비어있습니다")

# 나쁜 예시 - 너무 넓은 범위와 일반적인 예외
try:
    data = load_data()
    processed = process_data(data)
    result = calculate(processed)
    save_result(result)
except Exception as e:
    print("에러 발생")
 
# 좋은 예시 - 적절한 범위와 구체적인 예외
try:
    data = load_data()
except FileNotFoundError as e:
    logging.error(f"데이터 파일을 찾을 수 없습니다: {e}")
    raise
 
try:
    result = calculate(data)
except ValueError as e:
    logging.error(f"계산 중 오류 발생: {e}")
    raise
 
# 사용자 정의 예외 사용
class DataValidationError(Exception):
    """데이터 검증 실패 예외"""
    pass
 
def validate_data(data):
    if not data:
        raise DataValidationError("데이터가 비어있습니다")

# 설치
pip install black
 
# 파일 포매팅
black my_file.py
 
# 디렉토리 전체 포매팅
black my_project/
 
# 변경 사항 미리보기 (실제 변경 없음)
black --diff my_file.py
 
# 검사만 수행 (CI/CD용)
black --check my_project/

# 설치
pip install black
 
# 파일 포매팅
black my_file.py
 
# 디렉토리 전체 포매팅
black my_project/
 
# 변경 사항 미리보기 (실제 변경 없음)
black --diff my_file.py
 
# 검사만 수행 (CI/CD용)
black --check my_project/

# 설치
pip install flake8
 
# 검사 실행
flake8 my_file.py
 
# 특정 규칙 무시
flake8 --ignore=E501 my_file.py
 
# 최대 라인 길이 설정
flake8 --max-line-length=100 my_file.py

# 설치
pip install flake8
 
# 검사 실행
flake8 my_file.py
 
# 특정 규칙 무시
flake8 --ignore=E501 my_file.py
 
# 최대 라인 길이 설정
flake8 --max-line-length=100 my_file.py

[tool.black]
line-length = 88
target-version = ['py39']
include = '\.pyi?$'
exclude = '''
/(
    \.git
    | \.venv
    | build
    | dist
)/
'''
 
[tool.isort]
profile = "black"
line_length = 88
 
[tool.mypy]
python_version = "3.9"
warn_return_any = true
warn_unused_configs = true

[tool.black]
line-length = 88
target-version = ['py39']
include = '\.pyi?$'
exclude = '''
/(
    \.git
    | \.venv
    | build
    | dist
)/
'''
 
[tool.isort]
profile = "black"
line_length = 88
 
[tool.mypy]
python_version = "3.9"
warn_return_any = true
warn_unused_configs = true

[flake8]
max-line-length = 88
extend-ignore = E203, W503
exclude = .git,__pycache__,build,dist

[flake8]
max-line-length = 88
extend-ignore = E203, W503
exclude = .git,__pycache__,build,dist

# 변수 타입 힌트
name: str = "홍길동"
age: int = 25
is_active: bool = True
score: float = 95.5
 
# 함수 타입 힌트
def greet(name: str) -> str:
    return f"안녕하세요, {name}님!"
 
def add(a: int, b: int) -> int:
    return a + b
 
# 선택적 매개변수
from typing import Optional
 
def get_user(user_id: int, include_deleted: bool = False) -> Optional[dict]:
    # user를 찾지 못하면 None 반환
    pass

# 변수 타입 힌트
name: str = "홍길동"
age: int = 25
is_active: bool = True
score: float = 95.5
 
# 함수 타입 힌트
def greet(name: str) -> str:
    return f"안녕하세요, {name}님!"
 
def add(a: int, b: int) -> int:
    return a + b
 
# 선택적 매개변수
from typing import Optional
 
def get_user(user_id: int, include_deleted: bool = False) -> Optional[dict]:
    # user를 찾지 못하면 None 반환
    pass

from typing import List, Dict, Tuple, Union, Callable
 
# 리스트
numbers: List[int] = [1, 2, 3]
names: List[str] = ["Alice", "Bob"]
 
# 딕셔너리
user: Dict[str, str] = {"name": "홍길동", "email": "hong@example.com"}
scores: Dict[str, int] = {"math": 100, "english": 95}
 
# 튜플
point: Tuple[int, int] = (10, 20)
record: Tuple[str, int, bool] = ("Alice", 25, True)
 
# Union (여러 타입 중 하나)
value: Union[int, str] = 42  # int 또는 str
 
# Python 3.10+ 에서는 | 사용 가능
value: int | str = 42
 
# Callable (함수 타입)
def apply(func: Callable[[int, int], int], a: int, b: int) -> int:
    return func(a, b)

from typing import List, Dict, Tuple, Union, Callable
 
# 리스트
numbers: List[int] = [1, 2, 3]
names: List[str] = ["Alice", "Bob"]
 
# 딕셔너리
user: Dict[str, str] = {"name": "홍길동", "email": "hong@example.com"}
scores: Dict[str, int] = {"math": 100, "english": 95}
 
# 튜플
point: Tuple[int, int] = (10, 20)
record: Tuple[str, int, bool] = ("Alice", 25, True)
 
# Union (여러 타입 중 하나)
value: Union[int, str] = 42  # int 또는 str
 
# Python 3.10+ 에서는 | 사용 가능
value: int | str = 42
 
# Callable (함수 타입)
def apply(func: Callable[[int, int], int], a: int, b: int) -> int:
    return func(a, b)