시도에 사용되는 .py 파일 형식 (템플릿) - 2020

파이썬 시도에 사용되는 .py 스크립트의 상용 코드 (템플릿). 이하, 정형.py의 란을 참조.

코드 스타일

run__main1() 등으로, 복수의 시행 처리를 나누어 써, main() 함수내에서 run__main1() 등을 코멘트/코멘트 아웃으로 전환해, 실행하는 함수를 전환하는 스타일. 코딩시, 에디터내에서 함수명 run__main1 등을 검색·점프하고, main() 함수내의 전환 상태를 확인, 다시 한번 점프하면 원래의 run__main1 함수 위치까지 돌아가, 편집 속행하는 스타일.

함수는 def func1(x, 위의 주석 # ○○の機能 와 같이 함수 정의 위의 행에 함수의 간단한 (특징) 설명을 추가하는 스타일. 함수 바로 아래에는, def test__func1(): 와 같이 테스트 함수(기능이 단독으로 확인할 수 있는 실행 코드)를 항상 맞추어 써 두는 스타일. 테스트 함수의 코드가, 그 함수의 대표적인 사용법을 나타내는 코드 예도 되기 때문에 더욱 유용. 테스트 함수는 # main = test__func1 와 같이 main을 덮어쓰는 형태로 실행시키는 스타일. 이 테스트 함수의 실행시는, 코멘트를 제외해 main = test__func1 로 하는 것으로, 테스트 함수 test__func1 만이 실행되도록(듯이) 전환한다.

matplotlib의 그래프의 정형 코드, numba의 고속화의 정형 코드,를 말미에 부수, 불필요한 것은 요 삭제.

코드 구성

소스 코드 정형.py

정형.py

# -*- coding: utf-8 -*-

# ○○の試行

# 結果: ○○

# import例: (不要なものは要削除)
import numpy as np
import matplotlib
import matplotlib.pyplot as plt
import pandas as pd
import numba

# sec: main

def main(): # 実行切替用
    run__main1()
    # run__main2()
    # run__main3()

# ○○の試行
def run__main1():
    # 結果: ○○

    # sec: config

    pass

    # sec: run

    pass

    # sec: draw

    pass

"""コンソール出力例:
○○
"""

# ○○の試行
def run__main2():
    pass

# ○○の試行
def run__main3():
    pass


# sec: ○○の機能

# ○○の機能
def func1(x, # 必須引数の説明1
    y = 0, # オプションの説明1
    z = 0): # オプションの説明2
    pass

def test__func1():
    pass
# main = test__func1


# sec: グラフ定型

def draw__main1():
    fig = plt.figure(tight_layout=True)
    ax = fig.add_subplot(111)
    ax.plot((0, 1), (2, 3), "r-o")
    ax.grid()
    # ax.annotate("test", xy=(0.2, 2.2), ha='left', va='top')
    # ax.axis("equal")
    # ax.legend(fontsize=9, framealpha=0.5, labelspacing=0.2)
    ax.set_xlabel("x")
    ax.set_ylabel("y")
    fig.savefig("test.png")
    plt.show()

# sec: Numba定型

@numba.jit(nopython=True, nogil=True, cache=True) # 高速化部のみ関数を分離 約50倍高速に
def numba_func(x):
    pass

# sec: entry

if __name__ == "__main__": main()