Menu/Prof
スズキマコト
自由人
元々は楽器屋のギター兄ちゃん。
趣味でプログラミングしてるうちに
本職になってしまった人。

過去に喋っていた言語
c pascal Assembler
perl PHP Python Ruby など
javascriptなどは都度必要に応じて。
最近Mac買ったのでswift勉強してます。

体ぶっ壊して死にかけたので人生RESET中。
おすすめ記事!

Pythonのmain関数とimport|インデント・PEP8・リスト・スコープまでの基礎備忘録

Some visuals are licensed via Canva Pro (includes commercial rights).
Usage complies with Canva’s license terms at the time of use.
License policy: canva.com/policies/content-license-agreement

ChatGPTにPythonのコードを書かせて実行させる使い方(当時の名前はAdvanced Data Analysis、その前はCode Interpreter)では、AIがPythonのソースを出力し、それを実行して目的を達成しようとします。やはり基本的なPythonの知識は持っておくべきと考え、Python用の備忘録を作ることにしました。

このページでは、main関数とimportを中心に、インデントやPEP8の命名規則といったコーディングの約束、C言語との違いが気になる配列(リスト)、変数のスコープ(LEGB)とクロージャまでをまとめています。

contents

if __name__ == “__main__”: このメインの書式ですが if __name__ というのは変数ですか?

if __name__ == "__main__": という書式において、__name__はPythonにおける特殊な組み込み変数(ビルトイン変数)です。この変数は、Pythonスクリプトが実行される際に自動的に定義されます。

  • スクリプトが直接実行された場合(例:python my_script.py)、__name__変数は"__main__"という文字列に設定されます。
  • スクリプトが他のスクリプトにインポートされた場合(例:import my_script)、__name__変数はそのスクリプトのモジュール名(この場合は"my_script")に設定されます。

この特性を利用して、if __name__ == "__main__":という条件文は、スクリプトが直接実行された場合にのみ特定のコードブロックを実行するために使用されます。

以下はその使用例です。このコードはPEP8に準拠しており、各行にコメントも付けています。

# 関数の定義
def my_function():
    print("This is my function.")

# if __name__ == "__main__" ブロック内のコード
if __name__ == "__main__":
    print("This script is being run directly.")
    my_function()

このスクリプトが直接実行された場合、出力は以下のようになります。

This script is being run directly.
This is my function.

しかし、このスクリプトが他のスクリプトからインポートされた場合、if __name__ == "__main__": ブロック内のコードは実行されません。これにより、モジュールとして再利用しやすいコードを書くことができます。

管理人

ということは 例えば soruce1.py を作り def sample_functionA という関数を定義して そのソースの最下部に メインルーチンを記載してある場合、そのsoruce1.py単体を稼働させた場合は そのメインルーチンが実行されるが 他の other.pyが source1.py をインポートした場合は other.pyが sample_functionA を利用でき その other.pyのメインルーチンが稼働するいうことですね?

じぴ子

はい、その通りです。source1.pyにdef sample_functionAという関数が定義されていて、その最下部にif __name__ == "__main__":というメインルーチンが記載されている場合、以下のような挙動になります。

  1. source1.pyを直接実行する(python source1.py)と、sample_functionAが定義され、その後でif __name__ == "__main__":ブロック内のメインルーチンが実行されます。
  2. 別のスクリプトother.pyからimport source1としてsource1.pyをインポートすると、sample_functionAはインポートされますが、if __name__ == "__main__":ブロック内のメインルーチンは実行されません。

このように、if __name__ == "__main__":は、スクリプトが直接実行された場合と、他のスクリプトからインポートされた場合で、どの部分を実行するかを制御する便利な仕組みです。これにより、同じ.pyファイルをスクリプトとしても、ライブラリ(モジュール)としても使えるようになります。

Pythonのインポート importについて

管理人

other.py に source1.py を インポートする書式は?

じぴ子

other.pyからsource1.pyをインポートする基本的な書式は以下のいずれかです。

  1. 全ての名前をインポートする場合: from source1 import * この書式では、source1.py内で定義されているすべての名前(関数、変数、クラスなど)がother.pyで利用可能になります。ただし、この方法は通常推奨されません。なぜなら、どの名前がインポートされているのかが明確でなく、名前の衝突が起きやすいからです。
  2. 特定の名前だけをインポートする場合: from source1 import sample_functionA この書式では、source1.py内で定義されているsample_functionAだけがother.pyで利用可能になります。
  3. モジュール全体をインポートする場合: import source1 この書式では、source1.py内で定義されている名前はsource1.プレフィックスをつけてother.pyで利用できます。例:source1.sample_functionA()
  4. モジュール全体を別名でインポートする場合:
    python import source1 as s1
    この書式では、source1.pyがs1という名前でother.py内で利用できます。例:s1.sample_functionA()

