(M1 Mac)VSCode等に関する個人的メモ

(2024年の記事サルベージ)

初心者のメモ
※M1 Macではデフォルトのシェルがzshになっているため.zshrcに追記する
※コマンドプロンプトで.zshrcファイルを開くときは↓

open ~/.zshrc

Pythonのデフォルトバージョンの変更

コマンドプロンプトで「python -V」したときに自分でインストールしたPython3が表示されるよう変更。
以下の記事のとおりに行った。
https://qiita.com/Yiwen/items/715e4319bb14d52e3b8e

ターミナルの色分け

ホスト名等の部分がプログラムの実行結果と同色で見づらかったため変更した。
参考：https://teratail.com/questions/302780

1. コマンドプロンプトで.zshrcを開く
2. 以下を書き込み、保存
   「%F{色}　〜　%f」で囲むことで色を変更する。パラメータや色の指定については以下の記事の「プロンプトを書き換える」を参考にした。
   https://qiita.com/ktr_type23/items/3eb782f98c7a5f4c60b0

   # prompt
   PROMPT='%F{green}%m:%c %n%f$ '
   

3. VSCodeを再起動する

括弧やクォーテーションの自動補完について

文字列に後からクォーテーションをつけるときなど、デフォルトの自動補完の動作が不便だったため変更した。
以下の記事を参考に、括弧・引用符をbeforeWhitespaceに設定した。
https://qiita.com/BlueSilverCat/items/c245bd098396dc2eb656

仮想環境構築

仮想環境：そのプロジェクトのPython環境一式を格納したフォルダ

仮想環境内でpip installすればライブラリはその環境内にだけインストールされ、システム環境に影響を与えないため作成する。
Macのターミナルでやるとpipの対象がMac全体のPython環境（グローバル環境） になることがあり、別のプロジェクトと依存関係が競合するリスクがある。

VSCodeのターミナルで以下を実行する。

cd ~/myproject           # プロジェクトのフォルダへ(VSCodeでフォルダを開いていたら不要)
python3 -m venv .venv    # 仮想環境をプロジェクト直下に作成する venvも一般的

source venv/bin/activate # 仮想環境を起動

deactivate　　　　　　　　　# 仮想環境の終了

ターミナルが .venv m-MacBook-Pro:フォルダ名 ユーザー名$ に変わり、画面下のPythonのバージョンが3.x.x('.venv')になったらok
それを確認してからpipを実行する。

venvや.venvのように一般的な名前だと、プロジェクトフォルダを開いたときにVSCodeが自動認識してくれる事が多い。

環境変数ファイルを作成

環境変数：OSに登録されている「キーと値」のペアで、プログラムから読み込める設定情報のこと。

ユーザー名やパスワードなどの直接書き込みたくない情報を分けるため、環境変数用のファイルを作成する。
他人に共有するときはこのファイルを渡さない。
Gitを使っているなら.gitignoreに追加しておく。

1. プロジェクトフォルダ直下に.env（拡張子なし）という名前のファイルを作成する。作成は手動でも、 プロジェクトフォルダで「touch .env」を実行でもいい。
   作成したら以下のように記載していく。

   MY_APP_USERNAME=abcde
   MY_APP_PASSWORD=99999
   

2. .envファイルの内容を環境変数として読み込むためのライブラリをインストール

   install python-dotenv
   

3. プログラム内で以下のように記載する

   from dotenv import load_dotenv
   import os
   
   load_dotenv()  # カレントディレクトリの.envファイルを読み込む
   
   username = os.getenv("MY_APP_USERNAME")
   password = os.getenv("MY_APP_PASSWORD")
   

Gitの.gitignoreに追加

このファイルに記載するとGitで除外される。

.envファイルと同じように、プロジェクトフォルダ直下に.gitignore（拡張子なし）という名前のファイルを作成する。作成は手動でも、 プロジェクトフォルダで「touch .gitignore」を実行でもいい。
作成したら以下のように記載していく。

# 環境変数
.env

# 仮想環境
.venv/

# Pythonキャッシュ
__pycache__/
*.pyc

# ログファイル
*.log