Skip to content

Commit

Permalink
Provide datetime-sorted clears table iteration
Browse files Browse the repository at this point in the history
Likely pertains to helping with stuff in issues #345 and #373 and just
generally is handy to have when processing ledgers / clearing event
tables.

Adds the following helper methods:
- `iter_by_dt()` to iter-sort an arbitrary `Transaction`-like table of
  clear entries.
- `Position.iter_clears()` as a convenience wrapper for the above.
  • Loading branch information
goodboy committed Jan 30, 2023
1 parent 66ee9e8 commit 177fde0
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions piker/pp.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import time
from typing import (
Any,
Iterator,
Optional,
Union,
)
Expand Down Expand Up @@ -116,6 +117,21 @@ class Transaction(Struct, frozen=True):
# from: Optional[str] = None


def iter_by_dt(
clears: dict[str, Any],
) -> Iterator[tuple[str, dict]]:
'''
Iterate entries of a ``clears: dict`` table sorted by entry recorded
datetime presumably set at the ``'dt'`` field in each entry.
'''
for tid, data in sorted(
list(clears.items()),
key=lambda item: item[1]['dt'],
):
yield tid, data


class Position(Struct):
'''
Basic pp (personal/piker position) model with attached clearing
Expand Down Expand Up @@ -183,12 +199,7 @@ def to_pretoml(self) -> tuple[str, dict]:
toml_clears_list = []

# reverse sort so latest clears are at top of section?
for tid, data in sorted(
list(clears.items()),

# sort by datetime
key=lambda item: item[1]['dt'],
):
for tid, data in iter_by_dt(clears):
inline_table = toml.TomlDecoder().get_empty_inline_table()

# serialize datetime to parsable `str`
Expand Down Expand Up @@ -301,6 +312,14 @@ def dsize(self) -> float:
# def lifo_price() -> float:
# ...

def iter_clears(self) -> Iterator[tuple[str, dict]]:
'''
Iterate the internally managed ``.clears: dict`` table in
datetime-stamped order.
'''
return iter_by_dt(self.clears)

def calc_ppu(
self,
# include transaction cost in breakeven price
Expand Down Expand Up @@ -331,10 +350,9 @@ def calc_ppu(
asize_h: list[float] = [] # historical accumulative size
ppu_h: list[float] = [] # historical price-per-unit

clears = list(self.clears.items())

for i, (tid, entry) in enumerate(clears):

tid: str
entry: dict[str, Any]
for (tid, entry) in self.iter_clears():
clear_size = entry['size']
clear_price = entry['price']

Expand All @@ -344,6 +362,11 @@ def calc_ppu(

sign_change: bool = False

if accum_size == 0:
ppu_h.append(0)
asize_h.append(0)
continue

if accum_size == 0:
ppu_h.append(0)
asize_h.append(0)
Expand Down

0 comments on commit 177fde0

Please sign in to comment.