파이썬 Naming Rule

 

프로그램을 작성함에 있어 변수나 파일의 이름을 짓는게 힘든 경우가 많다.

아마 프로그래밍 경험이 적거나 습관이 되지 않아서 일 것이다.

Naming Rule(네이밍 룰)은 코드의 가독성 및 일관성, 여러사람과의 협업을 위해서 꼭 필요하다.

표준적인 네이밍 룰을 사용하거나 협업을 위한 공통된 네이밍 룰을 만들어 놓는것이 중요하다.

 

PEP8(파이썬 코딩 스타일에 대한 가이드)을 참고하여 개인적인 작명법(네이밍룰)을 만들어 보았다.

정답은 없지만 가능하면 표준 스타일을 사용하는 것을 권장한다.

링크: http://pythonstudy.xyz/python/article/511-파이썬-코딩-스타일

 

 

(1) 함수명 
- 소문자 + 밑줄 
- 처음에는 기능의 의미가 들어가면 좋다.

get_company_list (Get_Company_List X)
get_today_prices (Get_today_prices X)
get_dates (GetDates X)
fetch_stockcode
prep_dataset
do_randomforest
test_classifier
send_log_to_slack
insert_target_stock
get_target_stock
insert, get, backtesting (INSERT X, Get X)

 

(2) 변수명 
- 소문자 + 밑줄

stock_code (가능하면 의미단위로 밑줄 나누기)
stock_name, kospi_url, db_name, table_name
base_stock_data
stock_code_list, code_list (리스트형의 경우 마지막 list 붙이기)
name_dict, company_dict (사전형의 경우 마지막 dict 붙이기)
df_kospi, df_credit_ratio (데이터프레임일경우 앞에 df_붙이기)
usernames 또는 user_names 또는 username_list (상황에 따라서 변형이 가능)
item, items, io, data (짧은 단어일수도)
pricematrix, priceday (꼭 밑줄을 쓸필요는 없다. 원하는대로)

 

(3) 전역변수명 
- g + 밑줄 + 변수명

g_stock_name
g_items

 

(4) 모듈명 (파일명) 
- 함수명규칙가 동일하나 최대한 짧은소문자로 이름짓는다. 

- 너무 일반적인 단어는 지양

naver_stock_crawl.py (Naver_Stock_Crawl.py X)
stock_data_parser.py
practice.py, tests.py (기존 파일명과 중복될 수 있으니 너무 일반적인 단어는 지양)

 

(5) 폴더명
- 모듈명규칙과 동일

ml_analyser (ML_analyser X)
bookmark, blog, myblog (단어 또는 합성단어)

(6) 클래스명 & Exception명
- CapWord(UpperCamelCase)를 적용, 단어는 모두 대문자로 시작
- 밑줄 사용하지말 것.

NaverStockPrice (Naver_Stock_Price X)
NaverHistPrice (Naverhistprice X)
DataSplit (Datasplit X, dataSplit X, DATASPLIT X)
Predictors
PtBuilder (PTBUILDER X)

 

(7) 상수
- 모두 대문자로 사용, 밑줄사용 가능 

WINDOW_SIZE
TIME_LAGS
PATH
DATA_PATH

 

 

마침.