playscript.conv package¶
Submodules¶
playscript.conv.fountain module¶
-
playscript.conv.fountain.psc_from_fountain(s, empty_line=False, charsheadline=['登場人物'], charlines_break=False, default_name='*')¶ Fountain 文字列から台本オブジェクトを生成する
- パラメータ
s (str) -- Fountain 文字列
empty_line (bool) -- 空行を空行として残すかどうか
charsheadline (list-like[str]) -- 登場人物見出し行とみなす文字列のリスト
charlines_break (bool) -- 登場人物行が複数行に渡るかどうか
default_name (str) -- 名前部分を切り出せない場合に使う名前
- 戻り値
台本オブジェクト
- 戻り値の型
playscript.conv.html module¶
-
playscript.conv.html.class_name(line_type)¶ 台本行の種類を HTML の class 名に変換するフィルタ
-
playscript.conv.html.default_css()¶ デフォルトのスタイルシートを取得する
-
playscript.conv.html.default_js()¶ デフォルトの JavaScript を取得する
-
playscript.conv.html.default_template()¶ デフォルトの HTML テンプレートを取得する
-
playscript.conv.html.esc_spc(s)¶ 空白文字をエスケープするフィルタ
-
playscript.conv.html.get_template(dir, file_name)¶ HTML テンプレートを取得する
-
playscript.conv.html.psc_to_html(psc, title=None, template=None, css=None, js=None)¶ 台本オブジェクトから HTML を生成する
- パラメータ
psc (PSc) -- ソースとなる台本オブジェクト
title (str) -- HTML のタイトル
template (str) -- HTML テンプレート
css (str) -- スタイルシート部分の HTML
js (str) -- JavaScript 部分の HTML
-
playscript.conv.html.template_dir()¶ テンプレートのディレクトリを取得する
playscript.conv.json module¶
-
playscript.conv.json.psc_dump(psc, fp, cls=<class 'playscript.conv.json._PScEncoder'>, ensure_ascii=False, **kwargs)¶ 台本オブジェクトをシリアライズして JSON ファイルに書き出す
- パラメータ
psc (PSc) -- 台本オブジェクト
fp (file-like) -- 出力先ファイル (ストリーム)
cls (class) -- エンコードに使うクラス
ensure_ascii (bool) -- ASCII 文字に限定するかどうか
**kwargs -- json.dump に渡すキーワード引数
-
playscript.conv.json.psc_dumps(psc, cls=<class 'playscript.conv.json._PScEncoder'>, ensure_ascii=False, **kwargs)¶ 台本オブジェクトをシリアライズして JSON 文字列に書き出す
- パラメータ
psc (PSc) -- 台本オブジェクト
cls (class) -- エンコードに使うクラス
ensure_ascii (bool) -- ASCII 文字に限定するかどうか
**kwargs -- json.dumps に渡すキーワード引数
- 戻り値
JSON 文字列
- 戻り値の型
str
-
playscript.conv.json.psc_load(fp, object_hook=<function _psc_hook>, **kwargs)¶ JSON ファイルをデシリアライズして台本オブジェクトを生成する
- パラメータ
fp (file-like) -- JSON ファイル (ストリーム)
object_hook (function) -- デコードに使うフック関数
**kwargs -- json.load に渡すキーワード引数
- 戻り値
台本オブジェクト
- 戻り値の型
playscript.conv.pdf module¶
-
class
playscript.conv.pdf.PageMan(size, margin=None, upper_space=None, font_name='HeiseiMin-W3', num_font_name='Times-Roman', font_size=10.0, line_space=None, before_init_page=None)¶ ベースクラス:
objectコンストラクタ
- パラメータ
size (tuple) -- ページのサイズ (ポイント)
margin (tuple) -- 左右と上下のマージン (ポイント)
upper_space (float) -- 上の余白 (ポイント)
font_name (str) -- 本文のフォント
num_font_name (str) -- 数字のフォント
font_size (float) -- 本文のフォントサイズ (ポイント)
line_space (float) -- 本文の行間 (ポイント)
before_init_page (function) -- ページ初期化時のカスタム処理の関数
-
close()¶ PDF ストリームへの書き出しを終了する
著者名を PDF ストリームに書き出す
-
draw_character(l_idx, char_line)¶ 登場人物行を PDF ストリームに書き出す
-
draw_charsheadline(l_idx, chead_line)¶ 登場人物見出し行を PDF ストリームに書き出す
-
draw_comment(l_idx, cmmt_line)¶ コメント行を PDF ストリームに書き出す
-
draw_dialogue(l_idx, dlg_line)¶ セリフ行を PDF ストリームに書き出す
-
draw_direction(l_idx, drct_line)¶ ト書き行を PDF ストリームに書き出す
-
draw_empty(l_idx, empty_line)¶ 空行を PDF ストリームに書き出す
-
draw_endmark(l_idx, endmk_line)¶ エンドマークを PDF ストリームに書き出す
-
draw_slugline(l_idx, hx_line, number=None, border=False)¶ 柱を PDF ストリームに書き出す
-
draw_title(l_idx, ttl_line)¶ 題名を PDF ストリームに書き出す
-
save(file_name)¶ PDF ストリームをファイルに出力する
-
playscript.conv.pdf.psc_to_pdf(psc, size=None, margin=None, upper_space=None, font_name='HeiseiMin-W3', num_font_name='Times-Roman', font_size=10.0, line_space=None, before_init_page=None, draw_page_num=True)¶ 台本オブジェクトから PDF ストリームを生成する
- パラメータ
psc (PSc) -- ソースとなる台本オブジェクト
size (tuple) -- ページのサイズ (ポイント)
margin (tuple) -- 左右と上下のマージン (ポイント)
upper_space (float) -- 上の余白 (ポイント)
font_name (str) -- 本文のフォント
num_font_name (str) -- 数字のフォント
font_size (float) -- 本文のフォントサイズ (ポイント)
line_space (float) -- 本文の行間 (ポイント)
before_init_page (function) -- ページ初期化時のカスタム処理の関数
draw_page_num (bool) -- ページ番号を書き出すかどうか
- 戻り値
PDF ストリーム
- 戻り値の型
BytesIO