きり丸の技術日記

技術検証したり、資格等をここに残していきます。

【Git】マージ済みのリモートブランチをローカルブランチから削除する

Gitでブランチを切って開発しているとローカルブランチはすぐに複数増えてしまいます。今回の記事では、リモートリポジトリが存在しない場合にローカルブランチもワンライナーで削除するためのメモ。

環境

  • Git
    • 2.34.1
  • WSL
    • Ubuntu 22.04.4 LTS

ゴール

マージや削除されたリモートリポジトリがある場合、ローカルのリポジトリも削除するのをワンライナーで行う。

コマンド

# マージ済(ローカル修正がない場合)のみ削除
git fetch --prune && git branch -vv | grep 'gone]' | awk '{print $1}' | xargs git branch -d
# ローカル修正があっても削除する
git fetch --prune && git branch -vv | grep 'gone]' | awk '{print $1}' | xargs git branch -D

解説

ChatGPTに解説してもらうのが一番分かりやすいと思うので、コマンドを貼り付けて解説してもらったものを転記しています。

  1. git fetch --prune
    1. リモートリポジトリからリモートブランチの更新を取得するコマンドです。--pruneオプションを追加することで、リモートで削除されたブランチの情報をローカルでも更新します。
  2. git branch -vv
    1. 各ローカルブランチの情報を詳細に表示します。このコマンドにより、ローカルブランチがどのリモートブランチを追跡しているか、そしてリモートブランチが存在するかどうか(goneと表示される)が分かります。
  3. grep 'gone]'
    1. grep コマンドは指定したパターンが含まれる行をフィルタリングします。この場合、'gone]'という文字列が含まれる行を抽出します。これは、対応するリモートブランチが消去されたことを示します。
  4. awk '{print $1}'
    1. awkコマンドはテキストをパースしたり整形したりするのに使います。'{print $1}'は各行の1番目のフィールド(つまりブランチ名)を出力します。
  5. xargs git branch -d
    1. xargs コマンドは、標準入力から文字列を読み込んで、その文字列を他のコマンドの引数として使います。ここでは、抽出したブランチ名が git branch -d (ブランチの削除コマンド)の引数として渡されます。また、-dオプションは、ブランチがすでにマージされている場合にのみ、ブランチを削除します。

終わりに

面倒だったので定期的に全てのブランチを一掃していましたが、ワンライナーで覚えたおかげで必要なブランチだけを削除できるようになって便利です。

FastAPIのHTTPExcrptionはログに出しても空文字列の可能性がある

FastAPIHTTPExceptionをログに出力しようとした時のメモ。

環境

  • Python
    • 3.12.3
  • FastAPI
    • 0.103.1
    • 0.110.0

対応

少し古いFastAPIのライブラリなら、reprを使用してシリアライズしてください。もし、strで検証しても空文字列でなければ、そのままでも問題ありません。

from fastapi import HTTPException

exc = HTTPException(status_code=404, detail='NOT_FOUND')
print(exc)
# '' # 空文字列の可能性がある
# 404: NOT_FOUND # 新しいとこっちのメッセージ
print(repr(exc))
# HTTPException(status_code=404, detail='NOT_FOUND')

原因

FastAPIHTTPExceptionStarletteHTTPExceptionを継承しています。

しかし、StarletteHTTPException__str__が2023年6月21日まで定義されていませんでした。そのため、FastAPIが依存しているStarletteのバージョンが古いとstrで文字列化しても空文字列が返却されます。

さらに詳細

PythonのExceptionは位置引数をログに出力してくれますが、キーワード引数はログに出力してくれないようです。

HTTPExceptionはstatus_codeとdetailというキーワード引数でパラメータ指定をするので、位置引数に何も設定されず、文字列化されなかったようです。

except節は例外名の後に変数を指定できます。その変数は例外インスタンスに紐付けられ、一般的には引数を保持する args 属性を持ちます。利便性のため、組み込み例外型には str() が定義されており、明示的に .args を参照せずとも すべての引数を表示できます。

ソースコード

なし。

終わりに

ログ出力するには単純に文字列化すればよいと考えていましたが、ちょっとハマってしまいました。

参考情報

Pythonのjinja2でマルチパートメールのテンプレートを取得する

Pythonでマルチパートメールを送る方法をブログにしました。しかし、前回の記事はファイルからテンプレートを取得していないので、マルチパートメールを実質運用できません。今回はjinja2を使用してファイルからテンプレートを取得することで実運用できるようにします。

環境

  • Python
    • 3.12.3
  • jinja2
    • 3.1.3
  • MailHog
    • v1.0.1

事前条件

前回記事をベースに、jinja2でファイルのテンプレートを取得できるようにする。

対応

テンプレートを格納する

HTMLファイルとテキストファイルを配備します。

今回の例では次のディレクトリにファイルを配備します。

  • src/resources/templates/signin.html
  • src/resources/templates/signin.txt

また、今回のテンプレートにはnameという変数を用意しています。

# src/resources/templates/signin.txt
Welcome to our platform, {{ name }}!

テンプレート読み込む

jinja2を用いてテンプレートを読み込みます。今回の例ではsrc/resources/templatesにメールテンプレートを配備しているので、FileSystemLoaderにディレクトリを渡します。また、レンダリングする際にパラメータが不足した時にエラーとなるようにEnvironmentundefinedを定義します。発生したエラーは次のようなものが発生します。

jinja2.exceptions.UndefinedError: 'name' is undefined

次のコードを元に、HTMLメールとテキストメールのテンプレートを読み込むようにします。

from jinja2 import Template, Environment, FileSystemLoader, StrictUndefined


@classmethod
def get_templates(cls, path: str):
    file_loader = FileSystemLoader("src/resources/templates")
    env = Environment(loader=file_loader, undefined=StrictUndefined)
    template_text = env.get_template(f"{path}.txt")
    template_html = env.get_template(f"{path}.html")

    return template_text, template_html

ファイルレンダリング

読み込んだテンプレートに変数を埋め込んで、メール送信できる文字列に変換します。

@classmethod
def build_body(cls, path: str, params={}):
    text, html = cls.get_templates(path)
    return text.render(**params), html.render(**params)

メソッドの呼び出し

ファイル名、パラメータのキーと値を渡せばファイルからテンプレートを読めます。

body_text, body_html = Mailer.build_body("signin", params={"name": "NAME"})

前回の記事と合わせて次のようなメソッドになります。

@classmethod
def send(cls) -> None:
    sender = "no-reply@example.com"
    receiver = "1@example.com"
    subject = "Python SMTP Mail Subject"
    body_text, body_html = Mailer.build_body("signin", params={"name": "NAME"})

    msg = EmailMessage()
    msg.set_content(body_text)
    msg.add_alternative(body_html, subtype="html")

    msg["Subject"] = subject
    msg["From"] = sender
    msg["To"] = receiver
    try:
        with SMTP(host=cls.host, port=cls.port) as smtp:
            smtp.send_message(msg)
    except Exception as e:
        print(f"Failed to send email. Error {str(e)}")
        raise e

ソースコード

今回のテスト用に少々テストコードを変更しています。

終わりに

取り急ぎ本番でも運用できる状態になったと思います。他にもjinja2には良さそうなオプションがあるので色々と素振りしたいですね。

類似情報