imoniの開発Blog

    前回、 Python を使って、ビットコインの価格を取得してみました。

    それから、Python をもうちょっと触って感じたことを書きます。


    Pylint の警告

    Visual Studio Code で Python をコーディングしようとすると、

    Pylint

    のインストールを促されました。

    Pylint はコードチェッカーのようです。


    Pylint をインストールして、コーディングをしていると、

    C0103:Invalid function name "Hoge"
    C0111:Missing function docstring

    というような警告が複数表示されました。


    最初は、Python のコードを動かすことを重視して、警告を無視していましたが、やっぱり気になります。

    しかし、いまいち警告の意味が分からず、調べてみました。


    Python の命名規則

    まずは、

    C0103:Invalid function name "Hoge"

    という警告について調べてみました。

    そして、

    Pylint の警告を非表示にする

    というような記事をいくつか見かけました。

    しかし、「警告が目障りだから非表示にする」はちょっと違うように思います。

    もう少し調べてみると、

    モジュール名(ファイル名)、パッケージ名(フォルダ名)、関数名は、すべて小文字を使う

    という命名規則の情報を見つけました。


    ということで、ファイル名、関数名を小文字にしてみると・・・

    「C0103」の警告が消えました!

    Python にはそんな命名規則があったんですね。

    というか、Python のコードチェッカーって、命名規則までチェックするんですね。


    ちなみに

    関数名などの前にアンダースコア「_」をつける

    と、モジュール内部で使用するプライベートな関数になるみたいです。


    説明を記述する

    次に、

    C0111:Missing function docstring

    という警告について調べてみました。

    この警告については、すぐに見つかり

    モジュール(ファイル)、関数の説明を記述する

    ということがわかりました。

    def hoge():
        """
        説明文
        """
        # 以下処理
        ...
        return hogehoge
    

    という感じに「ダブルクォーテーション」三つで囲う形にするようです。

    こんなのも警告に出るんですね・・・


    警告に戸惑ったが

    Pylint の警告が厳しめに出るので、結構戸惑いましたが、 警告が出ないように書けば、ある程度コーディング規約を守っているということになるので、 良いことかもしれませんね。


    「ルールにこだわりすぎないように」が前提ルール

    という情報も見つけました。

    だから、「警告を非表示にする」設定ができるようになっているのですね。


    まだ Python を触りだして日が浅いので、勉強しながらいろいろと動かしていきたいと思います。


    コメント

      コメントを投稿する