APIリファレンス (API Reference)

DataFrame アクセサ (.ja)

polars.DataFrame に追加される .ja アクセサのメソッドです。

polars_japanese.common.JapaneseDataFrame

write_csv(path, encoding='utf-8', **kwargs)

指定されたエンコーディングでDataFrameをCSVファイルに書き込みます。

Parameters:

Name	Type	Description	Default
path	Union[str, Path]	CSVファイルを書き込むパス。	required
encoding	str	出力ファイルに使用するエンコーディング。 デフォルトは "utf-8"。	'utf-8'
**kwargs	Any	polars.DataFrame.write_csv に 渡される追加のキーワード引数。	{}

Raises:

Type	Description
LookupError	指定されたエンコーディングが無効な場合に発生します。

Examples:

>>> import polars as pl
>>> import polars_japanese # noqa: F401
>>> df = pl.DataFrame({"col1": ["テスト", "一"], "col2": [1, 2]})
>>> # Shift-JISエンコーディングでCSVに書き込む
>>> # df.ja.write_csv("output.csv", encoding="shift_jis")

Expression アクセサ (.ja)

polars.Expression に追加される .ja アクセサのメソッドです。

polars_japanese.common.JapaneseExpr

to_half_width()

エクスプレッションの文字列に含まれる全角文字を半角に変換します。 カタカナ、ASCII、数字に適用されます。

Returns:

Type	Description
Expr	pl.Expr: 半角に変換された文字列を含むエクスプレッション。

to_full_width()

エクスプレッションの文字列に含まれる半角文字を全角に変換します。 カタカナ、ASCII、数字に適用されます。

Returns:

Type	Description
Expr	pl.Expr: 全角に変換された文字列を含むエクスプレッション。

normalize()

式内の日本語テキストを正規化します。

まずNFKC正規化を適用し、その後以下の特定のルールを適用します： - ハイフン/マイナス記号を半角'-'に統一 - 長音記号を全角'ー'に統一 - チルダを全角'～'に統一 - 感嘆符を半角'!'に統一 - 疑問符を半角'?'に統一 - スペースを半角スペース' 'に統一

正規化ルールは以下を参考にしています： https://github.com/ikegami-yukino/jaconv

Returns:

Type	Description
Expr	pl.Expr: 正規化された文字列を表す式

to_datetime(format='%-K%-y年%m月%d日', raise_error=True)

和暦文字列を Polars の Date 型に変換します。

Parameters:

Name	Type	Description	Default
format	str	和暦のフォーマット文字列。	'%-K%-y年%m月%d日'
raise_error	bool	変換エラー時に例外を発生させるかどうか。	True

Returns:

Type	Description
Expr	pl.Expr: Date 型に変換されたエクスプレッション。

References

https://japanera.readthedocs.io/en/latest/

to_wareki(format='%-K%-Y年%m月%d日', raise_error=True)

エクスプレッションのDateまたはDatetimeを和暦の文字列形式に変換します。

Parameters:

Name	Type	Description	Default
format	str	出力する和暦のフォーマット文字列。	'%-K%-Y年%m月%d日'
raise_error	bool	変換エラー時に例外を発生させるかどうか。	True

Returns:

Type	Description
Expr	pl.Expr: 和暦文字列に変換されたエクスプレッション。

References

https://japanera.readthedocs.io/en/latest/

to_kanji(config=None)

エクスプレッションのIntを漢数字の文字列形式に変換します。

Parameters:

Name	Type	Description	Default
config	Optional[KanjizeConfiguration]	kanjize の設定。	None

Returns:

Type	Description
Expr	pl.Expr: 漢数字文字列に変換されたエクスプレッション。

References

https://github.com/nagataaaas/kanjize

to_number()

エクスプレッションの漢数字を数値に変換します。

Returns:

Type	Description
Expr	pl.Expr: 数値に変換されたエクスプレッション (Int64)。

References

https://github.com/nagataaaas/kanjize

is_holiday()

指定された日付が祝日かどうかを判定します。

Returns:

Type	Description
Expr	pl.Expr: 祝日の場合は True、そうでない場合は False を含む Boolean エクスプレッション。

is_business_day()

指定された日付が営業日かどうかを判定します。 (土日祝日でない場合に True)

Returns:

Type	Description
Expr	pl.Expr: 営業日の場合は True、そうでない場合は False を含む Boolean エクスプレッション。

to_weekday_name(format='%A')

Date型またはDatetime型のエクスプレッションを日本語の曜日文字列に変換します。

入力データがNoneの場合はNoneを返します。

Parameters:

Name	Type	Description	Default
format	str	出力フォーマット。 "%A" (デフォルト): "月曜日", "火曜日", ... "%a": "月", "火", ...	'%A'

Returns:

Type	Description
Expr	pl.Expr: 日本語の曜日文字列を含むエクスプレッション。

Raises:

Type	Description
ValueError	サポートされていないフォーマットが指定された場合。

to_jst(time_zone=None)

Datetime型のエクスプレッションを日本標準時(JST, UTC+9)に変換します。

Parameters:

Name	Type	Description	Default
time_zone	str | None	入力データのタイムゾーン。 Noneの場合、naive datetimeはUTCとみなされます。 タイムゾーンが指定された場合、入力データはそのタイムゾーンとして解釈されます。	None

Returns:

Type	Description
Expr	pl.Expr: 日本標準時(JST)に変換されたDatetime型のエクスプレッション。

都道府県関連アクセサ (.ja.pref)

polars.Expression に追加される .ja_pref アクセサを通じて利用できる都道府県関連の処理です。

polars_japanese.prefecture.PrefectureExpr

to_code()

都道府県名（漢字、ひらがな、カタカナ、ローマ字、コード）を都道府県コードに変換します。

表記揺れ（「県」の有無など）も吸収します。 該当しない場合はnullになります。

to_kanji()

都道府県名またはコードを正式な漢字表記（例:「東京都」「神奈川県」）に変換します。

入力が都道府県名の場合、まずコードに変換してから漢字表記にします。 該当しない場合はnullになります。

to_hiragana()

都道府県名またはコードを正式なひらがな表記に変換します。

該当しない場合はnullになります。

to_katakana()

都道府県名またはコードを正式なカタカナ表記に変換します。

該当しない場合はnullになります。

to_romaji()

都道府県名またはコードを一般的なローマ字表記に変換します。

該当しない場合はnullになります。

to_region()

都道府県名またはコードを地方名に変換します。

該当しない場合はnullになります。 地方： - 北海道 - 東北 - 関東 - 中部 - 近畿 - 中国 - 四国 - 九州・沖縄