【Python】.pyファイルにある関数とメソッドを全て取得する

アーカイブ 287

Code 122 Software 65 Movie 31 Game 25 Book 15 Misc 14 Hardware 10 Mackerel 5

369 語

2 分

【Python】.pyファイルにある関数とメソッドを全て取得する

2022-01-22

Code

python

はじまり#

リサちゃん

今回は、Pythonスクリプトファイルから、関数およびメソッドを全て取得する処理を作るぞ〜。テストコードとかREADMEを書く時に使ってみたりするぞ〜。

今回のソース#

今回のソースはこちらになります。読み取り先ファイルと読み取り元ファイルを同じディレクトリに配置して、この読み取り元ファイル.pyを実行します。

get_words_in_lines_by_head_and_tail()で、"def "と"("の間の文字列を取得します。そして、remove_head_spaces()で、取得した文字列の"def "より前にある空白文字を削除します。

読み取り元ファイル.py:

1
def remove_head_sapces(word : str, spaces : list = [" ", "　"]) -> str:
2
    word_removed_space = ""
3
    if len(word) == 0:
4
        word_removed_space = word
5
    elif word[0] in spaces:
6
        word_removed_space = word[1:len(word)+1]
7
        # invisible head character if head space is nothing
8
        print("'{}'".format(word_removed_space[1:len(word)]))
9
        word_removed_space = remove_head_sapces(word_removed_space, spaces)
10
    else:
11
        word_removed_space = word
12
    return word_removed_space
13

14
def get_words_in_lines_by_head_and_tail(text_lines : list, head_of_target : str, tail_of_target : str) -> list:
15
    words = []
16
    text_line_removed_head_space = ""
17
    print(text_lines)
18

19
    for text_line in text_lines:
20
        text_line_removed_head_space = remove_head_sapces(text_line)
21
        head_index = text_line_removed_head_space.find(head_of_target, 0)
22
        if head_index != 0:
23
            continue
24
        tail_index = text_line_removed_head_space.find(tail_of_target, 0+head_index)
25
        if text_line_removed_head_space.find(tail_of_target, 0) == -1:
26
            continue
27
        word = text_line_removed_head_space[len(head_of_target):tail_index]
28
        words.append(word)
29
    return words
30

31
def get_functions_in_python_file(file_full_name : str, head_of_function : str = "def ", tail_of_function : str = "(") -> list:
32
    functions = []
33
    text = ""
34
    with open(file_full_name, "r", encoding="UTF-8") as f:
35
        text = f.read()
36

37
    text_lines = text.split("\n")
38
    functions = get_words_in_lines_by_head_and_tail(text_lines, head_of_function, tail_of_function)
39
    return functions
40

41
file_full_name = "読み取り先ファイル.py"
42
actual = get_functions_in_python_file(file_full_name)
43

44
print(actual)

読み取り先ファイル.py:

1
class ReplaceCharacter:
2
    def make_voicedsound(self, text : str) -> str:
3
        pass
4

5
def main():
6
    replace_character = ReplaceCharacter()
7

8
if __name__ == "__main__":
9
    main()

出力:

1
'  def make_voicedsound(self, text : str) -> str:'
2
' def make_voicedsound(self, text : str) -> str:'
3
'def make_voicedsound(self, text : str) -> str:'
4
'ef make_voicedsound(self, text : str) -> str:'
5
'      pass'
6
'     pass'
7
'    pass'
8
'   pass'
9
'  pass'
10
' pass'
11
'pass'
12
'ass'
13
'  replace_character = ReplaceCharacter()'
14
' replace_character = ReplaceCharacter()'
15
'replace_character = ReplaceCharacter()'
16
'eplace_character = ReplaceCharacter()'
17
'  main()'
18
' main()'
19
'main()'
20
'ain()'
21
['make_voicedsound', 'main']