pygeonlp.api.metadata module

class pygeonlp.api.metadata.Metadata(jsonld=None)

ベースクラス: object

JSON-LD 形式メタデータの管理クラス。

jsonld

メタデータ json-ld 文字列。

Type

str

__init__(jsonld=None)
パラメータ

jsonld (str or dict) -- json-ld 文字列、またはデコードした dict。

classmethod download(url, params=None, **kwargs)

指定した URL からウェブページをダウンロードし、 ヘッダに記載されている json-ld を辞書メタデータとして抽出します。

パラメータ
  • url (str) -- json-ld を含むウェブページの URL。

  • params (dict, optional) -- requests.get に渡す params パラメータ。

  • **kwargs (キーワードパラメータ, optional) -- requests.get に渡す kwargs パラメータ。

戻り値

抽出した json-ld 文字列をセットした Metadata インスタンス

戻り値の型

Metadata

例外

MetadataError -- ウェブページのダウンロードに失敗した場合。 ウェブページから json-ld が見つけられない場合。 ウェブページに複数の json-ld が含まれている場合。

download_csv(content_url=None, params=None, **kwargs)

content_url から CSV をダウンロードします。

パラメータ
  • content_url (str, optional) -- CSV をダウンロードする URL を指定します。 省略された場合、 json-ld から content_url を抽出します。

  • params (dict, optional) -- requests.get に渡す params パラメータ。

  • **kwargs (キーワードパラメータ, optional) -- requests.get に渡す kwargs パラメータ。

戻り値

ダウンロードした CSV テキスト。

戻り値の型

str

例外

MetadataError -- CSV のダウンロードに失敗した場合。

get_content_url()

json-ld 文字列から、コンテンツ CSV をダウンロードする content_url を抽出します。

戻り値

抽出した content_url 文字列。

戻り値の型

str

例外

MetadataError -- json-ld がセットされていない場合。 json-ld から content_url が見つけられない場合。

get_identifier()

json-ld 文字列から GeoNLP identifier を抽出します。

GeoNLP identifier は 'geonlp:' で始まる必要があります。

戻り値

抽出した identifier 文字列。

戻り値の型

str

例外

MetadataError -- json-ld がセットされていない場合。 json-ld から identifier が見つけられない場合。

get_name()

json-ld 文字列からデータセットの名前を抽出します。

戻り値

データセットの名前。

戻り値の型

str

例外

MetadataError -- json-ld がセットされていない場合。 json-ld から identifier が見つけられない場合。

classmethod load(file)

指定したファイルに含まれる json-ld 文字列から Metadata インスタンスを作成します。

パラメータ

file (str) -- json-ld 文字列を含むファイル名。

戻り値

json-ld 文字列をセットした Metadata インスタンス。

戻り値の型

Metadata

classmethod loads(jsonld)

指定した json-ld 文字列から Metadata インスタンスを作成します。

パラメータ

jsonld (str) -- json-ld 文字列。

戻り値

json-ld 文字列をセットした Metadata インスタンス。

戻り値の型

Metadata

class pygeonlp.api.metadata.MetadataError

ベースクラス: RuntimeError

メタデータの操作の際に例外が起こると、このクラスが発生します。