slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

dev:MultiBalanceReport: consistent debug output labels

Browse Source
This commit is contained in:
Simon Michael 2025-06-15 22:16:32 -10:00
parent 427a5de1f3
commit 9c7e5b2467
1 changed files with 21 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
hledger-lib/Hledger/Reports/MultiBalanceReport.hs
View File

@ -49,18 +49,11 @@ import Data.Traversable (mapAccumL)
import Hledger.Data import Hledger.Data
import Hledger.Query import Hledger.Query
import Hledger.Utils hiding (dbg3,dbg4,dbg5) import Hledger.Utils
import qualified Hledger.Utils
import Hledger.Reports.ReportOptions import Hledger.Reports.ReportOptions
import Hledger.Reports.ReportTypes import Hledger.Reports.ReportTypes
-- add a prefix to this function's debug output
dbg3 s = let p = "multiBalanceReport" in Hledger.Utils.dbg3 (p++" "++s)
dbg4 s = let p = "multiBalanceReport" in Hledger.Utils.dbg4 (p++" "++s)
dbg5 s = let p = "multiBalanceReport" in Hledger.Utils.dbg5 (p++" "++s)
-- | A multi balance report is a kind of periodic report, where the amounts -- | A multi balance report is a kind of periodic report, where the amounts
-- correspond to balance changes or ending balances in a given period. It has: -- correspond to balance changes or ending balances in a given period. It has:
-- --
@ -103,19 +96,19 @@ multiBalanceReportWith :: ReportSpec -> Journal -> PriceOracle -> MultiBalanceRe
multiBalanceReportWith rspec' j priceoracle = report multiBalanceReportWith rspec' j priceoracle = report
where where
-- Queries, report/column dates. -- Queries, report/column dates.
(reportspan, colspans) = dbg5 "reportSpan" $ reportSpan j rspec' (reportspan, colspans) = dbg5 "multiBalanceReportWith reportSpan" $ reportSpan j rspec'
rspec = dbg3 "reportopts" $ makeReportQuery rspec' reportspan rspec = dbg3 "multiBalanceReportWith rspec" $ makeReportQuery rspec' reportspan
-- force evaluation order to show price lookup after date spans in debug output (XXX not working) -- force evaluation order to show price lookup after date spans in debug output (XXX not working)
-- priceoracle = reportspan `seq` priceoracle0 -- priceoracle = reportspan `seq` priceoracle0
-- Get postings -- Get postings
ps = dbg5 "ps" $ getPostings rspec j priceoracle reportspan ps = dbg5 "multiBalanceReportWith ps" $ getPostings rspec j priceoracle reportspan
-- Process changes into normal, cumulative, or historical amounts, plus value them and mark which are uninteresting -- Process changes into normal, cumulative, or historical amounts, plus value them and mark which are uninteresting
acct = dbg5 "acct" $ generateMultiBalanceAccount rspec j priceoracle colspans ps acct = dbg5 "multiBalanceReportWith acct" $ generateMultiBalanceAccount rspec j priceoracle colspans ps
-- Generate and postprocess the report, negating balances and taking percentages if needed -- Generate and postprocess the report, negating balances and taking percentages if needed
report = dbg4 "multiBalanceReportWith" $ generateMultiBalanceReport (_rsReportOpts rspec) colspans acct report = dbg4 "multiBalanceReportWith report" $ generateMultiBalanceReport (_rsReportOpts rspec) colspans acct
-- | Generate a compound balance report from a list of CBCSubreportSpec. This -- | Generate a compound balance report from a list of CBCSubreportSpec. This
-- shares postings between the subreports. -- shares postings between the subreports.
@ -131,11 +124,11 @@ compoundBalanceReportWith :: ReportSpec -> Journal -> PriceOracle
compoundBalanceReportWith rspec' j priceoracle subreportspecs = cbr compoundBalanceReportWith rspec' j priceoracle subreportspecs = cbr
where where
-- Queries, report/column dates. -- Queries, report/column dates.
(reportspan, colspans) = dbg5 "reportSpan" $ reportSpan j rspec' (reportspan, colspans) = dbg5 "compoundBalanceReportWith reportSpan" $ reportSpan j rspec'
rspec = dbg3 "reportopts" $ makeReportQuery rspec' reportspan rspec = dbg3 "compoundBalanceReportWith rspec" $ makeReportQuery rspec' reportspan
-- Get postings -- Get postings
ps = dbg5 "ps" $ getPostings rspec j priceoracle reportspan ps = dbg5 "compoundBalanceReportWith ps" $ getPostings rspec j priceoracle reportspan
subreports = map generateSubreport subreportspecs subreports = map generateSubreport subreportspecs
where where
@ -178,8 +171,8 @@ makeReportQuery rspec reportspan
| otherwise = rspec{_rsQuery=query} | otherwise = rspec{_rsQuery=query}
where where
query = simplifyQuery $ And [dateless $ _rsQuery rspec, reportspandatesq] query = simplifyQuery $ And [dateless $ _rsQuery rspec, reportspandatesq]
reportspandatesq = dbg3 "reportspandatesq" $ dateqcons reportspan reportspandatesq = dbg3 "makeReportQuery reportspandatesq" $ dateqcons reportspan
dateless = dbg3 "dateless" . filterQuery (not . queryIsDateOrDate2) dateless = dbg3 "makeReportQuery dateless" . filterQuery (not . queryIsDateOrDate2)
dateqcons = if date2_ (_rsReportOpts rspec) then Date2 else Date dateqcons = if date2_ (_rsReportOpts rspec) then Date2 else Date
-- | Gather postings matching the query within the report period. -- | Gather postings matching the query within the report period.
@ -208,15 +201,15 @@ getPostings rspec@ReportSpec{_rsQuery=query, _rsReportOpts=ropts} j priceoracle
-- q projected back before the report start date. -- q projected back before the report start date.
-- When there's no report start date, in case there are future txns (the hledger-ui case above), -- When there's no report start date, in case there are future txns (the hledger-ui case above),
-- we use emptydatespan to make sure they aren't counted as starting balance. -- we use emptydatespan to make sure they aren't counted as starting balance.
fullreportq = dbg3 "fullreportq" $ And [datelessq, fullreportspanq] fullreportq = dbg3 "getPostings fullreportq" $ And [datelessq, fullreportspanq]
datelessq = dbg3 "datelessq" $ filterQuery (not . queryIsDateOrDate2) depthlessq datelessq = dbg3 "getPostings datelessq" $ filterQuery (not . queryIsDateOrDate2) depthlessq
-- The user's query with no depth limit, and expanded to the report span -- The user's query with no depth limit, and expanded to the report span
-- if there is one (otherwise any date queries are left as-is, which -- if there is one (otherwise any date queries are left as-is, which
-- handles the hledger-ui+future txns case above). -- handles the hledger-ui+future txns case above).
depthlessq = dbg3 "depthlessq" $ filterQuery (not . queryIsDepth) query depthlessq = dbg3 "getPostings depthlessq" $ filterQuery (not . queryIsDepth) query
depthSpec = dbg3 "depthSpec" . queryDepth $ filterQuery queryIsDepth query depthSpec = dbg3 "getPostings depthSpec" . queryDepth $ filterQuery queryIsDepth query
fullreportspan = if requiresHistorical ropts then DateSpan Nothing (Exact <$> spanEnd reportspan) else reportspan fullreportspan = if requiresHistorical ropts then DateSpan Nothing (Exact <$> spanEnd reportspan) else reportspan
fullreportspanq = (if date2_ ropts then Date2 else Date) $ case fullreportspan of fullreportspanq = (if date2_ ropts then Date2 else Date) $ case fullreportspan of
@ -254,7 +247,7 @@ addDeclaredAccounts rspec j acct =
filter (matchesAccountExtra (journalAccountType j) (journalAccountTags j) accttypetagsq) $ filter (matchesAccountExtra (journalAccountType j) (journalAccountTags j) accttypetagsq) $
journalAccountNamesDeclared j journalAccountNamesDeclared j
accttypetagsq = dbg3 "accttypetagsq" . accttypetagsq = dbg3 "addDeclaredAccounts accttypetagsq" .
filterQueryOrNotQuery (\q -> queryIsAcct q || queryIsType q || queryIsTag q) $ filterQueryOrNotQuery (\q -> queryIsAcct q || queryIsType q || queryIsTag q) $
_rsQuery rspec _rsQuery rspec
@ -291,7 +284,7 @@ calculateReportAccount rspec@ReportSpec{_rsReportOpts=ropts} j priceoracle colsp
cumulative = cumulativeSum changes{pdpre = mempty} cumulative = cumulativeSum changes{pdpre = mempty}
avalue = periodDataValuation ropts j priceoracle colspans avalue = periodDataValuation ropts j priceoracle colspans
changesAcct = dbg5With (\x -> "multiBalanceReport changesAcct\n" ++ showAccounts x) . changesAcct = dbg5With (\x -> "calculateReportAccount changesAcct\n" ++ showAccounts x) .
mapPeriodData (padPeriodData intervalStarts) $ mapPeriodData (padPeriodData intervalStarts) $
accountFromPostings getIntervalStartDate ps accountFromPostings getIntervalStartDate ps
@ -326,9 +319,9 @@ periodDataValuation ropts j priceoracle colspans =
boundaries spn = (spanStart spn, spanEnd spn) boundaries spn = (spanStart spn, spanEnd spn)
makeJust (Just x, Just y) = (x, addDays (-1) y) makeJust (Just x, Just y) = (x, addDays (-1) y)
makeJust _ = error' "calculateReportAccount: expected all non-initial spans to have start and end dates" makeJust _ = error' "balanceDataPeriodEnds: expected all non-initial spans to have start and end dates"
makeJustFst (Just x, _) = addDays (-1) x makeJustFst (Just x, _) = addDays (-1) x
makeJustFst _ = error' "calculateReportAccount: expected initial span to have an end date" makeJustFst _ = error' "balanceDataPeriodEnds: expected initial span to have an end date"
-- | Mark which nodes of an 'Account' are boring, and so should be omitted from reports. -- | Mark which nodes of an 'Account' are boring, and so should be omitted from reports.
markAccountBoring :: ReportSpec -> Account BalanceData -> Account BalanceData markAccountBoring :: ReportSpec -> Account BalanceData -> Account BalanceData
@ -397,7 +390,7 @@ generatePeriodicReport makeRow treeAmt flatAmt ropts colspans acct =
PeriodicReport colspans (buildAndSort acct) totalsrow PeriodicReport colspans (buildAndSort acct) totalsrow
where where
-- Build report rows and sort them -- Build report rows and sort them
buildAndSort = dbg5 "sortedrows" . case accountlistmode_ ropts of buildAndSort = dbg5 "generatePeriodicReport buildAndSort" . case accountlistmode_ ropts of {}
ALTree | sort_amount_ ropts -> buildRows . sortTreeByAmount ALTree | sort_amount_ ropts -> buildRows . sortTreeByAmount
ALFlat | sort_amount_ ropts -> sortFlatByAmount . buildRows ALFlat | sort_amount_ ropts -> sortFlatByAmount . buildRows
_ -> buildRows . sortAccountTreeByDeclaration _ -> buildRows . sortAccountTreeByDeclaration
@ -405,7 +398,7 @@ generatePeriodicReport makeRow treeAmt flatAmt ropts colspans acct =
buildRows = buildReportRows makeRow ropts buildRows = buildReportRows makeRow ropts
-- Calculate column totals from the inclusive balances of the root account -- Calculate column totals from the inclusive balances of the root account
totalsrow = dbg5 "totalsrow" $ makeRow ropts bdincludingsubs () acct totalsrow = dbg5 "generatePeriodicReport totalsrow" $ makeRow ropts bdincludingsubs () acct
sortTreeByAmount = case fromMaybe NormallyPositive $ normalbalance_ ropts of sortTreeByAmount = case fromMaybe NormallyPositive $ normalbalance_ ropts of
NormallyPositive -> sortAccountTreeOn (\r -> (Down $ amt r, aname r)) NormallyPositive -> sortAccountTreeOn (\r -> (Down $ amt r, aname r))