PyCharmでよく使うファイルのテンプレート

17/10/6 書いた後に追記しました

PyCharmには一定の書式に従って記述すればファイル作成時に変数を展開して作成出来るFile and Code Templateという機能がある。

オフィシャルサイトの説明

https://www.jetbrains.com/help/pycharm/file-and-code-templates.html

設定場所

File->Default Settings...->File and Code Template
を選択して「+」ボタンで新しく登録が出来る。

使用方法

• プロジェクト名を右クリックしてNewの項目内に作成した項目が選ぶことが出来る。
• もしくは、メニューのFile->New...を選択すると作成した項目が選ぶことが出来る。

main.py

Pythonに実行指定させるファイル用のテンプレート。
例えばmain.pyとしてファイルを作成して、コマンドプロンプト等を用いて作業ディレクトリ上でpython main.pyと実行させる。
18行目はPyInstaller用に作業ディレクトリを変更するスクリプト。

main.py

#! env python
# -*- coding: utf-8 -*-

import os
import sys

# ${PROJECT_NAME}.${NAME}
# Date: ${YEAR}/${MONTH}/${DAY}
# Filename: ${NAME} 

__author__ = '$USER'
__date__ ="${YEAR}/${MONTH}/${DAY}"


def main():
    # 作業ディレクトリを自身のファイルのディレクトリに変更
    os.chdir(os.path.dirname(os.path.abspath(sys.argv[0])))
    return


if __name__ == '__main__':
    main()
    return

PythonClass

クラス作成用テンプレート。
ファイルを作成すると、ファイル名がそのままクラス名になる。

class.py

#! env python
# -*- coding: utf-8 -*-

import os
import sys

# ${PROJECT_NAME}.${NAME}
# Date: ${YEAR}/${MONTH}/${DAY}
# Filename: ${NAME} 

__author__ = '$USER'
__date__ ="${YEAR}/${MONTH}/${DAY}"


class ${NAME}(object):
    def __init__(self):
        self.__ROOT = os.path.dirname(os.path.abspath(sys.argv[0]))
        self.__EXE_PATH = sys.executable
        self.__ENV_PATH = os.path.dirname(self.__EXE_PATH)
        self.__LOG = os.path.join(self.__ENV_PATH, 'log')
        return

readme.md

説明書用
Markdown形式の内容。プロジェクト内で「readme.md」ファイル作成してGitHubにアップロードしたら、このファイルがプロジェクトのトップに表示される。
エスケープ処理が出来なかったので\``` を ```に変更して使用。

readme.md

# Todo 修正したいところとか

- [ ] change in.
- [x] Success

# Overview 概要

${PROJECT_NAME}.${NAME}
Date: ${YEAR}/${MONTH}/${DAY}

# Description 詳細

Change me.

# create envs. 仮想環境の作り方

Assuming that conda is installed.
Condaがインストールされていることが前提。

### use 32bit. 64bit上で32bit環境を使う時用

```commandline
set CONDA_FORCE_32BIT=1
\```

```commandline
conda create -n ${PROJECT_NAME} python=3.5.3
\```

# Activation of Python environment. 仮想環境に入る

```commandline:for windows
activate ${PROJECT_NAME}
\```

```commandline:for mac
source activate ${PROJECT_NAME}
\```

# Requirement / install package. パッケージのインストール

```commandline
conda install numpy
\```

# Demo / Usage 使用例

```commandline
# Execution command.Be sure to activation.
python main.py
\```

# Licence ライセンス
[MIT](https://github.com/tcnksm/tool/blob/master/LICENCE)
</code>