「Pythonのドキュメンテーションって何？」「Pythonでアノテーションって何？」という疑問や悩みを持っていませんか？
そんな悩みや疑問を解消できるように、この記事ではPythonのドキュメンテーションとアノテーションについて解説しています。
この講座は、これからPythonを学ぼうとする初心者の方がPythonの基本を学ぶための講座です。
Pythonの代表的な構文の使い方を具体的なコードを例にして解説しています。
この記事は、以下のような方におすすめ！
Python関数や引数の説明を記述する方法を知りたい方
Pythonの基本について知りたい方
関数は自由に定義することができますが、どういう処理をする関数なのか説明を残したい場合がありますよね。
それを解決できるのが、ドキュメンテーションやアノテーションです。
この記事を読めば、Pythonのドキュメンテーションとアノテーションについて学ぶことができます！
Pythonの基本をマスターして、Pythonプログラマーとしての一歩を踏み出しましょう！
前回の振り返り
前回の記事では、Pythonのlambda式とpass文について解説しました。
どちらも関数を定義する上で知っておくと、とても便利にコーディングすることができます。
Pythonのlambda式とpass構文について確認できていない方は、こちらの記事もチェックしておきましょう。
今回のゴール
では、改めて今回のゴールを確認しましょう。
今回のゴールは、Pythonのドキュメンテーションとアノテーションについて学び、実際に動作を確認することです。
難しい内容ではありませんが、ご自身でも実際に手を動かして動きを確認してみてくださいね！
Python関数に説明や注釈をつける方法
ドキュメンテーション
ドキュメンテーションとは文章のことですが、Pythonでは関数の説明や注意事項を関数の定義内に持たせることができます。
これはコード内に記述するコメントではなく、関数利用者がプロパティを介して参照することができます。
次に使用例をみてください。
# 関数にドキュメンテーションを記述
def SayHello():
"""Just say 'Hello.'"""
return print('Hello.')
# 関数説明を出力
SayHello.__doc__Just say 'Hello.'アノテーション
アノテーションは注釈のことで、Pythonでは関数引数に型の注釈をつけることができます。
Python自体は、変数定義時に型を指定しない言語ですが、明示的に肩を宣言することができます。
また戻り値にも同様に注釈をつけることができます。
型を示すことで、意図しない引数や出力値になってしまう不具合の発生を減らすことができます。
# 引数と戻り値にアノテーションをつけて定義
def SayHello(dep: str, des: str) -> str:
"""Just say 'Hello.'"""
print("Annotations:", SayHello.__annotations__)
message = 'Hello'
if des != "":
message = message + ', ' + des
if dep != "":
message = dep + ' say \'' + message + '.\''
return print(message)
# 引数に適当な値を渡して関数を呼び出す
SayHello('Eri','Bob')Annotations: {'dep': <class 'str'>, 'des': <class 'str'>, 'return': <class 'str'>}
Eri say 'Hello, Bob.'アノテーションが出力されていることがわかりますよね。
ですが、あくまでこれは注釈です。
引数に異なる型の値を指定してもエラーにはなりません。
まとめ
今回の記事では、Pythonのドキュメンテーションとアノテーションについて解説しました。
今回のポイントをまとめると、次のとおりです。
- Pythonでは、関数に説明や、引数と戻り値に注釈をつけることができる。
- ただし、これはあくまで説明や注釈に過ぎず、注釈と異なる型の値を渡してもエラーにはならない。
丁寧にドキュメンテーションやアノテーションを記述している場合は、今回のように呼び出すことができたり、エディタが対応していれば、マウスオーバーなどで表示されたりします。
関数の動作には直接影響はしませんが、関数周辺の知識として知っておくと便利です。
ぜひこの記事を参考にして、Pythonのドキュメンテーションとアノテーションをマスターしよう！
以上、最後までお読みいただきありがとうございました。
未経験からのITエンジニア転職に挑戦したい方へ
転職も含めて真剣にプログラミングスキルを手に入れたいとお考えの方に、おすすめの方法をご紹介します。
結論から言うと、それは転職活動とスキル学習を同時に進める方法です！
同時に進める理由は、転職成功までの時間を短縮するためなんですが、
でも昼間は学校や本業もあるのに、転職活動と学習を同時にって無理！
って思いますよね？
そんな忙しい方には、スキル学習と転職サポートが一体となているウズカレITがオススメ！
しかも、学習サポートも転職サポートも無料で利用できます！
ウズカレITはITスクールのウズウズカレッジを運営する企業uzuzのサービスだから
体系的かつ総合的に学習サポートを受けることができます。
ITエンジニアはまだまだ売り手市場で、未経験可の求人もたくさんあります。
一度、ウズカレITの無料相談で不安に思ってることなどを相談してみるのがオススメです。
