PIL パッケージ (残りのモジュールの自動ドキュメント)

ドキュメントがまだ移植または作成されていないモジュールのリファレンスはここにあります。

PIL モジュール

exception PIL.UnidentifiedImageError

ベース: OSError

画像を開いて識別できない場合に PIL.Image.open() で発生します。

PNG 画像でこのエラーが発生した場合、ImageFile.LOAD_TRUNCATED_IMAGES を true に設定すると、画像が開ける可能性があります。この設定は、欠落データやチェックサムエラーを無視します。

BdfFontFile モジュール

X Bitmap Distribution Format (BDF) を解析します

class PIL.BdfFontFile.BdfFontFile(fp: BinaryIO)

ベース: FontFile

X11 BDF 形式用のフォントファイルプラグイン。

PIL.BdfFontFile.bdf_char(f: BinaryIO) → tuple[str, int, tuple[tuple[int, int], tuple[int, int, int, int], tuple[int, int, int, int]], Image] | None

ContainerIO モジュール

class PIL.ContainerIO.ContainerIO(file: IO, offset: int, length: int)

ベース: IO

既存のファイル (たとえば TAR ファイル) の一部への読み取りアクセスを提供するファイルオブジェクト。

close() → None

fileno() → int

flush() → None

isatty() → bool

read(n: int = -1) → AnyStr

データを読み込みます。

パラメータ:

n – 読み込むバイト数。省略、ゼロ、または負の場合は、領域の末尾まで読み込みます。

戻り値:

8ビット文字列。

readable() → bool

readline(n: int = -1) → AnyStr

テキストの1行を読み込みます。

パラメータ:

n – 読み込むバイト数。省略、ゼロ、または負の場合は、行末まで読み込みます。

戻り値:

8ビット文字列。

readlines(n: int | None = -1) → list[AnyStr]

テキストの複数行を読み込みます。

パラメータ:

n – 読み込む行数。省略、ゼロ、負の値、または None の場合は、領域の末尾まで読み込みます。

戻り値:

8ビット文字列のリスト。

seek(offset: int, mode: int = 0) → int

ファイルポインタを移動します。

パラメータ:

• offset – バイト単位のオフセット。

• mode – 開始位置。領域の先頭には 0、現在のオフセットには 1、領域の末尾には 2 を使用します。定義された領域外にポインタを移動することはできません。

戻り値:

領域の先頭からのオフセット（バイト単位）。

seekable() → bool

tell() → int

現在のファイルポインタを取得します。

戻り値:

領域の先頭からのオフセット（バイト単位）。

truncate(size: int | None = None) → int

writable() → bool

write(b: AnyStr) → NoReturn

writelines(lines: Iterable) → NoReturn

FontFile モジュール

class PIL.FontFile.FontFile

基底クラス: object

ラスタフォントファイルハンドラの基底クラス。

bitmap: Image | None = None

compile() → None

メトリクスとビットマップを作成します

save(filename: str) → None

フォントを保存します

PIL.FontFile.puti16(fp: BinaryIO, values: tuple[int, int, int, int, int, int, int, int, int, int]) → None

ネットワークオーダー (ビッグエンディアン) の16ビットシーケンスを書き込みます

GdImageFile モジュール

注意

この形式は自動的に認識できないため、PIL.Image.open() で使用するためにクラスが登録されていません。gdファイルを開くには、代わりに PIL.GdImageFile.open() 関数を使用してください。

警告

GD形式はデータ交換用に設計されていません。この実装は、便宜上およびデモンストレーション目的でのみ提供されています。

class PIL.GdImageFile.GdImageFile(fp: StrOrBytesPath | IO[bytes], filename: str | bytes | None = None)

ベースクラス: ImageFile

GD非圧縮形式用の画像プラグイン。この形式は標準の PIL.Image.open() 関数ではサポートされていないことに注意してください。このプラグインを使用するには、PIL.GdImageFile モジュールをインポートし、PIL.GdImageFile.open() 関数を使用する必要があります。

format: str | None = 'GD'

format_description: str | None = 'GD 非圧縮画像'

PIL.GdImageFile.open(fp: StrOrBytesPath | IO[bytes], mode: str = 'r') → GdImageFile

GD画像ファイルからテクスチャをロードします。

パラメータ:

• fp – GDファイル名、または開かれたファイルハンドル。

• mode – オプションのモード。このバージョンでは、mode引数が指定されている場合、それは「r」でなければなりません。

戻り値:

画像インスタンス。

発生する例外:

OSError – 画像を読み取ることができなかった場合。

