CommandError: ‘アプリ名’ is not a valid app name. エラー対処法

どうも、ウツボウです♪
命名規則とは、名前をつける際のルールになりますが、アプリ開発を行う上でも存在します。が、うっかりルールを確認し損ねて、エラーになってしまうこともありますよね？？そこで、本記事では、PyhtonのWebフレームワークであるDjangoでアプリを作る際に発生した「CommandError: ‘○○○’ is not a valid app name. 」というエラーの対処法をご紹介させて頂きます。

本記事の環境は、Django4.0, Pyhton3.10.1になります。

今回は発生したエラーについて

さて、今回、発生したエラーは、「CommandError: ‘アプリ名’ is not a valid app name. 」ですが、何が原因で発生したのでしょうか?? 理由は、シンプルで、冒頭でもお話させて頂いた通り、Pyhtonの命名規則(名前をつける際のルール)に従って、アプリ名を決めていないからです。
もし、他の言語ではエラーになった書き方がOKであっても各々でルールがあり、各自でそのルールを確認し、守った上で作業を行う必要があります。

以下は、実際にエラー発生した時の様子です。

「えっ、hello-testだめなの？？」 と思われた方もいるかと思いますが、これについては、次の項目(Pyhton:命名規則)で解説致しますので、確認しておきましょう。

Pyhton:命名規則

Djangoは、PythonのWebフレームワークですので、Pyhtonの命名規則をベースにコーディングしていきます。実際に公表されている規則は、変数/定数から関数, クラス… の定義まで関係してきますので、しっかりと覚えておきましょう

Pyhtonの命名規則として主に用いられているのは、以下の二つです。 何故、hello-testという名前でアプリを作ろうとすると、エラーになるのかもこちらが関係しております。
「 -(ハイフン) 」で単語間をつなぐのは、ケバブケースであり、Pyhtonでは用いられていない規則のため、名前を決める上で、-(ハイフン)は使ってはいけないということになります。

では、次に変数や関数などでは、どちらのケースが推奨とされているかをチェックしていきましょう。

定数だけ、*1となっていると思います。 他は全て英単語を小文字で書きますが、定数のみは、全部大文字で書く必要があります。 例えば、「 TEST_SAMPLE 」 みたいな感じです。

 

対処法

最後に、エラーになったままではいけませんので、エラーになったコマンドを次のように修正し、再度、アプリを作成してみます。

pyhton3 manage.py startapp hello_test

すると、コマンドを実行してもエラーはなくなりました！！

以下のようにプロジェクトフォルダ内にもしっかりとhello_testが作成されておりますので、無事にアプリの作成が出来たことが分かります。

まとめ