livepeer / livepeer/livepeer-python-gateway
Align pricing terminology: pixels_per_unit -> pricing_unit_size (track go-livepeer #3942)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1
- Forks
- 7
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Summary
Align the SDK's user-facing pricing terminology with go-livepeer, which is renaming the -pixelsPerUnit flag to -pricingUnitSize (see livepeer/go-livepeer#3942).
Background
pixelsPerUnit is really just a pricing scale factor: it is the number of work units that one quoted price covers, so price_per_work_unit = pricePerUnit / pixelsPerUnit. The "pixels" name is transcoding-era legacy and is confusing for non-video / BYOC / general-runner workloads, where there are no pixels.
go-livepeer#3942 introduces -pricingUnitSize as the primary flag and keeps -pixelsPerUnit as a deprecated alias. The wire/proto field (PriceInfo.pixelsPerUnit) is intentionally left unchanged for compatibility.
What to change in this SDK
User-facing terminology only — the generated proto field stays pixelsPerUnit:
examples/get_orchestrator_info.py- JSON dict key
pixels_per_unit->pricing_unit_size(snake_case analog ofpricingUnitSize). - Text output
... wei per N pixel(s)->... wei per N work unit(s). - Keep reading the wire field via
info.price_info.pixelsPerUnit.
- JSON dict key
Out of scope
src/livepeer_gateway/lp_rpc_pb2.pyis generated from the proto and carries the wire fieldpixelsPerUnit; do not hand-edit it.
Related
- go-livepeer#3942 (flag rename)
- In-flight PR #20 (
ja/live-runner) introduced a relatedunit_scaleconcept; it should adopt the samepricing_unit_sizename for consistency.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit examples/get_orchestrator_info.py und untersuche, wie info.price_info.pixelsPerUnit gelesen wird. Benenne den benutzerseitigen JSON-Schlüssel und die Pixelterminologie in pricing_unit_size bzw. Arbeitseinheiten um, während src/livepeer_gateway/lp_rpc_pb2.py unverändert bleibt; abgeschlossen ist die Aufgabe, wenn das Beispiel die neue Terminologie verwendet, ohne das Wire-Feld zu ändern.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- api
- Issue-Typ
- Refactoring
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Ruhig
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 68/100