GimpGradientFile モジュール

カーブセグメントをパレット値に変換するための処理 (GIMPの対応するコードから派生、Federico Mena Quintero氏が作成。詳細については、GIMPの配布資料を参照してください。)

PIL.GimpGradientFile.EPSILON = 1e-10

class PIL.GimpGradientFile.GimpGradientFile(fp: IO[bytes])

ベースクラス: GradientFile

GIMPのグラデーション形式用のファイルハンドラー。

class PIL.GimpGradientFile.GradientFile

基底クラス: object

getpalette(entries: int = 256) → tuple[bytes, str]

gradient: list[tuple[float, float, float, list[float], list[float], Callable[[float, float], float]]] | None = None

PIL.GimpGradientFile.SEGMENTS = [<function linear>, <function curved>, <function sine>, <function sphere_increasing>, <function sphere_decreasing>]

PIL.GimpGradientFile.curved(middle: float, pos: float) → float

PIL.GimpGradientFile.linear(middle: float, pos: float) → float

PIL.GimpGradientFile.sine(middle: float, pos: float) → float

PIL.GimpGradientFile.sphere_decreasing(middle: float, pos: float) → float

PIL.GimpGradientFile.sphere_increasing(middle: float, pos: float) → float

GimpPaletteFile モジュール

class PIL.GimpPaletteFile.GimpPaletteFile(fp: IO[bytes])

基底クラス: object

GIMPのパレット形式のファイルハンドラ。

getpalette() → tuple[bytes, str]

rawmode = 'RGB'

ImageDraw2 モジュール

(実験的) WCK スタイルの描画インターフェース操作

参照

PIL.ImageDraw

class PIL.ImageDraw2.Pen(color: str, width: int = 1, opacity: int = 255)

基底クラス: object

輪郭の色と幅を格納します。

class PIL.ImageDraw2.Brush(color: str, opacity: int = 255)

基底クラス: object

塗りつぶしの色を格納します。

class PIL.ImageDraw2.Font(color: str, file: StrOrBytesPath | BinaryIO, size: float = 12)

基底クラス: object

TrueTypeフォントと色を格納します。

class PIL.ImageDraw2.Draw(image: Image | str, size: tuple[int, int] | list[int] | None = None, color: float | tuple[float, ...] | str | None = None)

基底クラス: object

(実験的) WCK スタイルの描画インターフェース

flush() → Image

render(op: str, xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, brush: Brush | Pen | None = None, **kwargs: Any) → None

settransform(offset: tuple[float, float]) → None

変換オフセットを設定します。

arc(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, start: float, end: float, *options: Any) → None

指定された境界ボックスの内側で、開始角度と終了角度の間で円弧（円のアウトラインの一部）を描画します。

参照

PIL.ImageDraw.ImageDraw.arc()

chord(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, start: float, end: float, *options: Any) → None

arc() と同じですが、終点を直線で接続します。

参照

PIL.ImageDraw.ImageDraw.chord()

ellipse(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, *options: Any) → None

指定された境界ボックスの内側に楕円を描画します。

参照

PIL.ImageDraw.ImageDraw.ellipse()

line(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, *options: Any) → None

xy リスト内の座標間に線を描画します。

参照

PIL.ImageDraw.ImageDraw.line()

pieslice(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, start: float, end: float, *options: Any) → None

arcと同じですが、終点と境界ボックスの中心の間に直線も描画します。

参照

PIL.ImageDraw.ImageDraw.pieslice()

polygon(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, *options: Any) → None

多角形を描画します。

多角形の輪郭は、指定された座標間の直線と、最後の座標と最初の座標間の直線で構成されます。

参照

PIL.ImageDraw.ImageDraw.polygon()

rectangle(xy: Sequence[float] | Sequence[Sequence[float]], pen: Pen | Brush | None, *options: Any) → None

長方形を描画します。

参照

PIL.ImageDraw.ImageDraw.rectangle()

text(xy: tuple[float, float], text: AnyStr, font: Font) → None

指定された位置に文字列を描画します。

参照

PIL.ImageDraw.ImageDraw.text()

textbbox(xy: tuple[float, float], text: AnyStr, font: Font) → tuple[float, float, float, float]

指定されたテキストの境界ボックス（ピクセル単位）を返します。

戻り値:

(left, top, right, bottom) 境界ボックス

参照

PIL.ImageDraw.ImageDraw.textbbox()

textlength(text: AnyStr, font: Font) → float

