pygeonlp.api.dictionary module
- class pygeonlp.api.dictionary.Dictionary(metadata, csvtext)
ベースクラス:
object
GeoNLP 辞書の管理クラス 辞書メタデータとCSVデータに対する操作を行ないます。
通常、開発者がこのクラスを直接操作する必要はありません。
- csvtext
CSV テキスト
- Type:
str
- __init__(metadata, csvtext)
与えられたパラメータでクラス変数を初期化します。
- パラメータ:
metadata (Metadata) -- メタデータのインスタンス
csvtext (str) -- CSV テキスト
- add(capi_ma)
システムに辞書を登録します。
- パラメータ:
capi_ma (
capi.MA
) -- 辞書を管理する MA オブジェクト。 init() で初期化済みである必要があります。- 戻り値:
常に True が返ります。 失敗した場合は例外が発生します。
- 戻り値の型:
bool
- classmethod create(csvfile, name=None, identifier=None)
指定したパスにある地名解析辞書(CSVファイル)を読み込み Dictionary インスタンスを作成します。
- パラメータ:
csvfile (str) -- 地名解析辞書ファイルのパス
name (str, optional) -- 辞書名。省略した場合、 CSV ファイルの basename を利用します。
identifier (str, optional) -- 辞書 identifier。省略した場合、 CSV ファイルの basename を取り、
geonlp:<basename>
を利用します。
- 戻り値:
作成した Dictionary インスタンス。
- 戻り値の型:
- classmethod download(url, params=None, **kwargs)
指定された URL からウェブページをダウンロードし、 ヘッダに記載されている json-ld を辞書メタデータとして抽出します。 また、メタデータに書かれているデータダウンロード URL にアクセスして CSV データを取得します。 取得したメタデータと CSV データを保持する Dictionary インスタンスを作成します。
- パラメータ:
url (str) -- json-ld を含むウェブページの URL
params (dict, optional) -- requests.get に渡す params パラメータ
**kwargs -- requests.get に渡す kwargs パラメータ
- 戻り値:
作成した Dictionary インスタンス。
- 戻り値の型:
- get_identifier()
この辞書の identifier を返します。
- 戻り値:
辞書 identifier 文字列。
- 戻り値の型:
str
- get_name()
この辞書の名前を返します。
- 戻り値:
辞書の名前。
- 戻り値の型:
str
- classmethod load(jsonfile, csvfile)
指定したパスにある辞書メタデータ(JSONファイル)と 地名解析辞書(CSVファイル)を読み込み Dictionary インスタンスを作成します。
- パラメータ:
jsonfile (str) -- 辞書メタデータファイルのパス
csvfile (str) -- 地名解析辞書ファイルのパス
- 戻り値:
作成した Dictionary インスタンス。
- 戻り値の型:
- save(jsonfile, csvfile)
この辞書が保持している json-ld と CSV データをファイルに保存します。
- パラメータ:
jsonfile (str) -- json-ld を保存するファイル名
csvfile (str) -- CSV データを保存するファイル名
- 戻り値:
常に True が返ります。 失敗した場合は例外が発生します。
- 戻り値の型:
bool
- class pygeonlp.api.dictionary.DictionaryError
ベースクラス:
RuntimeError
辞書データの操作の際に例外が起こると、このクラスが発生します。