Pythonをやるときに参考になりそうな情報

最近あんまり触っていなかったので、久々にPythonをやろうと思ったときにいろいろ忘れてたり、新しく知ったりしたこともあったので、Pythonやるときに参考になりそうな情報をまとめました (但し、今回はデータ分析系のライブラリ関連は除いています)

Pythonの言語仕様や基本等

概要 — Python 3.5.2 ドキュメントdocs.python.jp

qiita.com

www.python-izm.com

2系と3系の違い

postd.cc

qiita.com

コーディング規約

はじめに — pep8-ja 1.0 ドキュメント

ドキュメント生成

azunobu.hatenablog.com

ドックストリング

""" 3重ダブルクォートを使用して記載する。ドックストリングに記述したテキストは関数やクラスオブジェクトの__doc__に保存される

def hello():
    """Output hello"""
    print("Hellow world")
    
hello.__doc__

オンラインヘルプ

help()というビルドイン関数を使うとオンラインヘルプが表示できる

help(hello)

または、下記のコマンドで、manコマンドのようにオンラインヘルプを表示してくれる

$ pydoc sys

-wオプションでhtmlファイルを生成する

$ pydoc -w sys

Docstring formats

Sphinx(reST)

Pypyで標準で使用されている。reStructuredText(reST)という記法で記述する。

ざっくりと下記のようなイメージ

def sample_method(self, param1)
    """
    :param param1 str: Description of param1
    :return: Description of what is return
    :raises MyError: Description of my error
    """

詳しくは、Sphinx日本ユーザ会を見てもらうほうがいいです

sphinx-users.jp

Google style

Google コーディング規約でSphinxで以下のような書き方をするらしい

"""
This is an example of Google style.

Args:
    param1: This is the first param.
    param2: This is a second param.

Returns:
    This is a description of what is returned.

Raises:
    KeyError: Raises an exception.
"""

Google Python Style Guide

Epydoc(Epytext)

javadoc風な感じで書ける

"""
This is a javadoc style.

@param param1: this is a first param
@param param2: this is a second param
@return: this is a description of what is returned
@raise keyError: raises an exception
"""

Epydoc