Skip to content

join_pricing

join_pricing

join_pricing(vehicles: DataFrame, plans: DataFrame) -> DataFrame

Resolve pricing_plan_id → plan name / price / currency onto a vehicles frame.

Left join of to_canonical_pricing_plans (its plan_id matches the vehicle's pricing_plan_id); plan name/description are prefixed plan_ to avoid clashes.

See Also

join_vehicle_types : Resolve type attributes onto vehicles.

Examples:

>>> import pandas as pd
>>> vehicles = pd.DataFrame({"bike_id": ["v1"], "pricing_plan_id": ["p1"]})
>>> plans = pd.DataFrame({"plan_id": ["p1"], "name": ["Day Pass"], "price": [5.0]})
>>> join_pricing(vehicles, plans)["plan_name"].tolist()
['Day Pass']
Source code in src/gbfs_toolkit/analytics/frames.py
def join_pricing(vehicles: pd.DataFrame, plans: pd.DataFrame) -> pd.DataFrame:
    """Resolve ``pricing_plan_id`` → plan name / price / currency onto a vehicles frame.

    Left join of [`to_canonical_pricing_plans`][gbfs_toolkit.to_canonical_pricing_plans] (its ``plan_id`` matches the
    vehicle's ``pricing_plan_id``); plan ``name``/``description`` are prefixed ``plan_`` to
    avoid clashes.

    See Also
    --------
    [`join_vehicle_types`][gbfs_toolkit.join_vehicle_types] : Resolve type attributes onto vehicles.

    Examples
    --------
    >>> import pandas as pd
    >>> vehicles = pd.DataFrame({"bike_id": ["v1"], "pricing_plan_id": ["p1"]})
    >>> plans = pd.DataFrame({"plan_id": ["p1"], "name": ["Day Pass"], "price": [5.0]})
    >>> join_pricing(vehicles, plans)["plan_name"].tolist()
    ['Day Pass']
    """
    p = plans.drop(columns=["system_id"], errors="ignore").rename(
        columns={
            "plan_id": "pricing_plan_id",
            "name": "plan_name",
            "description": "plan_description",
        }
    )
    return vehicles.merge(p, on="pricing_plan_id", how="left")