各行にコメントを入れると、PEP8に準拠した形になります。例えば:

# source1.pyからsample_functionAをインポート
from source1 import sample_functionA

# sample_functionAを使用
sample_functionA()

これらの書式を使って、other.pyからsource1.py内の関数や変数を利用できます。

管理人

from source1 import sample_functionA この書式はsource1.pyの特定の関数をインポートするのはわかりました。 例えばこのような関数を2つインポートしたい場合はそれぞれ上記の書式で別々に宣言すべきですか? それとも複数まとめて宣言できますか?

じぴ子

複数の関数をまとめてインポートすることも可能です。カンマ,を使って関数名を列挙することで、一行で複数の関数をインポートできます。

例えば、source1.pyにsample_functionAとsample_functionBという2つの関数が定義されている場合、以下のように書くことができます。

# source1.pyからsample_functionAとsample_functionBをインポート
from source1 import sample_functionA, sample_functionB

この書式により、sample_functionAとsample_functionBが現在のスクリプトで利用可能になります。

もちろん、PEP8に準拠した形で各行にコメントを入れることもできます。

# source1.pyからsample_functionAとsample_functionBをインポート
from source1 import sample_functionA, sample_functionB

# sample_functionAとsample_functionBを使用
sample_functionA()
sample_functionB()

このように、一行で複数の関数や変数をインポートすることができます。ただし、インポートする項目が多くなると行が長くなる可能性がありますので、その場合は複数行に分けることも考慮に入れてください。

複数のimportする場合の書式について

管理人

from source1 import sample_functionA,
sample_functionB,sample_functionC, sample_functionD,
sample_functionE,
sample_functionF
このような変則的な書き方でも認識しますか?

じぴ子

Pythonでは、そのような書き方は構文エラーになります。複数行に分けてインポートする場合は、行の末尾にバックスラッシュ(\)を置くか、括弧を使用してください。

1.バックスラッシュを使用する場合:

from source1 import sample_functionA, \
                   sample_functionB, \
                   sample_functionC, \
                   sample_functionD, \
                   sample_functionE, \
                   sample_functionF

2.括弧を使用する場合:

from source1 import (sample_functionA,
                     sample_functionB,
                     sample_functionC,
                     sample_functionD,
                     sample_functionE,
                     sample_functionF)

どちらの方法もPEP8に準拠しています。括弧を使用する方法はよりPythonicであり、多くの場合で推奨されています。この方法では、各行にコメントを追加することも容易です。

# source1.pyから複数の関数をインポート
from source1 import (
    sample_functionA,  # Aに関する説明
    sample_functionB,  # Bに関する説明
    sample_functionC,  # Cに関する説明
    sample_functionD,  # Dに関する説明
    sample_functionE,  # Eに関する説明
    sample_functionF   # Fに関する説明
)

このように書くことで、コードの可読性も高まります。

管理人

ふむ。
from source1 import (sample_functionA,
sample_functionB,sample_functionC,
sample_functionD,
sample_functionE,sample_functionF)

可読性は置いておいて これは認識しますか?

じぴ子

はい、その書き方でもPythonは正しく認識します。括弧内では、改行やスペースが許容されています。ただし、このような書き方は一般的には推奨されません。なぜなら、可読性が低く、コードのスタイルが一貫していないからです。

PEP8に準拠すると、各関数名の後にカンマを置き、改行してインデントを揃えるのが一般的です。これにより、コードの可読性が高まります。

from source1 import (
    sample_functionA,
    sample_functionB,
    sample_functionC,
    sample_functionD,
    sample_functionE,
    sample_functionF
)

しかし、技術的にはあなたが示した書き方も問題なく動作します。

Pythonでコーディングする時の約束:インデント・def・PEP8の命名規則

main関数やimportの書き方の前提になる、Pythonを使う際に注意しなければならないポイントです。

