quantlab.dataset.sharadar.tables.map_permatickers#

quantlab.dataset.sharadar.tables.map_permatickers(frame, mapping, *, owner, code)[source]#

Add each row’s permaticker, refusing a missing or ambiguous one.

Parameters:

framepl.DataFrame: Rows with a ticker column.
mappingpl.DataFrame: permaticker_mapping of the rows’ table.
ownerstr: Named in error messages.
codestr: The rows’ table, named in error messages.

Returns:

pl.DataFrame: frame with a permaticker column.

Raises:

ValueError: If a ticker maps to several permatickers, or to none.

Examples

>>> rows = pl.DataFrame({"ticker": ["AAA"]})
>>> pairs = pl.DataFrame({"ticker": ["AAA"], "permaticker": [101]})
>>> map_permatickers(rows, pairs, owner="demo", code="sep")["permaticker"].to_list()
[101]