python 別ファイルからのクラス実行について

Question

前提

ラズパイ3でrpi-led-matrixのサンプルを改造して電光掲示板を動作させています。
他ファイルから以下ファイルのクラスを動作させることができず困っています。
selfといった仕組みが理解できていません。よろしくお願いいたします。

該当のソースコード

実行される側：runtext.py

#!/usr/bin/env python
# Display a runtext with double-buffering.
from samplebase import SampleBase
from rgbmatrix import graphics
import datetime
import time

print("test")

class RunText(SampleBase):
    def __init__(self, *args, **kwargs):
        dt_now = datetime.datetime.now()
        super(RunText, self).__init__(*args, **kwargs)
        self.parser.add_argument("-t", "--text", help="The text to scroll on the RGB LED panel", default= dt_now.strftime('%H:%M'))


    def run(self):
        offscreen_canvas = self.matrix.CreateFrameCanvas()
        font = graphics.Font()
        font.LoadFont("../../../fonts/myfont.bdf")
        textColor = graphics.Color(255, 255, 0)
        pos = offscreen_canvas.width
        my_text = self.args.text

        #10秒経過で終了
        t_end = time.time() + 10

        while time.time() < t_end:
            offscreen_canvas.Clear()
            len = graphics.DrawText(offscreen_canvas, font, pos, 14, textColor, my_text)

            pos -= 1
            if (pos + len < 0):
                pos = offscreen_canvas.width

            time.sleep(0.05)
            offscreen_canvas = self.matrix.SwapOnVSync(offscreen_canvas)


# Main function
if __name__ == "__main__":
    run_text = RunText()
    if (not run_text.process()):
        run_text.print_help()

実行する側：test.py

import runtext

試したこと

• ファイル単体での実行→class内が問題なく動作し電光掲示板に文字が流れる。print("test")も実行される
• ファイルを別ファイルから呼び出す→print("test")のみ実行されclassは無視される

↓ここからはよく理解できず試したものになります

• # Main functionを全て消す→単体でも動作しなくなる
• # 権限をchmodで拡大→変化なし
• # runtext = runtext.Runtext()をtext.pyに追加→AttributeError: module 'runtext' has no attribute 'Runtext'でエラー

補足情報（FW/ツールのバージョンなど）

環境：mac、raspberry pi3

Comments

[tenn]

お二方ともありがとうございます。実行はできているようなのですが、書き忘れていることがありましたので追記させていただきます、申し訳ございません。

上のファイルを実行するには
```
sudo python3 runtext.py --led-rows=16 --led-no-hardware-pulse LED_NO_HARDWARE_PULSE
```
という表記が必要であり、別ファイルから実行した場合にsudoや.pyの後ろに書かれている内容が反映できていませんでした。もしこれらを反映させる手段がございましたら、そちらも教えていただけると幸いです。
やはりこちらも解決できなかったため、別で質問させていただきたいと思います。

[tenn]

すみません、単純に
sudo python3 test.py --led-rows=16 --led-no-hardware-pulse LED_NO_HARDWARE_PULSE
で実行できました。

Answer 1

※ 以下の説明は厳密には違う部分がありますが、簡易的な説明と思ってください。

質問の問題が起きるのは、以下で説明したことを理解していないために起きているのでしょう。長くなってしまいましたが、読んでみてください。

pythonのプラグラムファイルの使いかたにはざっくり2種類あります。

1. そのファイルを実行して結果を得る。
2. そのファイルをモジュールとしてインポートして使う

1の方は、なじみがあるようですが、そのファイルに書かれていることをそのまま実行することが目的のものです。
一方、2のインポートする場合は、そのファイルはクラスや関数などの機能を提供することを目的としていて、取り入れたものをどのように使うかはインポートした側がコントロールするものです。
ただ、ファイルのインポートはそのファイルの内容を実行することが目的ではないのですが、pythonの仕組みとして、そのファイルの中にその場で実行されるようなものが記述されている場合はインポートした時に実行されてしまいます。「runtext.py」をimportすると、「test」が表示されるのはそのためです。
しかし、インポートは実行が目的ではないので、本来はそのようにことが起きるのは想定していないはずです。たとえば複数回インポートしても1度しか読み込まれないので、testをもう一度表示させようとしてもう一度インポートしても、もう「test」と表示されることはありません。

このように、pythonのプログラムは、実行するための書きかたとインポートして使うための書き方が異なる言語です。

とは言っても、インポート用に作ったファイルも、簡易的な使いたいとか、テストのためなどで、そのまま実行したときの動作を定義できたほうが便利です。 また、将来的なことを考えてインポートして使えるように書いておくというのもあるでしょう。
そのような場合に使うのが、「if name == "main":」ブロックを使った動作の制御です。

このブロック内の処理は、ファイルそのものを実行した場合(1のパターン)にだけ実行されます。他のファイルからインポートしたときには実行されないのです。 便利ですね。
これは、pythonインタープリタがファイルを直接実行したときには、__name__特殊変数に__main__という文字列を設定すことを利用しています。

ということで、質問のプログラムは、

• インポートすると、print()が実行され、RunTextクラスが使えるようになる
• 直接実行すると、print()が実行され、RunTextクラスが定義され、"Main function"と書かれた部分の内容が実行される。

となってます。 print文は多分ちゃんとインポートされているか確認するために入れているのだと思うので、削れば、意図通りでしょう。
インポートして使う場合は、他の回答にもあるとおり、インポートした側でインスタンス化して使いましょう。

もし、Main functionと書かれた部分も機能として提供したいのであれば、この処理もmain()関数などで定義して、インポート下側で呼ぶということになるでしょう。

Comments

[tenn]

回答ありがとうございます。
importは自分のファイルでほとんど使用したことがなかったので、このような仕組みで動いているとよく理解できていませんでした。
mainの使用方法をもう少し自分で探ってみたいと思います。

Answer 2

別のファイルから任意のクラスをインポートするには、from ファイル名 import クラス名 とします。
そして、クラスをインポートした側のファイルで、クラスのインスタンスを作成します。今回の場合は、#Main function の部分です。

# test.py
from runtext import RunText

# Main function
if __name__ == "__main__":
    run_text = RunText()
    if (not run_text.process()):
        run_text.print_help()

runtext.py の方の、#Main function の部分は削除しておきます。でないと 2 重に実行されてしまいます。
他の方の回答にもある通り、if __name__ == "__main__": が記載されているので削除せずとも 2 重に実行はされません。2 重に実行される可能性があるのは、print() 文だけです。
見落としてました。失礼しました。

---

また、ファイル単位でインポートした場合、ファイル名にドットを付けてクラスを呼び出すこともできます。

import runtext

run_text = runtext.RunText()

runtext = runtext.Runtext()をtext.pyに追加→AttributeError: module 'runtext' has no attribute 'Runtext'でエラー

このエラーは恐らく誤字です。クラス名が、RunText ではなく、Runtext になってます。

Comments

[tenn]

ありがとうございます、誤字には全く気がついていませんでした。
少し別の問題が発生しているのではっきりとは言えないのですが…、おそらく実行することができました！

[tenn]

何度もすみません、問題が解決し実行が確認できました。