프로그래밍 언어/python

보기 좋은 쉼표 배치

이현찬 2022. 7. 26. 21:18
728x90

이 글은 슬기로운 파이썬 트릭의 내용을 정리한 글입니다.

2.2 보기 좋은 쉼표배치

  • 파이썬의 리스트, 딕셔너리, 세트 상수에서 항목을 추가, 제거할 때 유용한 팁
  • git과 같은 소스 컨트롤 시스템에서 변화를 보여줄 때 line별로 표시를 함
  • 아래와 같이 names 리스트를 한 행에 선언하면 수정사항을 확인하기 곤란함
  • names = ['Alice', 'Bob', 'Dilbert']
  • 모든 행을 쉼표로 끝내자
  • 다음과 같이 names 리스트를 여러 행에 걸쳐 선언하면 수정사항을 보기 편리함
```python
names = [
    'Alice',
    'Bob',
    'Dilbert'
        ]
```
  • 이렇게 작성했을 때, 수정사항을 명확하게 볼 수 있지만 콤마(,)를 빼먹어 예상치 못한 버그를 만들 수 있음
  • python에서 공백으로 연결된 문자열은 하나의 문자열로 이해하기 때문에 쉼표 구분이 중요함(('a' 'b' 'c') == 'abc')
  • 콤마(,)를 빼먹는 실수를 줄이기 위해, 수정사항을 더 명확하게 보기 위해서 리스트의 마지막 요소 뒤에도 ,를 붙여주자
  • names = [ 'Alice', 'Bob', 'Dilbert', ]
  • 이렇게 모든 행을 쉼표로 끝냄으로 쉼표의 배치를 수정할 필요도 없고 예상치 못한 버그를 방지할 수 있다.
  • 아래 사진을 보면 더 쉽게 이해할 수 있다.

  • 첫 번째 방식에서 names list 선언하는 라인 전체가 하이라이트 되어 어떤 부분이 수정되었는지 빠르게 파악하기 어려움
  • 두번째 방식에서 jane이 추가된 것을 파악할 수 있지만 쉼표를 추가했기 때문에 Dilbert행도 변경사항이 있는 것으로 표시됨
  • 세번쨰 방식에서는 jane이 추가된 행만 하이라이트되어 변경내용을 빠르게 파악할 수 있음.

마무리

  • vs code에서 git을 사용하면 수정한 행 내에서 수정된 내용을 한번 더 강조해주고 있어 크게 불편하진 않지만, 내용대로 변수를 지정했을 때 더 보기 쉬운 것은 맞는 것 같음
  • 코드를 짜는 패턴은 관습을 따르는 것이 코드 공유, 관리 등 여러 측면에서 이점이 있을 것 같음