What I Learn Today

Start Date : 2022/02/07 ~

창고/Meta PEPs (about PEPs or Processes)

[PEP 8 #1] PEP 8 - Python 코드에 대한 스타일 가이드라인

HannaDev 2022. 3. 11. 23:32
📬 PEP 8 이 무엇인지에 대한 설명입니다.

 

<PEP 8 시리즈> Index

  1. PEP 8 - Python 코드에 대한 스타일 가이드라인
  2. PEP 8 - Code Lay-out
  3. PEP 8 - 네이밍 작성 규칙
  4. PEP 8 - 프로그래밍 권장사항

<목차>

  1. Introduction
  2. A Foolish Consistency is the Hobgoblin of Little Minds

▶︎ Introduction

  • PEP 8 은 파이썬 코드의 작성규칙 (code convention) 에 대해 설명하는 문서이다.
    • 이 스타일 가이드는 추가 규칙이 식별되고 언어 자체의 변경으로 인해 과거 규칙이 더 이상 사용되지 않게 됨에 따라 시간이 지남에 따라 발전한다.
    • 많은 프로젝트에는 고유한 코딩 스타일 지침이 있다. 충돌이 있는 경우 해당 프로젝트에 대해 해당 프로젝트별 가이드가 우선 적용된다.
  • PEP 8 은 권장사항이지 절대적인 법칙은 아니다.

▶︎ A Foolish Consistency is the Hobgoblin of Little Minds

  • Guido 의 주요 통찰력 중 하나는 코드가 작성된 것보다 훨씬 더 자주 읽혀진다는 것이다.
  • 여기에 제공된 지침은 코드의 가독성을 개선하고 광범위한 Python 코드에서 일관성을 유지하기 위한 것이다.
  • PEP 20 에서 말했듯이 “가독성이 중요하다”.
  • 일관성 중요도 (높음 → 낮음)
    • 하나의 모듈 또는 기능 내에서의 일관성
    • 프로젝트 내에서의 일관성
    • PEP 8 스타일 가이드와의 일관성
  • 특정 지침을 무시해야하는 다른 좋은 이유
    1. 지침을 적용하면 이 PEP 를 따르는 코드를 읽는데 익숙한 사람이라도 코드 가독성이 떨어질 때.
    2. (아마도 역사적인 이유로 인해) 코드를 깨뜨리기도 하는 주변 코드와의 일관성을 유지하기 위해.
    3. 문제의 코드는 지침의 도입보다 이전에 있었고 해당 코드를 수정할 다른 이유가 없는 경우.
    4. 과거 버전의 파이썬으로 작성된 코드가 PEP 8 을 준수할 경우 작동하지 않아 과거 버전과 호환될 필요가 있을 경우.

대표이미지용