質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.93%

pygameソース内のコメントの->の意味は?

解決済

回答 3

投稿

  • 評価
  • クリップ 0
  • VIEW 1,556

score 37

前提・実現したいこと

現在、「ゲームを作りながら楽しく学べるPythonプログラミング」という本で
pygameを使って学習しています。

例として円を描画するcircle()メソッドがあるのですが、IDEで定義を見ると
以下のように書かれています。

def circle(Surface, color, pos, radius, width=0): # real signature unknown; restored from __doc__
    """
    circle(Surface, color, pos, radius, width=0) -> Rect
    draw a circle around a point
    """
    pass


"""に囲まれている部分は、コメントでメソッドの説明だと思うのですが
「-> Rect」
の部分の意味がはっきりと分かりません。

おそらく、返り値の種類などを示しているのではと思うのですが。
この書き方は、pythonでのコメントやメソッドの説明時の慣習だったりするのでしょうか?
それとも、規約などがあったりするのでしょうか?

よろしくお願いします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 3

+4

    circle(Surface, color, pos, radius, width=0) -> Rect

このように 関数シグネチャ -> 返すもの 形式でdocstringを提供するのは、pythonのC実装関数(主に組み込み関数等)で関数のヘルプドキュメントを提供するときの書き方です。規約は見つけられませんでした(知ってる方いたら教えてください)ので、おそらく慣習ということになります。

例えばstrのdocstringを見ると以下のように表示されます。

>>> help(str)
Help on class str in module builtins:

class str(object)
 |  str(object='') -> str
 |  str(bytes_or_buffer[, encoding[, errors]]) -> str

これはPython本体での例ですが、pygameなどのC実装された関数を提供するライブラリでは、この記法で表示するようにdocstringを合わせていると思います。


以下、オマケ情報です。

Pythonの関数、メソッドは常にこのようにdocstringを書くのが正しいかというと、C実装ではないPure Python関数などでは書くべきではありません。
https://www.python.org/dev/peps/pep-0257/ では、 The one-line docstring should NOT be a "signature" reiterating the function/method parameters (which can be obtained by introspection) という説明があり、書くべきでは無いとされています。


他の方が書かれているように、Pure Pythonの関数宣言に型情報を書けるようになったのが、型アノテーション、型ヒント、type hintsと呼ばれるものです。これはpygameのdocstringとは別ですが、これによって、Pure Pythonの世界で ->
の記法を文法化して、コードの一部として書けるようになりました。(一次情報が見つからなかったので推測ですが、CPython関数で -> のように慣習(?)で書かれていた記法の影響を受けているんじゃないかなあ。)

初めは、文法だけがPython3で導入され、Python 3.5ではtype hintsが正式に導入されました。以下のように書けます。

def get_something(age:int) -> str:
    ...

type hints は規約、文法の規定があります。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

checkベストアンサー

+1

Pythonは動的型付け言語です。
たまに勘違いする人がいるのですが、型自体は確かに存在します。

コーディングをする際、型を明示したいときに、型ヒントが用いられます。
こちらのページが非常に参考になります。

def greeting(name: str) -> str:
   return 'Hello ' + name

このように、引数の型と戻り値の型を明示することが出来るのです。
(使い方を間違えてもエラーは出ませんが、IDEが警告を出すことはあります。)

この型ヒントをベースに、戻り値の型をコメントしているのでしょう。

追記
型ヒントは便利ですが、あんまり多用するとPythonらしい型の簡潔さを失います。
ほどほどに使うのが良いでしょうね。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

pygameのオブジェクトの意味だと思います。rectangleの略だと思います。

参考
http://westplain.sakuraweb.com/translate/pygame/Rect.cgi

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/10/07 22:08

    回答ありがとうございます。
    ということはpygameを作った人がこういう書き方をしているだけで
    ->が返り値を示す規約などは特にないのですね。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.93%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る