[파이썬 입문] 변수, 상수, 문서문자열(python docstring)

변수

Python 변수는 밑줄(_)을 포함한 영문, 숫자로 이름을 지어 나타냅니다. 파이썬은 다른 프로그래밍 언어처럼 변수 첫 번째 문자는 밑줄 (_) 또는 문자만 허용됩니다.

1
2
3
4
value1 = 123
_value1 = 123
test_value = 123
TEST_VALUE = 123
cs

상수

파이썬(Python)은 상수를 지원하지 않습니다. 관습적(보편적)으로 대문자와 밑줄(_)로만 변수 이름을 지어 상수임을 표현하는 것 같습니다.

1
2
PI = 3.14
MAX_BUFFER_SIZE = 1024
cs

문서 문자열 docstring (doc)

모듈의 시작 부분, 클래스 시작 부분, 함수 앞부분의 삼중 따옴표 """..."""에 달린 코멘트(주석)를 말하며, 이를 주석, 문서 문자열 docstring이라고 합니다. 모듈 오브젝트, 클래그 객체, 함수 오브젝트 등에 __doc__ 어트리뷰트를 참조할 수 있습니다.

1
2
3
4
5
6
"""A sample module"""
class MyClass:
    """A sample class"""
    def myfunc(self, x, y):
        """A sample function"""
        return x + y
cs

1
2
3
4
import mymod
print mymod.__doc__                  #=> A sample module
print mymod.MyClass.__doc__          #=> A sample class
print mymod.MyClass.myfunc.__doc__   #=> A sample function
cs

또한, 도큐멘트 스트링(문서 스트링, docstring)은 help에서도 참조됩니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$ python
>>> import mymod
>>> help(mymod)
Help on module mymod:
 
NAME
    mymod - A sample module
 
FILE
    /root/mymod.py
 
CLASSES
    MyClass
 
    class MyClass
     |  A sample class
     |
     |  Methods defined here:
     |
     |  myfunc(self, x, y)
     |      A sample function
cs