とほほのPython入門 - 変数・定数

Python の変数は、アンダーバー(_)を含む英数字からなる名前で表します。最初の1文字はアンダーバー(_)または英字でなくてはなりません。

Python

value1 = 123
_value1 = 123
test_value = 123
TEST_VALUE = 123

定数

Python では定数はサポートされていません。慣習的に大文字とアンダーバー(_)のみの変数が固定値を表現することが多いようです。

Python

PI = 3.14
MAX_BUFFER_SIZE = 1024

ドキュメントストリング(__doc__)

モジュールの冒頭、クラスの冒頭、関数の先頭に三重クォート """...""" で記述したコメントは、ドキュメントストリング と呼ばれ、モジュールオブジェクト、クラスオブジェクト、関数オブジェクトの __doc__ アトリビュートで参照することができます。

mymod.py

Python

"""A sample module"""
class MyClass:
    """A sample class"""
    def myfunc(self, x, y):
        """A sample function"""
        return x + y

mytest.py

Python

import mymod
print mymod.__doc__                  #=> A sample module
print mymod.MyClass.__doc__          #=> A sample class
print mymod.MyClass.myfunc.__doc__   #=> A sample function

ドキュメントストリングはまた、対話モードで使用される help() でも参照されます。

Linux

$ 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