1. 간결함

• README에서 샘플 코드 제공
• 보일러 플레이트 코드 줄이기: 처음으로 유용한 API를 호출하는 코드까지의 라인수 세어보기
• 유즈케이스 문서화하기
• 단계적인 정보 공개 실천: 타당한 기본값(default) 사용
• 다루기 번거로운 입력(input)은 지양하기
• 최대한 사용자를 놀라게하지 말아야한다 (POLA, Principle of least astonishment) 법칙 따르기: "만약 어떤 기능이 예상치 못한 일을 많이 일으킨다면, 이는 재설계가 필요할 수도 있다"
• 추상화
• 파이썬답게 (Be Pythonic)

2. 일관성

• 네이밍: 네이밍에 일관성이 있는지 확인
  • 단어 순서: string_encode vs decode_string.
  • 축약어: activate_prev vs fetch_previous, bin2hex vs strtolower.
  • 언더스코어 여부: gettype vs get_class
  • 복수형: values_list vs value_list
  • 부정형: button.enabled == True vs button.disabled == True
• 빈 값: 빈 값의 의미에 일관성이 있는가? 그게 최선의 표현인가?
  • 빈 값으로 무엇을 사용할지 결정하라: None, False, [], '', 0 등
  • 예기치 않은 false 값에 주의하라 : Python < 3.5에서는 bool(datetime.time(0)) == False가 성립
• 파라미터: 파라미터의 순서에 일관성이 있는가?
  • 예시: datetime.datetime(year, month, day, minute, second, microsecond) vs datetime.timedelta(days, seconds, microseconds, milliseconds, minutes, hours, weeks)
• 동작: 유사한 동작은 유사하게 표현되고 다른 동작은 다르게 표현되고 있는가? 동작의 비대칭성은 비대칭적 형태로 반영되어야한다.
  • 좋은 예시: 제자리 정렬 numbers.sort() vs 비제자리 정렬 sorted(numbers)

3. 유연함

• 통합의 불연속성 줄이기
• 추상화
• 파이썬답게 (Be Pythonic)
• 최종 사용자가 볼 문자열을 국제화(I18N, Internationalization)하라

4. 안전성

• 기능의 동작을 설명하는 문서에 "warning", "careful", "remember to", "don't forget"과 같이 주의하라는 단어가 있는지 확인. 만약 그렇다면, 해당 기능을 좀 더 안전하게 변경할 수는 없는지 고려해보라
• 일반적인 실수를 감지하고 이들에 대한 warning을 로깅하기 위해 Python의 빌트인 모듈인 warnings을 사용하라
• 안전하지 않은 동작을 명시적으로 드러나게끔 요구하라
  • 무언가가 설정되지 않은 경우엔 모두 표시하지 말아라. 예를 들어 fields = None은 모든 필드를 의미하지는 않는다
• 코드를 암시적으로 이름이나 모듈로 연결하지 말고, 레지스트리나 레지스트리 데코레이터를 사용하라
  • 예시: django-admin의 registry는 함수를 사용한 등록과 데코레이터를 사용한 등록 모두를 지원한다
• 메서드 호출 순서에 의존하는것을 지양하고 대신 with문 컨텍스트를 사용하라
• 빠른 실패
  • 라이브러리가 오버플로우, 형식이 잘못되었거나 잘못된 상태와 같은 잘못된 인자를 받으면 ValueError 예외를 발생시켜라
  • 라이브러리가 호환되지 않는 타입의 인자를 받으면 TypeError 예외를 발생시켜라. 다만, 내부에 if isinstance(duck, LibDuck)이나 if type(duck) == LibDuck와 같은 코드를 넣지 말고 먼저 기대하는 타입이 가진 메서드를 실행해보고 에러가 나면 TypeError 예외를 발생시켜라

5. 결론

• 내 API는 간단한걸 쉽게 만들고 복잡한걸 가능케하며 잘못된건 불가능하게 한다