나만의 코드 규칙 정립

요약 코드 규칙

• 파이썬에서 네이밍 컨벤션(변수 이름) PEP 8 으로 한다.
• 타입헌팅을 통해 선언해, 가독성, 유지보수 높인다.
• 변수 어노테이션 통해 선언해, 가독성, 유지보수 높인다.

PEP 8

• 자세한 내용 : https://peps.python.org/pep-0008/
• 들여쓰기 규칙은 VS코드 쓰면 자동으로 조정됨
• 코드 작성 후 black, YAPF 모듈을 통한 자동 수정

  pip install black
  black your_script.py

타입헌팅

• 파이썬은 자료형을 선언 안해도 되는데, 자료형을 선언하는걸 타입헌팅이라고 함
• 함수 타입헌팅 (PEP 484) 변수 어노테이션(PEP 526)
• 정적 타입 검사 도구(MyPy 등)와 통합하여 코드에서 타입 관련 오류를 미리 발견할 수 있습니다

변수 이름 규칙

• 경로 변수는 앞에 path_ 첨자를 붙인다.(그래야 덜 헷갈린다)

 
 

의존성 고려 설계 사례

1. 여러 방법중 첫번째 작업에 영향을 받도록 설계

• 파이프라인 작성시 airflow를 이용해 (작업목적에 따라) 여러 스크립트를 실행하게 했다.
• 여러 스크립트로 나눈 이유는 실패 지점을 정확히 알기위해였다.
• 첫번째 실행 스크립트에서 다운받은 파일 목록을 json에 저장했다.
• 두번째 실행 스크립트에서 다운 목록으로 작업을 해야했다.
• 다운 목록을 불러오는 방법은 두개(json 읽기, 실제 파일목록읽기)
• json 읽기로 선택 : 첫번째 실행(json 저장)이 실패했을때, 두번째도 실패해야 한다고 생각했다.
• 더 생각해볼것 : json 리스트와 파일목록과 일치를 확인하는 테스트 코드가 필요할까?