Pythonのソースのインデントについて

  • Pythonはインデント(通常はスペース4つまたはタブ4)が構文の一部であるため、正確なインデントが必要です。

vscodeなどのプログラミングに特化したエディターを使用するとインデントの関係が見やすかったりします。

むしろ使わないとあらぬ構文エラーを起こしそうです。

Cなどの他言語経験者の場合(私)このインデントで一括りが異様な感じがしますがまぁこれは慣れなんでしょうな。{ } 使いたくなります笑

VS Codeで表示したPythonのコード。文字列を連結する関数とwhileループがインデントで入れ子になっている

Pythonの関数の宣言はdef

上の画像のコードを見ていただくとわかりますが、def で始まる部分が関数ですね。

def hogehoge(input):

最後の : (コロン)が独特な感じするけどこれとインデントで一括りに考えるのだな・・。

Pythonを使う際に注意しなければならないその他のポイント

スクロールできます
カテゴリ説明
インデントPythonはインデント(通常はスペース4つまたはタブ4)が構文の一部であり、正確なインデントが必要です。
命名規則Pythonの命名規則(PEP8)に従い、変数名や関数名を選ぶことが推奨されます。
バージョン管理Python 2とPython 3は互換性がありません。使用するバージョンに注意が必要です。
ライブラリとパッケージ使用する外部ライブラリやパッケージがPythonのどのバージョンに対応しているかを確認すること。
エラーハンドリング適切なエラーハンドリング(try、exceptブロックなど)を行うこと。
コメントとドキュメンテーションコードに適切なコメントを追加し、必要な場合はドキュメンテーションを作成すること。
リソース管理ファイルやネットワーク接続などのリソースを使用する際は、適切にクローズすること。
テスト単体テストや統合テストを行い、コードが正確に動作することを確認すること。
コードの可読性コードは他の人(または未来の自分)が理解しやすいように書くこと。
グローバル変数の使用グローバル変数は極力避け、必要な場合は注意深く使用すること。

Pythonを使用する際に考慮すべき主要なポイントを網羅しています。これに従うことで、より効率的かつ安全なコード開発が可能です。

注意点をまとめて示す簡単なサンプル

# インポート部分: 必要なモジュールをインポート
import math

def calculate_area(radius):
    """
    円の面積を計算する関数
    :param radius: 円の半径
    :return: 円の面積
    """
    # 数学的な計算: 円の面積 = π * 半径^2
    return math.pi * math.pow(radius, 2)

# エントリーポイント: プログラムの実行が始まる場所
if __name__ == "__main__":
    try:
        # ユーザー入力: 半径を入力してもらう
        r = float(input("円の半径を入力してください: "))

        # 面積計算: calculate_area関数を呼び出して面積を計算
        area = calculate_area(r)

        # 結果出力: 計算された面積を出力
        print(f"円の面積は {area} です。")

    except ValueError:
        # エラーハンドリング: 不正な入力があった場合の処理
        print("無効な入力です。数値を入力してください。")

このサンプルコードはPEP8に準拠しており、各行にコメントも付けています。注意点に関連する部分は特にコメントで明示しています。エントリーポイントのif __name__ == "__main__":は、このページの最初で説明した書き方です。

PEP8の命名規則:変数名や関数名の付け方

Pythonの命名規則はPEP 8(Python Enhancement Proposal 8)によって定められています。以下はその主なポイントです。

スクロールできます
カテゴリ命名スタイル例説明
変数名小文字 + アンダースコアuser_name, total_amount可読性の高い名前を選びます。
定数大文字 + アンダースコアMAX_SIZE, PI_VALUE定数は大文字とアンダースコアを使用します。
関数名小文字 + アンダースコアcalculate_area(), get_user_info()関数名も小文字とアンダースコアを使用します。
クラス名キャメルケースMyClass, UserInfoクラス名は「CapWords」(キャメルケース)を使用します。
メソッド名小文字 + アンダースコアmy_method()メソッド名は小文字とアンダースコアを使用します。
インスタンス変数小文字 + アンダースコア(非公開の場合は先頭に_)_private_var非公開のインスタンス変数は、先頭にアンダースコアを一つつけます。
モジュール名小文字os, sysモジュール名は短く、小文字を使用します。アンダースコアは避けることが推奨されています。
パッケージ名小文字requests, numpyパッケージ名も短く、小文字を使用します。
引数名小文字 + アンダースコアarg_one, arg_two引数名は関数名と同様に、小文字とアンダースコアを使用します。
グローバル変数小文字 + アンダースコアglobal_varグローバル変数は避けるべきですが、使用する場合は小文字とアンダースコアを使用します。

