playscript package

Subpackages

Submodules

playscript.psc module

台本オブジェクトを構成するクラス群

class playscript.psc.PSc(title='', author='', chars=[], lines=[])

ベースクラス: object

コンストラクタ

パラメータ:

  • title (str) -- 題名

  • author (str) -- 著者名

  • chars (list-like[str]) -- 登場人物のリスト

  • lines (list-like[PScLine]) -- 台本行オブジェクトのリスト (イテラブル)

classmethod from_lines(lines)

台本行オブジェクトのリストから台本オブジェクトを作る

パラメータ:

lines (list-like[PScLine]) -- 台本行オブジェクトのリスト (イテラブル)

戻り値:

台本オブジェクト

戻り値の型:

PSc

classmethod lines_from_types_and_texts(line_types, texts)

行の種類と文字列から、台本行オブジェクトのリストを作る

このメソッドは非推奨です。 代わりに lines_from_types_and_texts 関数を使ってください。

class playscript.psc.PScLine(line_type, name=None, text=None)

ベースクラス: object

コンストラクタ

パラメータ:

  • line_type (PScLineType) -- 行の種類

  • name (str) -- 登場人物行、セリフ行の名前部分

  • text (str) -- テキスト部分

classmethod from_text(line_type, text, *, default_name='*', dlg_brackets=None)

行の種類と文字列から、台本行オブジェクトを作る

パラメータ:

  • line_type (PScLineType) -- 行の種類

  • text (str) -- 行を表す文字列

  • default_name (str) -- 名前部分を切り出せない場合に使う名前

  • dlg_brackets (list-like[str]) -- 開き括弧とみなす文字と、閉じ括弧とみなす文字

戻り値:

台本行オブジェクト

戻り値の型:

PScLine

class playscript.psc.PScLineType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ベースクラス: Enum

台本行の種類

AUTHOR = 1
CHARACTER = 3
CHARACTER_CONTINUED = 12
CHARSHEADLINE = 2
COMMENT = 10
COMMENT_CONTINUED = 15
DIALOGUE = 8
DIALOGUE_CONTINUED = 14
DIRECTION = 7
DIRECTION_CONTINUED = 13
EMPTY = 11
ENDMARK = 9
H1 = 4
H2 = 5
H3 = 6
TITLE = 0
playscript.psc.lines_from_types_and_texts(line_types, texts)

行の種類と文字列から、台本行オブジェクトのリストを作る

パラメータ:

  • line_types (list-like[PScLineType]) -- 行の種類のリスト (イテラブル)

  • texts (list-like[str]) -- 行のテキストのリスト (イテラブル)

戻り値:

台本行オブジェクトのリスト

戻り値の型:

list[PScLine]

Module contents