🎄teratailクリスマスプレゼントキャンペーン2024🎄』開催中!

\teratail特別グッズやAmazonギフトカード最大2,000円分が当たる!/

詳細はこちら
コードレビュー

コードレビューは、ソフトウェア開発の一工程で、 ソースコードの検査を行い、開発工程で見過ごされた誤りを検出する事で、 ソフトウェア品質を高めるためのものです。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

Q&A

解決済

5回答

6929閲覧

「削除する/しない」を表すbool変数の命名

退会済みユーザー

退会済みユーザー

総合スコア0

コードレビュー

コードレビューは、ソフトウェア開発の一工程で、 ソースコードの検査を行い、開発工程で見過ごされた誤りを検出する事で、 ソフトウェア品質を高めるためのものです。

Python

Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

命名規則

命名規則は、プログラミングする際に識別子の名称である文字列を決める表記法のことです。ネーミング規則・ネーミング規約・命名規約とも呼びます。

0グッド

1クリップ

投稿2021/02/21 23:59

与えられたパス内の画像群を圧縮する簡単なCLIを書いています。
--cleanupというオプションが付いていれば元のデータを削除するのですが、これの変数名をどうするのが適切なのかが気になります。
can_cleanupis_allowed_to_clceanup, is_able_to_cleanupでは「必ず削除する」という二者択一のニュアンスが薄いように感じます。
個人的にはwill_cleanupがしっくりくるのですが、真偽値にwillを使っているものは検索した限りではあまり見当たりません。

業務としてコードを書いている方の意見を伺いたいです

python

1!/usr/bin/env python3 2import argparse 3 4 5def main() -> None: 6 parser = argparse.ArgumentParser() 7 parser.add_argument("--cleanup", action="store_true") # 処理が終わったあとに元のデータを削除するかのフラグ 8 parser.add_argument("-p", "--path") 9 parser.add_argument("-q", "--quality", type=int) 10 args = parser.parse_args() 11 cleanup = args.cleanup # 良い変数名は? 12 ... 13 14 15if __name__ == "__main__": 16 main()

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

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答5

0

する/しないなら

do_(true=する、false=しない)

かな。

投稿2021/02/22 00:42

momon-ga

総合スコア4826

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

ベストアンサー

「~する」と名付けたいならdo_cleanupがよいかと思います。
また、bool型には一貫して(文法的に少々奇妙でも)is_を付ける習慣もありますので、is_do_cleanupも考えられます。

投稿2021/02/22 00:43

ikadzuchi

総合スコア3047

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

オプションが--cleanupなのであればcleanupで良い気がします。
(例示されているものに加え、will_cleanupにしてもかなり弱いニュアンスだと感じます。)

自分が名付けるなら、既存のアーカイバに倣って
remove-file(tarの場合)

move(zipの場合)
あたりにし、オプション名もそれに合わせるかと思います。

投稿2021/02/22 00:16

tanat

総合スコア18727

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

オプションが指定されるまで「削除」されておらず、かつ「削除できる」状態なのでdeletableとかで良いんじゃね?と思ったり。
cleandeleteが違うニュアンスを持ってるとダメだけど。

投稿2021/02/22 02:10

gentaro

総合スコア8947

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

将来のデバッグや機能追加のことを考えると、識別子_cleanupとすることをお勧めします。
識別子はコマンドラインオプションであることを示す一文字から三文字を決めておき、これから作るプログラムでなるべく変えないようにします。
co(commandline option)とか、argとかが分かりやすいでしょう。
それぞれの場合に、co_cleanupとかarg_cleanupということになります。

投稿2021/02/22 00:59

ppaul

総合スコア24670

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.36%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問