このテーブルは、Pythonの命名規則に関する主要なポイントを網羅しています。これに従うことで、コードの可読性とメンテナンス性が向上します。

Pythonの配列(リスト)の考え方:C言語の配列・ポインタとの違い

管理人

配列の使い方をいま一度教えてほしいのです。 Cのポインタ脳になっていますのでついポインタを考えてしまうのですが パイソン的な正しい配列の考えをもう一度整理しておしえてください

Pythonにおける配列(リストとも呼ばれる)は、C言語の配列やポインタとはいくつかの重要な点で異なります。

Pythonのリストの特性

  1. 動的サイズ: Pythonのリストは動的にサイズが変更されます。C言語のように事前にサイズを宣言する必要はありません。
  2. 異なるデータ型: Pythonのリストは異なるデータ型の要素を格納できます。
  3. 高レベル操作: スライス、挿入、削除などの高レベルな操作が簡単に行えます。

基本的な操作:append・insert・remove・pop・del・スライス

初期化、要素の追加(append())、位置を指定した挿入(insert())、削除(remove()・pop()・del)、スライス、forループでのイテレーションを、ひととおり並べたサンプルです。

# 初期化: 空のリストを作成
empty_list = []  # 空のリスト
print(f"Empty list: {empty_list}")

# 初期化: 初期値を与えてリストを作成
initial_list = [1, 2, 3]  # 初期値あり
print(f"Initial list: {initial_list}")

# 要素の追加: append()メソッドを使用
initial_list.append(4)  # 4を追加
print(f"List after append: {initial_list}")

# 要素の挿入: insert()メソッドを使用
initial_list.insert(0, 0)  # 位置0に0を挿入
print(f"List after insert: {initial_list}")

# 要素の削除: remove()メソッドを使用
initial_list.remove(0)  # 0を削除
print(f"List after remove: {initial_list}")

# 要素の削除: pop()メソッドを使用
initial_list.pop()  # 最後の要素を削除
print(f"List after pop: {initial_list}")

# 要素の削除: delを使用
del initial_list[0]  # 位置0の要素を削除
print(f"List after del: {initial_list}")

# スライス: 部分的なリストを取得
sublist = initial_list[0:2]  # 位置0から1までの部分リスト
print(f"Sublist: {sublist}")

# イテレーション: forループで要素を一つずつ処理
print("Iterating through the list:")
for item in initial_list:
    print(item)

C言語のポインタとの違い

  1. 参照の透明性: Pythonのリストは、C言語のポインタのようにメモリアドレスを直接扱うことはありません。
  2. 自動メモリ管理: リストのサイズ変更や要素の追加・削除が行われた場合、Pythonが自動的にメモリを管理します。

append(7)をいきなり実行したら、間にはNULLや0が入る?

[1, 2, 3]のリストにmy_list.append(7)をいきなり実行した場合、4〜6番目にNULLや0が入るのでは、とCの感覚で考えてしまいました。答えは「何も入らない」です。append()は要素をリストの末尾に追加するだけで、リストは単に[1, 2, 3, 7]になります。

C言語の配列とは異なり、Pythonのリストには「未初期化の領域」や「NULL要素」が自動的に作成されることはありません。

# 初期のリスト
my_list = [1, 2, 3]

# 要素を追加
my_list.append(7)  # [1, 2, 3, 7]

# リストの内容を出力
print(my_list)  # Output: [1, 2, 3, 7]

要素の参照はmy_list(3)ではなくmy_list[2]

要素を参照するときは角括弧([])を使います。インデックスは0から始まるため、3番目の要素はmy_list[2]です。my_list(3)は関数呼び出しと解釈され、エラーになります。print(my_list[2])のように、print()の引数に直接書いても同じく3が出力されます。

# 初期のリスト
my_list = [1, 2, 3]

# 3番目の要素を参照
third_element = my_list[2]  # 3

# 参照した要素を出力
print(third_element)  # Output: 3

Pythonの変数のスコープ:LEGBルールとクロージャ