指定されたテキストの長さ（ピクセル単位）を返します。これは、後続のテキストをオフセットする量です。

参照

PIL.ImageDraw.ImageDraw.textlength()

ImageMode モジュール

class PIL.ImageMode.ModeDescriptor(mode: str, bands: tuple[str, ...], basemode: str, basetype: str, typestr: str)

ベース: NamedTuple

モード文字列のラッパー。

bands: tuple[str, ...]

フィールド番号 1 のエイリアス

basemode: str

フィールド番号 2 のエイリアス

basetype: str

フィールド番号 3 のエイリアス

mode: str

フィールド番号 0 のエイリアス

typestr: str

フィールド番号 4 のエイリアス

PIL.ImageMode.getmode(mode: str) → ModeDescriptor

指定されたモードのモード記述子を取得します。

PaletteFile モジュール

class PIL.PaletteFile.PaletteFile(fp: IO[bytes])

基底クラス: object

Teragonスタイルのパレットファイルのファイルハンドラ。

getpalette() → tuple[bytes, str]

rawmode = 'RGB'

PcfFontFile モジュール

class PIL.PcfFontFile.PcfFontFile(fp: BinaryIO, charset_encoding: str = 'iso8859-1')

ベース: FontFile

X11 PCF形式のフォントファイルプラグイン。

name = 'name'

PIL.PcfFontFile.sz(s: bytes, o: int) → bytes

PngImagePlugin.iTXt クラス

class PIL.PngImagePlugin.iTXt(text: str, lang: str | None = None, tkey: str | None = None)

ベース: str

iTXtチャンクを追加情報を保持したまま文字列のように見せるための文字列のサブクラス

__new__(cls, text, lang, tkey)

パラメータ:

• value – このキーの値

• lang – 言語コード

• tkey – キー名の UTF-8 バージョン

lang: str | bytes | None

tkey: str | bytes | None

PngImagePlugin.PngInfo クラス

class PIL.PngImagePlugin.PngInfo

基底クラス: object

PNGチャンクコンテナ（save(pnginfo=)で使用）

add(cid: bytes, data: bytes, after_idat: bool = False) → None

任意のチャンクを追加します。使用には注意が必要です。

パラメータ:

• cid – バイト列、4バイト長。

• data – エンコードされたデータのバイト列

• after_idat – プライベートチャンクで使用します。チャンクをIDATの後に書き込む必要があるかどうか。

add_itxt(key: str | bytes, value: str | bytes, lang: str | bytes = '', tkey: str | bytes = '', zip: bool = False) → None

iTXtチャンクを追加します。

パラメータ:

• key – latin-1エンコード可能なテキストキー名

• value – このキーの値

• lang – 言語コード

• tkey – キー名の UTF-8 バージョン

• zip – 圧縮フラグ

add_text(key: str | bytes, value: str | bytes | iTXt, zip: bool = False) → None

テキストチャンクを追加します。

パラメータ:

• key – latin-1エンコード可能なテキストキー名

• value – このキーの値、テキストまたはPIL.PngImagePlugin.iTXt インスタンス

• zip – 圧縮フラグ

TarIO モジュール

class PIL.TarIO.TarIO(tarfile: str, file: str)

基底クラス：ContainerIO[bytes]

TARファイルの指定されたメンバーへの読み取りアクセスを提供するファイルオブジェクト。

WalImageFile モジュール

このリーダーは、https://www.flipcode.com/archives/Quake_2_BSP_File_Format.shtml で入手可能な仕様に基づいており、Googleを使用して見つけたいくつかのサンプルファイルでテストされています。

注意

この形式は自動的に認識できないため、リーダーはPIL.Image.open()での使用には登録されていません。WALファイルを開くには、代わりにPIL.WalImageFile.open()関数を使用してください。

class PIL.WalImageFile.WalImageFile(fp: StrOrBytesPath | IO[bytes], filename: str | bytes | None = None)

ベースクラス: ImageFile

format: str | None = 'WAL'

format_description: str | None = 'Quake2 Texture'

load() → Image.core.PixelAccess | None

タイルリストに基づいて画像データをロードします。

PIL.WalImageFile.open(filename: StrOrBytesPath | IO[bytes]) → WalImageFile

Quake2 WALテクスチャファイルからテクスチャをロードします。

デフォルトでは、Quake2標準パレットがテクスチャにアタッチされます。パレットをオーバーライドするには、PIL.Image.Image.putpalette()メソッドを使用してください。

パラメータ:

filename – WALファイル名、または開かれたファイルハンドル。

戻り値:

画像インスタンス。