Pythonの変数やメソッドの命名について(アンダーバー)

Question

Pythonでは、privateな変数やメソッドの名前には

_(アンダースコア)を慣習的につけるが本当はアクセスできる。
__(アンダースコア×2)の場合は本当にアクセスできなくなる(特殊な指定方法を使えばアクセス可能)

という話を聞きました。

質問1. でもこれってどう使い分けるのでしょうか。

そもそもprivateな変数やメソッドでも慣習的にアンダースコアを使ってない場合も多いですよね。

質問2. アンダースコア、普段使ってますか？使う利点はありますか？

Answer 1

Pythonの標準コーディングスタイルを定めるPEP 8にてガイドラインが説明されています。以下、日本語訳バージョンから部分引用します：

実践されている命名方法

_single_leading_underscore: “内部でだけ使う” ことを示します。たとえばfrom M import *は、アンダースコアで始まる名前のオブジェクトをインポートしません。
__double_leading_underscore: クラスの属性に名前を付けるときに、名前のマングリング機構を呼び出します (クラスFoobarの__booという名前は_FooBar__booになります。以下も参照してください)

メソッド名とインスタンス変数

公開されていないメソッドやインスタンス変数にだけ、アンダースコアを先頭に付けてください。
サブクラスと名前が衝突した場合は、Pythonのマングリング機構を呼び出すためにアンダースコアを先頭に二つ付けてください。

継承の設計

• 公開されている(public)属性の先頭にはアンダースコアを付けない
• もしあなたが公開している属性の名前が予約語と衝突する場合は、属性の名前の直後にアンダースコアを追加します。省略語を使ったり、スペルミスをするよりはマシです。
• サブクラス化して使うクラスがあるとします。サブクラスで使って欲しくない属性があった場合、その名前の最後ではなく、先頭にアンダースコアを二つ付けることを検討してみましょう。これによって Python のマングリングアルゴリズムが呼び出され、その属性にはクラス名が付加されます。これはサブクラスにうっかり同名の属性が入ってしまうことによる属性の衝突を避けるのに役立ちます。

Comments

[tonkatu05]

なるほど！そういうことですか。では基本的には

トップレベルの変数、関数 -> アンダースコア1つ
クラス内の属性、メソッド -> アンダースコア2つ

という風に使い分ける感じですかね。

Answer 2

PythonでフレームワークをDjangoを使っています｡views.pyでクラスを使いhtmlとのやり取りをするのですが､その時mixinを使いある特定の処理を付け加える時に､内部処理にprivateなメソッドを使っています｡
例えば

# views.py
# フォームクラスに特定の処理が出来るmixinを2つ付け加えている｡
class ImportMemberIDFormView(SetMemberIDMixin, GetCsvDataMixin, FormView):
    template_name = 'csvs/import_all_userdates.html'
    form_class = ImportAllUserDatesForm
    success_url = reverse_lazy('userdates:home')

    def get_context_data(self, *args, **kwargs):
        context = super(ImportMemberIDFormView, self).get_context_data(
            *args, **kwargs)
        context['title'] = 'クラブメンバーIDのインポート'
        return context

    def form_valid(self, form):
        # CSVのファイルからデータ抽出
        data_list = self.get_csvdate()
        # データのバリデーション
#特定のmixinのメソッド
        csv_data_list = self.get_memberid_cleardates(data_list=data_list)
        if messages.get_level(self.request) < 1000:
            # データのsave
            self.save_memberid(csv_data_list=csv_data_list)
            messages.success(self.request, 'CSVからのクラブメンバーIDを同期しました｡')
            messages.set_level(self.request, None)
        return super(ImportMemberIDFormView, self).form_valid(form)

class SetMemberIDMixin(object):
    def get_memberid_cleardates(self, *args, **kwargs):
        data_list = kwargs['data_list']
        clean_data_list = []
        for i, values in enumerate(data_list):
            if i is not 0:
                for val_len in range(0, len(values)):
                    # memberIDはCSVの3番目
                    if val_len is 2:
                        # 配列を先頭から挿入
                        value = data_list[i][val_len]
              # ここで内部処理を使用
                        value = self.__core_set_memberid(value=value, row=i)
                        clean_data_list.append(value)
        # 重複をチェック
        ....中略
#内部でのみ(views.pyから参照されたくないメソッド)
    def __core_set_memberid(self, *args, **kwargs):
        value = kwargs['value']
        row = kwargs['row'] + 1

        if len(value) is not 11:
            message = '%s番目の %s が11桁ではありません｡' % (str(row), str(value))
            messages.add_message(self.request, messages.ERROR, message)
            messages.set_level(self.request, 1000)

        try:
            value = int(value)
        except:
            message = '%s番目の %s が数字ではありません｡' % (str(row), str(value))
            messages.add_message(self.request, messages.ERROR, message)
            messages.set_level(self.request, 1000)
            value = 0
    ...中略

Comments

[tonkatu05]

僕もDjango使ってます。そんな感じに使いますよね。

では、アンダースコア1つは基本的には使わないということですかね？

[jjzoow96]

明示的なのですが､自分だと例えばバリデーションで取得した値が数字ではない場合とかに
try:
_ = int(value_list[i])
value_list[i] = unicodedata.normalize('NFKC', value)
except:
raise forms.ValidationError('数字を入力して下さい｡')
みたいな感じで変数を定義してるがその後何も使わない物に対して使うようにしています｡