xbot.pdf

この記事の内容
  1. メソッド
  2. extract_text()
  3. extract_images()
  4. extract_pages()
  5. merge_pdfs()

PDFからのテキスト抽出、PDF内の画像の抽出、PDFのページのエクスポートなど、PDFファイルの処理に使用します。

パス中の「example.pdf」と「example-file.pdf」はファイル名の例です。実際のPDFファイル名に置き換えてください。

メソッド

extract_text()

PDFファイルのテキストを抽出します。

extract_text(path, from_page, to_page, password = None)

入力パラメータ

path:PDFファイルのパスです。例:"C:\example.pdf"

from_page:開始ページ番号です。

to_page:終了ページ番号です。

password:PDFファイルのパスワードです。このパラメータはキーワード引数です。指定しない場合は、デフォルトでPDFファイルにパスワードがないものとして扱います。

戻り値

str:文字列型の戻り値です。PDFファイルから抽出したテキストを返します。

例1

import xbot
def main(args):
    text = xbot.pdf.extract_text('D:\\123.pdf',1,2,password="abc123")
    print(text)

この例の実行ロジック: Dドライブにある "123.pdf" という名前のPDFファイルの1ページ目と2ページ目のテキスト内容を取得します(ファイルのパスワードはabc123です) --> 抽出結果を出力します。

extract_images()

PDFファイルから複数の画像を抽出します。

extract_images(path, from_page, to_page, save_to_dir,password = None, name_prefix = 'pdf_image')

入力パラメータ

path:PDFファイルのパスです。

from_page:開始ページ番号です。

to_page:終了ページ番号です。

save_to_dir:画像を保存するフォルダのパスです。

password:PDFファイルのパスワードです。このパラメータはキーワード引数です。指定しない場合は、デフォルトでパスワードがないものとして扱います。

name_prefix:エクスポートする画像名のプレフィックスです。このパラメータはキーワード引数です。指定しない場合、画像名のデフォルトのプレフィックスは「pdf_image」です。

戻り値

List:リスト型の戻り値です。ローカルに抽出した画像のパスのリストを返します。例:['C:/work/pdf_image_0501101010_1.png', 'C:/work/pdf_image_0501101010_2.png']

例1

import xbot
def main(args):
    file_paths = xbot.pdf.extract_images('D:\\123.pdf', 1, 2, 'D:\\image',password='abc12',  name_prefix='hello')
    print(file_paths)

この例の実行ロジック: Dドライブにある「123.pdf」という名前のファイルからすべての画像を抽出します--> 画像の保存パスを出力します。

extract_pages()

PDFファイル内のページをエクスポートします。

extract_pages( path, from_page, to_page, save_to,password = None )

入力パラメータ

path:PDFファイルのパスです。

from_page:開始ページ番号です。

to_page:終了ページ番号です。

save_to:保存先のファイルパスです。パスを入力する際は、必ずファイル名を含めてください。例:"C:\example-file.pdf"

password:PDFファイルのパスワードです。このパラメータはキーワード引数です。指定しない場合は、デフォルトでパスワードがないものとして扱います。

戻り値

  • str:文字列の戻り値です。ローカルに保存した新しいファイルのパスを返します。

例1

import xbot
def main(args):
    path = xbot.pdf.extract_pages('D:\\123.pdf', 1, 2, 'D:\\abc.pdf', password='abc12')
    print(path)

この例の実行ロジック: Dドライブにある "123.pdf" ファイルの1、2ページ目の内容を抽出します--> 抽出後のPDFファイルの保存パスを出力します。

merge_pdfs()

複数のPDFファイルを結合します。

merge_pdfs(paths, save_to , passwords = None)

入力パラメータ

paths:PDFファイルのパスのリストです。例:['D:\123.pdf', 'D:\abc.pdf']

save_to:保存先のファイルパスです。パスを入力する際は、必ずファイル名を含めてください。例:"C:\example-file.pdf"

passwords:各PDFファイルのパスワードです。パラメータタイプはリスト型ですので、指定する際は注意してください(例:['xxxxxx', 'yyyy',...])。パスワードのリストの要素は、ファイルパスのリストと1対1で対応させる必要があります。このパラメータはキーワード引数です。指定しない場合は、デフォルトですべてのPDFファイルにパスワードがないものとして扱います。

戻り値

str:文字列の戻り値です。ローカルに保存した新しいファイルのパスを返します。

例1

import xbot 
def main(args):
    path = xbot.pdf.merge_pdfs(['D:\\123.pdf', 'D:\\abc.pdf'], 'D:\\hello.pdf', 
                            password=['xxxxxx', 'yyy'])
    print(path)

この例の実行ロジック: Dドライブにある "123.pdf" ファイルと "abc.pdf" ファイルを結合します --> 結合後のPDFファイルの保存パスを出力します。

APIリファレンスの記事一覧ページの先頭へ ↑