きり丸の技術日記

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

自組織のGitHubで似たusernameを区別しやすくする

始めに

小ネタ。GitHubのアカウントでusernameがかなり似た名前になることがあります。通知に含まれるusername自体は変更できないものの、Pull Requestの横にprofile nameを追加で表示することで判別しやすくする方法を見つけたので変更しました。

ちなみに私だと次の設定です。

  • username
    • hirotoKirimaru
  • profile name
    • 水上 皓登

環境

  • GitHub
    • 2025/07/05時点
    • privateリポジトリ
    • GitHub Team以上であること

ヘルプ

ヘルプを読んでください。

https://docs.github.com/ja/organizations/managing-organization-settings/managing-the-display-of-member-names-in-your-organization

ソースコード

なし

終わりに

基本的にはusernameが似ることは少ないのですが、本名を使用しているとどうしても似てしまう可能性がありますね。

最終的には末尾の番号で見分けられるようになったとはいえ、慣れるまでは表示されていると便利です。

np.nanをNoneに変換しないとDBアクセス時にエラーになることがある

始めに

※ 自宅で再現しなかったので、そういう事象が発生したということをメモするだけの記事。

FastAPIでアップロードされたCSVをもとに登録する処理を作っていました。そして、特定の条件でエラーになることに気づきました。しかし、エラーが発生行を確認しているとINSERT や UPDATEではなく、SELECTしたタイミングでエラーになっていることがわかりました。

今回の記事では、回避した方法を残します。

環境

  • Python
  • SQLAlchemy
  • MySQL

※ 再現しなかったのでバージョン不明

実装

特定の条件で発生していたエラーはnp.nanのパラメータを検索で使用していた時に発生していました。

query = select(User).where(User.id.in_([np.nan]))
# この検索時に発生
actual = (await db.execute(query)).scalars().all()

そのため、最も簡単な方法としてはnp.nanNoneに変換することで簡単に回避できます。都度、np.nanのチェックを入れる方法もあるのですが、メモリに余裕がある場合はこちらで一気に置換してしまったほうがコードの可読性も上がるし楽だと思います。

import pandas as pd
import numpy as np

# Sample DataFrameを作成します.
df = pd.DataFrame({'Column1': [1, 2, np.nan],
                   'Column2': [3, np.nan, 6],
                   'Column3': [7, 8, 9]})

df.replace({np.nan: None}, inplace=True)

ソースコード

なし

終わりに

発生後でブログにしようと考えていたのですが、その後にライブラリアップデートやPython本体のバージョン等のアップデートをかけてしまったせいで発生条件を見失ってしまいました。

更新時に変換できないパターンならともかく、検索時に変換できずにエラーになってしまうパターンを面白いと思ったタイミングですぐにブログにしてしまうべきでしたね。内容自体は薄いですが、そういうこともあるという周知ができればいいかなと思ってます。

FastAPIから型定義を出力する

始めに

小ネタ。

FastAPIからopenapi.jsonが出力できるなら、フロントエンドで使用する型定義まで出力する手順を確立したくて記事にします。    なお、フロントエンドはすでに構築されていたこともあり、自動生成した型定義の導入までは行えていません。また、FastAPIから型定義を出力する際にこういう工夫をしています、というコメント募集しています。

環境

  • FastAPI
    • 0.115.12
  • openapi-typescript
    • 7.8.0
  • @openapitools/openapi-generator-cli
    • 2.20.2

実装

OpenAPIファイルの取得

FastAPIの/openapi.jsonにアクセスするとopenapi.jsonファイルを取得できます。他の方法で出力することもできますが、これが一番簡単だと思います。

ファイルとして出力してもいいですが、そのままHTTPのままアクセスするのが手間がかからなくてオススメです。

openapi-typescript を使用する場合

一番簡単にd.tsを出力できます。人気が高いようなのでこれを利用した記事がいくつかありそうなのですが、私が想像していた直感的に欲しい型情報ではなかったです。フロントエンドはこういう使い方をするのかもしれませんが、使い方が私には分からなかったです。

bunx openapi-typescript http://localhost:8000/openapi.json -o src/types/api.d.ts

@openapitools/openapi-generator-cli を使用する場合

Javaをインストールする必要があります。前職で使用していたこともあり、apimodel等の分類ごとに細かく出力してくれるのが嬉しいポイントでした。

bunx @openapitools/openapi-generator-cli generate -i http://localhost:8000/openapi.json -g typescript-angular -o src/app/openapi

JetBrainsを使用している場合はすでにjavaが含まれているのでIDE上でファイル出力できます。ただし、WSLの場合だとファイルパスがWindowsとWSLで合わないため、\と/を書き換える必要がありました。

# IDEから出力されるコマンド
# パスに関しては %USERPROFILE% で書き換えていますが、/と\はそのままです
%USERPROFILE%\AppData\Local\Programs\WebStorm\jbr\bin\java.exe -jar %USERPROFILE%/AppData/Local/JetBrains/WebStorm2025.1/openapi/codegen/d1f8bb39b5817ae983385027d47d550c/openapi-generator-cli-7.7.0.jar generate -g typescript-angular -i %USERPROFILE%\AppData\Roaming\JetBrains\WebStorm2025.1\scratches\openapi.json -o %USERPROFILE%\gen --additional-properties=

この辺のIDE経由で実行する方法については、以前Javaを使っていた時にまとめていたので、参考にしてください。

ソースコード

なし。

終わりに

openapi-typescriptが一番人気ということはエコシステムも揃っていそうだったのですが、サンプルの次のコードを見て便利そうには思えなかったです。フロントエンドエンジニアとしては、これが一般的なんですかね…。

OpenAPI自体はいい仕組みだと思うので、フロントエンドでうまく使う方法をもっと理解していきたいです。

# 公式のサンプルコード
# https://www.npmjs.com/package/openapi-typescript

import type { paths, components } from "./my-openapi-3-schema"; // generated by openapi-typescript

// Schema Obj
type MyType = components["schemas"]["MyType"];

// Path params
type EndpointParams = paths["/my/endpoint"]["parameters"];

// Response obj
type SuccessResponse =
  paths["/my/endpoint"]["get"]["responses"][200]["content"]["application/json"]["schema"];
type ErrorResponse =
  paths["/my/endpoint"]["get"]["responses"][500]["content"]["application/json"]["schema"];