Pythonにおける変数のスコープ(スコープとは、変数が参照可能な範囲のこと)は主に以下の4つのレベルに分けられます。

  1. ローカル(Local): 関数内で定義された変数は、その関数内でのみ参照可能です。
  2. エンクロージング(Enclosing): 外側の関数によって定義された変数が、内側の関数で参照可能です。
  3. グローバル(Global): スクリプト全体で定義された変数は、どこからでも参照可能です。
  4. ビルトイン(Built-in): Python言語自体に組み込まれている変数や関数(例:len, printなど)。

Pythonでは、変数を参照する際には「LEGBルール」(Local -> Enclosing -> Global -> Built-in)に従います。これは、変数が参照される際の探索順序を意味します。

以下に、各スコープについてのサンプルコードを示します。

# グローバル変数(Global Scope)
global_var = "I am a global variable"

def outer_function():
    # エンクロージング変数(Enclosing Scope)
    enclosing_var = "I am an enclosing variable"

    def inner_function():
        # ローカル変数(Local Scope)
        local_var = "I am a local variable"

        # 各スコープから変数を参照
        print(local_var)  # ローカル変数
        print(enclosing_var)  # エンクロージング変数
        print(global_var)  # グローバル変数

    inner_function()

# outer_functionを呼び出す
outer_function()

# ビルトイン関数(Built-in Scope)
print(len("I am a built-in function"))

このサンプルコードでは、outer_function内でinner_functionが定義されています。inner_function内のlocal_varはローカルスコープ、enclosing_varはエンクロージングスコープ、global_varはグローバルスコープに存在します。

最後に、len関数はビルトインスコープに存在する関数です。

このように、Pythonの変数スコープは非常に直感的であり、LEGBルールに従って変数を探索・参照します。

入れ子の関数(inner_function)のスコープは外側の関数の中だけ

上のソースではouter_functionの中にinner_functionがあります。inner_functionはouter_functionの中で定義されているため、そのスコープはouter_function内に限られます。

具体的には、outer_functionの外からinner_functionを直接呼び出すことはできません。以下のようなコードはエラーになります。

# これはエラーになる
inner_function()

外から使いたい場合は、inner_functionをouter_functionの外で定義するか、outer_functionの戻り値として返します。後者がクロージャです。

Pythonのクロージャってなんだー?

Pythonにおいて、クロージャ(Closure)は外側の関数(エンクロージング関数)によって生成され、内側の関数(ネステッド関数)が外側の関数の変数にアクセスできる特殊な関数の一種です。クロージャを使用すると、内側の関数がその定義が行われたスコープ外でも、外側の関数のローカル変数にアクセスできるようになります。

以下に、クロージャの基本的な使用例を示します。

# エンクロージング関数(外側の関数)
def outer_function(x):
    # 外側の関数のローカル変数
    outer_variable = x

    # ネステッド関数(内側の関数)
    def inner_function(y):
        # 内側の関数が外側の関数のローカル変数にアクセス
        return outer_variable + y

    # ネステッド関数を返す
    return inner_function

# クロージャを生成
closure = outer_function(10)

# クロージャを実行
result = closure(5)  # 10 (outer_variable) + 5 (y) = 15
print(result)  # Output: 15

この例では、outer_functionがinner_functionを返しています。inner_functionはouter_functionのローカル変数outer_variableにアクセスしています。outer_functionを呼び出して得られたinner_function(ここではclosureとして保存)は、その後独立して呼び出すことができ、outer_variableの値(この場合は10)を”覚えて”います。

このようにして、クロージャを使うと内側の関数が外側の関数のローカル変数にアクセスできるようになり、その変数の値を保持することができます。これにより、関数の振る舞いを動的に変更したり、状態を持つ関数を作成することが可能になります。

シェアしてくれると喜びます
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

makotoのアバター makoto Blogger&YouTuber

サーバー管理者として17年ほど仕事でサーバー触ってました。
www,mail,dns,sql各鯖をすべてFreeBSDで運用してましたが現世ではかなりレアなタイプになるみたいですね笑

viやシェルスクリプトとかperlとかgccとかFreeBSDとか実はbashよりtcshが好きとか時々寝ぼけるのは
その名残でしょう。

今まで縁の下の力持ち的な他人のためにプログラムを書き他人のためにサーバー構築し他人のためにWEBサイトを創る的な世界から
自分の好きなことに集中できる環境は実に気持ち良いですね。
現役は引退済みなので難しいことはやりませんしやれません。

現在 ほぼ自由人。

contents