[python] 4강. 프로그래밍 네이밍

 

 

 

 

 

 

( #02 [공통] 프로그래밍 언어 - 02 기초 문법 _ 1. 프로그래밍 네이밍 )

 

1. 프로그래밍 네이밍

1.1. 키워드 (keyword)

특별한 의미가 부여된 단어로, 파이썬이 만들어 질 때 이미 사용하던 예약어다.

 

키워드 확인하는 방법 (소프트키워드는 3.10이상)

 

# 키워드 리스트 출력
import keyword

print(keyword.kwlist)
print(keyword.iskeyword("fun"))
print(keyword.iskeyword("break"))

 

※ 생각보다 그 양이 적다.

 

 

 

 

1.2. 식별자 (identifier)

프로그래밍 언어에서 임의로 이름을 붙여 사용하는 단어이다.

(ex) 변수명, 함수명, 클래스명 등

 

 

1) 식별자 규칙

파이썬 언어 자체적으로 강제하는 규칙이다.

• 영문 문자, 숫자, 언더스코어(_)를 사용할 수 있습니다.
• 영문 문자, 언더스코더(_)로 시작해야 하며 숫자부터 시작하면 안 됩니다.
• 언더스코어(_) 이외의 특수 문자(+, -, *, /, $, @, &, % 등)는 사용할 수 없습니다.
• 파이썬의 키워드(if, for, while, and, or 등)는 사용할 수 없습니다.
• 중간에 빈 칸을 넣을 수 없습니다. ( 대신 언더스코어 사용 가능하다. )
• 영문 대소문자를 구분합니다.
• 헷갈리기 쉬운 글자의 사용을 자제하자.
  • (ex) O와 0, 1과 l 등

 

 

2) Code Naming

개발자들 사이에서 생산성 향상을 위해 약속한 관례적인 규칙이다. Coding conventions 중 하나이다.

[ 코드컨벤션(Code Convention) / 코딩 컨벤션 (Coding Convention) / 코딩 규칙 ]

해당 언어로 작성된 프로그램의 각 측면에 대한 프로그래밍 스타일, 사례 및 방법을 권장하는 특정 프로그래밍 언어 에 대한 일련의 지침입니다 . 궁극적인 목표는 다른 사람들의 실수를 덜 유발 시키며, 쉽게 이해할 수 있게 가독성 높은 코드를 작성하는 것이다. 일종의 코딩 스타일 규약이다.

• 파이썬은 PEP 8이 대표적인 컨벤션이다.
  
  • [공식문서] PEP 8 – Style Guide for Python Code

 

 

[ 스네이크 케이스 / 캐멀 케이스 ]

 

• snake_case
  모든 단어는 소문자로 적고, 그 사이에 언더 바 기호를 붙여 식별자를 만든다.
  • 함수, 변수
• CamelCase
  첫 글자를 대문자로 만들어 식별자를 만든다. 
  [주의!] 파이썬에서는 '첫 번째 글자를 소문자로 적는다'라는 캐멀 케이스는 사용하지 않는다.
  • 클래스, 클래스 생성자
    (ex) CapitalizedWords

파이썬의 표준 스타일 권고안 PEP8

1. 함수와 변수의 이름에 스네이크 케이스 방식을 권장하고 있습니다.
    ( 스네이크 케이스라는 용어를 사용하지는 않지만 설명 상으로는 스네이크 케이스를 가리키고 있다. )
2. 참고로 사용자 정의 자료형인 클래스(class) 이름은 캐멀 케이스를 권장합니다.

 

---

[참고] 파스칼 케이스(Pascal case) vs 캐멀 케이스(Camel case)

다른 언어 강의에서는 첫글자가 대문자인 캐멀 케이스를 파스칼 케이스라고 부릅니다. 파이썬 공식 문서에서는 파스칼 케이스라는 용어를 사용하지는 않기 때문에 때문에 저도 여기서는 굳이 파스칼이라는 용어를 사용하지는 않았습니다.

* 그냥 이해하기 쉽게 UpperCamelCase로 이해하자.

CapitalizedWords (or CapWords, or CamelCase – so named because of the bumpy look of its letters. This is also sometimes known as StudlyCaps.

---

위키피디아의 Camel case 항목에서는 upper/lower로도 구분합니다.

For clarity, this article calls the two alternatives upper camel case (initial uppercase letter, also known as Pascal case or bumpy case) and lower camel case (initial lowercase letter, also known as dromedary case).

https://en.wikipedia.org/wiki/Camel_case

 

 

 

1.3. 주석 (comment)

파이썬에서 사람만 알아볼 수 있도록 작성하는 부분을 주석(comment)라고 합니다.

 

 

[ 한 줄 주석 ]

# Hello, world! 출력 (주석 예시)
print('Hello, world!')

---

a = 1 + 2 # 더하기 (주석 예시)
print('Hello, world!') #printf('1234567890')

 

 

[ N 줄 주석 ]

쌍따움표( " ) / 홑따움표( ' )를 최소 3개씩 사용하는 것입니다.

시작과 끝에는 3개 이상을 입력해야 합니다.

 

"""
(주석 예시)
"""

 

여러 줄로 이루어진 주석은 큰따옴표 세 개를 연속으로 사용한 """ 기호 사이에 주석문을 작성하면 된다.

큰따옴표 대신 작은따옴표 세 개(''')를 사용해도 된다.

 

 

 

[ TIP ] TODO, FIXME, BUG, NOTE

 

if x == 10:
    pass    # TODO: x가 10일 때 처리가 필요함

 

TODO는 해야 할 일이라는 뜻인데 보통 주석에 넣습니다.

이렇게 TODO를 넣어 두면 검색으로 쉽게 찾을 수 있죠.

 

그래서 프로그래머들은 주석에 TODO 이외에도 FIXME, BUG, NOTE 등과 같이 코드는 아니지만 일관된 주석을 사용합니다.

 

 

 

---

| 참고 | 파이썬에서 한글 주석 사용하기

파이썬 3에서는 .py 스크립트 파일의 기본 인코딩이 UTF-8입니다. 스크립트 파일을 다른 인코딩(CP949, EUC-KR)으로 저장하면 실행을 했을 때 에러가 발생한다.

[ CP949로 저장된 hello.py ]

print('Hello, world!')    # 한글 주석
File "hello.py", line 1
SyntaxError: Non-UTF-8 code starting with '\xc7' in file hello.py on line 1, but no encoding declared; see http://python.org/dev/peps/pep-0263/ for details

이때는 스크립트 파일을 UTF-8로 저장하면 됩니다.
대부분의 텍스트 편집기는 저장할 파일의 인코딩을 설정할 수 있습니다.

메모장에서는 파일(F) > 다른 이름으로 저장(A)… > 인코딩(E)에서 UTF-8을 선택한 뒤 저장합니다.

---

 

 

 

 

 

 

 

 

 

 

 

이 배너는 쿠팡파트너스 활동의 일환으로, 일정액의 수수료를 제공 받을 수도 있습니다.