Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

TimeSeriesResult.to_df() turns API nulls into '' and emits a zero-length trailing bucket when filter_time_max lands on a period boundary

オープン
#578 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
52/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
pandas, python
領域
api, data

調査の方向性

Start with result_conversions.create_dataframe and sort_breakdown in timeseries_result.py, then run the reproduction in the issue for boundary and non-boundary filter_time_max values. Trace how API nulls and the final bucket are represented before to_df(). Done means numeric nulls remain usable, zero-length periods are handled consistently, and the filter boundary behavior is documented or defined.

索引モデルが issue の本文から書いたものです。

説明

Environment: vortexasdk 1.0.32 (also reproduced on 1.0.29), Python 3.12, pandas 2.3.3, Windows.

A. to_df() replaces nulls with ''. result_conversions.create_dataframe runs pd.DataFrame(data).fillna(""). Any null from the API becomes an empty string and turns value into object dtype, so arithmetic such as df["value"] / 1000 raises TypeError. sort_breakdown in timeseries_result.py also pads missing breakdown entries with "value": "".

B. Zero-length trailing bucket. When filter_time_max falls exactly on a period boundary, for example midnight on the 1st with timeseries_frequency="month", the response has an extra final bucket for a zero-length period with count=0. With a rate unit (bpd) its value is None, so '' after to_df(). With a volume unit (b) it is 0, which reads like a real empty month. Months with genuinely no cargoes return value=0 as expected.

from datetime import datetime
from vortexasdk import CargoTimeSeries, Geographies, Products

def run(geo, prod, end):
    return CargoTimeSeries().search(
        filter_activity="loading_end", filter_origins=geo, filter_products=prod,
        filter_time_min=datetime(2025, 1, 1), filter_time_max=end,
        timeseries_frequency="month", timeseries_unit="bpd",
    ).to_df()

if __name__ == "__main__":
    geo = Geographies().search(term="Rotterdam").to_list()[0].id
    prod = Products().search(term="Diesel/Gasoil", exact_term_match=True).to_list()[0].id
    for end in (datetime(2025, 6, 1), datetime(2025, 6, 30, 23, 59)):
        df = run(geo, prod, end)
        print(end, df["value"].dtype)   # 2025-06-01 -> object, last row count=0 value=''
        print(df.tail(2))               # 2025-06-30 -> float64, last row is the real June

Expected:

  • Nulls preserved as NaN, keeping value numeric.
  • No bucket for a zero-length period, or documented behaviour (ideally a flag) for whether filter_time_max is inclusive.

Related: Products().reference(old_id) silently redirects a rotated product id to its replacement, but CargoTimeSeries with the old id returns all zeros with no error. Could id rotation be documented, or could the timeseries endpoint reject unknown product ids?

主要言語
Python
スター
25
フォーク
12
平均マージ
20時間 18分
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

VorTECHsa/python-sdk のほかの issue

VorTECHsa/python-sdk の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。