| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Hledger.Reports.ReportOptions
Description
Options common to most hledger reports.
Synopsis
- data ReportOpts = ReportOpts {
- period_ :: Period
- interval_ :: Interval
- statuses_ :: [Status]
- conversionop_ :: Maybe ConversionOp
- value_ :: Maybe ValuationType
- infer_prices_ :: Bool
- depth_ :: Maybe Int
- date2_ :: Bool
- empty_ :: Bool
- no_elide_ :: Bool
- real_ :: Bool
- format_ :: StringFormat
- pretty_ :: Bool
- querystring_ :: [Text]
- average_ :: Bool
- related_ :: Bool
- txn_dates_ :: Bool
- balancecalc_ :: BalanceCalculation
- balanceaccum_ :: BalanceAccumulation
- budgetpat_ :: Maybe Text
- accountlistmode_ :: AccountListMode
- drop_ :: Int
- declared_ :: Bool
- row_total_ :: Bool
- no_total_ :: Bool
- show_costs_ :: Bool
- sort_amount_ :: Bool
- percent_ :: Bool
- invert_ :: Bool
- normalbalance_ :: Maybe NormalSign
- color_ :: Bool
- transpose_ :: Bool
- layout_ :: Layout
- class HasReportOptsNoUpdate c where
- reportOptsNoUpdate :: Lens' c ReportOpts
- accountlistmode :: Lens' c AccountListMode
- average :: Lens' c Bool
- balanceaccum :: Lens' c BalanceAccumulation
- balancecalc :: Lens' c BalanceCalculation
- budgetpat :: Lens' c (Maybe Text)
- color__ :: Lens' c Bool
- conversionop :: Lens' c (Maybe ConversionOp)
- date2NoUpdate :: Lens' c Bool
- declared :: Lens' c Bool
- depthNoUpdate :: Lens' c (Maybe Int)
- drop__ :: Lens' c Int
- empty__ :: Lens' c Bool
- format :: Lens' c StringFormat
- infer_prices :: Lens' c Bool
- interval :: Lens' c Interval
- invert :: Lens' c Bool
- layout :: Lens' c Layout
- no_elide :: Lens' c Bool
- no_total :: Lens' c Bool
- normalbalance :: Lens' c (Maybe NormalSign)
- percent :: Lens' c Bool
- periodNoUpdate :: Lens' c Period
- pretty :: Lens' c Bool
- querystringNoUpdate :: Lens' c [Text]
- realNoUpdate :: Lens' c Bool
- related :: Lens' c Bool
- row_total :: Lens' c Bool
- show_costs :: Lens' c Bool
- sort_amount :: Lens' c Bool
- statusesNoUpdate :: Lens' c [Status]
- transpose__ :: Lens' c Bool
- txn_dates :: Lens' c Bool
- value :: Lens' c (Maybe ValuationType)
- class HasReportOptsNoUpdate a => HasReportOpts a where
- reportOpts :: ReportableLens' a ReportOpts
- period :: ReportableLens' a Period
- statuses :: ReportableLens' a [Status]
- depth :: ReportableLens' a (Maybe Int)
- date2 :: ReportableLens' a Bool
- real :: ReportableLens' a Bool
- querystring :: ReportableLens' a [Text]
- data ReportSpec = ReportSpec {
- _rsReportOpts :: ReportOpts
- _rsDay :: Day
- _rsQuery :: Query
- _rsQueryOpts :: [QueryOpt]
- class HasReportSpec c where
- reportSpec :: Lens' c ReportSpec
- rsDay :: Lens' c Day
- rsQuery :: Lens' c Query
- rsQueryOpts :: Lens' c [QueryOpt]
- rsReportOpts :: Lens' c ReportOpts
- overEither :: ((a -> Either e b) -> s -> Either e t) -> (a -> b) -> s -> Either e t
- setEither :: ((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t
- data BalanceCalculation
- data BalanceAccumulation
- data AccountListMode
- data ValuationType
- data Layout
- = LayoutWide (Maybe Int)
- | LayoutTall
- | LayoutBare
- | LayoutTidy
- defreportopts :: ReportOpts
- rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts
- defreportspec :: ReportSpec
- setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec
- reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec
- updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec
- updateReportSpecWith :: (ReportOpts -> ReportOpts) -> ReportSpec -> Either String ReportSpec
- rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec
- balanceAccumulationOverride :: RawOpts -> Maybe BalanceAccumulation
- flat_ :: ReportOpts -> Bool
- tree_ :: ReportOpts -> Bool
- reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts
- simplifyStatuses :: Ord a => [a] -> [a]
- whichDate :: ReportOpts -> WhichDate
- journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal
- journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
- journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal
- journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal
- mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts -> Journal -> PriceOracle -> DateSpan -> MixedAmount -> MixedAmount
- valuationAfterSum :: ReportOpts -> Maybe (Maybe CommoditySymbol)
- intervalFromRawOpts :: RawOpts -> Interval
- queryFromFlags :: ReportOpts -> Query
- transactionDateFn :: ReportOpts -> Transaction -> Day
- postingDateFn :: ReportOpts -> Posting -> Day
- reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
- reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan])
- reportStartDate :: Journal -> ReportSpec -> Maybe Day
- reportEndDate :: Journal -> ReportSpec -> Maybe Day
- reportPeriodStart :: ReportSpec -> Maybe Day
- reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day
- reportPeriodLastDay :: ReportSpec -> Maybe Day
- reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day
- reportPeriodName :: BalanceAccumulation -> [DateSpan] -> DateSpan -> Text
Documentation
data ReportOpts Source #
Standard options for customising report filtering and output. Most of these correspond to standard hledger command-line options or query arguments, but not all. Some are used only by certain commands, as noted below.
Constructors
| ReportOpts | |
Fields
| |
Instances
class HasReportOptsNoUpdate c where Source #
Lenses for ReportOpts.
Minimal complete definition
Methods
reportOptsNoUpdate :: Lens' c ReportOpts Source #
accountlistmode :: Lens' c AccountListMode Source #
average :: Lens' c Bool Source #
balanceaccum :: Lens' c BalanceAccumulation Source #
balancecalc :: Lens' c BalanceCalculation Source #
budgetpat :: Lens' c (Maybe Text) Source #
color__ :: Lens' c Bool Source #
conversionop :: Lens' c (Maybe ConversionOp) Source #
date2NoUpdate :: Lens' c Bool Source #
declared :: Lens' c Bool Source #
depthNoUpdate :: Lens' c (Maybe Int) Source #
drop__ :: Lens' c Int Source #
empty__ :: Lens' c Bool Source #
format :: Lens' c StringFormat Source #
infer_prices :: Lens' c Bool Source #
interval :: Lens' c Interval Source #
invert :: Lens' c Bool Source #
layout :: Lens' c Layout Source #
no_elide :: Lens' c Bool Source #
no_total :: Lens' c Bool Source #
normalbalance :: Lens' c (Maybe NormalSign) Source #
percent :: Lens' c Bool Source #
periodNoUpdate :: Lens' c Period Source #
pretty :: Lens' c Bool Source #
querystringNoUpdate :: Lens' c [Text] Source #
realNoUpdate :: Lens' c Bool Source #
related :: Lens' c Bool Source #
row_total :: Lens' c Bool Source #
show_costs :: Lens' c Bool Source #
sort_amount :: Lens' c Bool Source #
statusesNoUpdate :: Lens' c [Status] Source #
transpose__ :: Lens' c Bool Source #
Instances
class HasReportOptsNoUpdate a => HasReportOpts a where Source #
Special lenses for ReportOpts which also update the Query and QueryOpts in ReportSpec. Note that these are not true lenses, as they have a further restriction on the functor. This will work as a normal lens for all common uses, but since they don't obey the lens laws for some fancy cases, they may fail in some exotic circumstances.
Note that setEither/overEither should only be necessary with querystring and reportOpts: the other lenses should never fail.
Examples:
>>>import Lens.Micro (set)>>>_rsQuery <$> setEither querystring ["assets"] defreportspecRight (Acct (RegexpCI "assets"))>>>_rsQuery <$> setEither querystring ["(assets"] defreportspecLeft "this regular expression could not be compiled: (assets">>>_rsQuery $ set querystring ["assets"] defreportspecAcct (RegexpCI "assets")>>>_rsQuery $ set querystring ["(assets"] defreportspec*** Exception: Error: Updating ReportSpec failed: try using overEither instead of over or setEither instead of set>>>_rsQuery $ set period (MonthPeriod 2021 08) defreportspecDate DateSpan 2021-08
Minimal complete definition
Nothing
Methods
reportOpts :: ReportableLens' a ReportOpts Source #
period :: ReportableLens' a Period Source #
statuses :: ReportableLens' a [Status] Source #
depth :: ReportableLens' a (Maybe Int) Source #
date2 :: ReportableLens' a Bool Source #
real :: ReportableLens' a Bool Source #
querystring :: ReportableLens' a [Text] Source #
Instances
| HasReportOpts ReportSpec Source # | |
Defined in Hledger.Reports.ReportOptions Methods reportOpts :: ReportableLens' ReportSpec ReportOpts Source # period :: ReportableLens' ReportSpec Period Source # statuses :: ReportableLens' ReportSpec [Status] Source # depth :: ReportableLens' ReportSpec (Maybe Int) Source # date2 :: ReportableLens' ReportSpec Bool Source # real :: ReportableLens' ReportSpec Bool Source # querystring :: ReportableLens' ReportSpec [Text] Source # | |
| HasReportOpts ReportOpts Source # | |
Defined in Hledger.Reports.ReportOptions Methods reportOpts :: ReportableLens' ReportOpts ReportOpts Source # period :: ReportableLens' ReportOpts Period Source # statuses :: ReportableLens' ReportOpts [Status] Source # depth :: ReportableLens' ReportOpts (Maybe Int) Source # date2 :: ReportableLens' ReportOpts Bool Source # real :: ReportableLens' ReportOpts Bool Source # querystring :: ReportableLens' ReportOpts [Text] Source # | |
data ReportSpec Source #
The result of successfully parsing a ReportOpts on a particular
Day. Any ambiguous dates are completed and Queries are parsed,
ensuring that there are no regular expression errors. Values here
should be used in preference to re-deriving them from ReportOpts.
If you change the query_ in ReportOpts, you should call
reportOptsToSpec to regenerate the ReportSpec with the new
Query.
Constructors
| ReportSpec | |
Fields
| |
Instances
class HasReportSpec c where Source #
Minimal complete definition
Methods
reportSpec :: Lens' c ReportSpec Source #
rsQuery :: Lens' c Query Source #
rsQueryOpts :: Lens' c [QueryOpt] Source #
rsReportOpts :: Lens' c ReportOpts Source #
Instances
| HasReportSpec ReportSpec Source # | |
Defined in Hledger.Reports.ReportOptions Methods reportSpec :: Lens' ReportSpec ReportSpec Source # rsDay :: Lens' ReportSpec Day Source # rsQuery :: Lens' ReportSpec Query Source # | |
overEither :: ((a -> Either e b) -> s -> Either e t) -> (a -> b) -> s -> Either e t Source #
Apply a function over a lens, but report on failure.
setEither :: ((a -> Either e b) -> s -> Either e t) -> b -> s -> Either e t Source #
Set a field using a lens, but report on failure.
data BalanceCalculation Source #
What to calculate for each cell in a balance report. "Balance report types -> Calculation type" in the hledger manual.
Constructors
| CalcChange | Sum of posting amounts in the period. |
| CalcBudget | Sum of posting amounts and the goal for the period. |
| CalcValueChange | Change from previous period's historical end value to this period's historical end value. |
| CalcGain | Change from previous period's gain, i.e. valuation minus cost basis. |
Instances
| Eq BalanceCalculation Source # | |
Defined in Hledger.Reports.ReportOptions Methods (==) :: BalanceCalculation -> BalanceCalculation -> Bool # (/=) :: BalanceCalculation -> BalanceCalculation -> Bool # | |
| Show BalanceCalculation Source # | |
Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> BalanceCalculation -> ShowS # show :: BalanceCalculation -> String # showList :: [BalanceCalculation] -> ShowS # | |
| Default BalanceCalculation Source # | |
Defined in Hledger.Reports.ReportOptions Methods | |
data BalanceAccumulation Source #
How to accumulate calculated values across periods (columns) in a balance report. "Balance report types -> Accumulation type" in the hledger manual.
Constructors
| PerPeriod | No accumulation. Eg, shows the change of balance in each period. |
| Cumulative | Accumulate changes across periods, starting from zero at report start. |
| Historical | Accumulate changes across periods, including any from before report start. Eg, shows the historical end balance of each period. |
Instances
| Eq BalanceAccumulation Source # | |
Defined in Hledger.Reports.ReportOptions Methods (==) :: BalanceAccumulation -> BalanceAccumulation -> Bool # (/=) :: BalanceAccumulation -> BalanceAccumulation -> Bool # | |
| Show BalanceAccumulation Source # | |
Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> BalanceAccumulation -> ShowS # show :: BalanceAccumulation -> String # showList :: [BalanceAccumulation] -> ShowS # | |
| Default BalanceAccumulation Source # | |
Defined in Hledger.Reports.ReportOptions Methods | |
data AccountListMode Source #
Should accounts be displayed: in the command's default style, hierarchically, or as a flat list ?
Instances
| Eq AccountListMode Source # | |
Defined in Hledger.Reports.ReportOptions Methods (==) :: AccountListMode -> AccountListMode -> Bool # (/=) :: AccountListMode -> AccountListMode -> Bool # | |
| Show AccountListMode Source # | |
Defined in Hledger.Reports.ReportOptions Methods showsPrec :: Int -> AccountListMode -> ShowS # show :: AccountListMode -> String # showList :: [AccountListMode] -> ShowS # | |
| Default AccountListMode Source # | |
Defined in Hledger.Reports.ReportOptions Methods def :: AccountListMode # | |
data ValuationType Source #
What kind of value conversion should be done on amounts ? CLI: --value=then|end|now|DATE[,COMM]
Constructors
| AtThen (Maybe CommoditySymbol) | convert to default or given valuation commodity, using market prices at each posting's date |
| AtEnd (Maybe CommoditySymbol) | convert to default or given valuation commodity, using market prices at period end(s) |
| AtNow (Maybe CommoditySymbol) | convert to default or given valuation commodity, using current market prices |
| AtDate Day (Maybe CommoditySymbol) | convert to default or given valuation commodity, using market prices on some date |
Instances
| Eq ValuationType Source # | |
Defined in Hledger.Data.Valuation Methods (==) :: ValuationType -> ValuationType -> Bool # (/=) :: ValuationType -> ValuationType -> Bool # | |
| Show ValuationType Source # | |
Defined in Hledger.Data.Valuation Methods showsPrec :: Int -> ValuationType -> ShowS # show :: ValuationType -> String # showList :: [ValuationType] -> ShowS # | |
Constructors
| LayoutWide (Maybe Int) | |
| LayoutTall | |
| LayoutBare | |
| LayoutTidy |
Instances
rawOptsToReportOpts :: Day -> RawOpts -> ReportOpts Source #
Generate a ReportOpts from raw command-line input, given a day. This will fail with a usage error if it is passed - an invalid --format argument, - an invalid --value argument, - if --valuechange is called with a valuation type other than -V/--value=end. - an invalid --pretty argument,
setDefaultConversionOp :: ConversionOp -> ReportSpec -> ReportSpec Source #
Set the default ConversionOp.
reportOptsToSpec :: Day -> ReportOpts -> Either String ReportSpec Source #
Generate a ReportSpec from a set of ReportOpts on a given day.
updateReportSpec :: ReportOpts -> ReportSpec -> Either String ReportSpec Source #
Update the ReportOpts and the fields derived from it in a ReportSpec, or return an error message if there is a problem such as missing or unparseable options data. This is the safe way to change a ReportSpec, ensuring that all fields (_rsQuery, _rsReportOpts, querystring_, etc.) are in sync.
updateReportSpecWith :: (ReportOpts -> ReportOpts) -> ReportSpec -> Either String ReportSpec Source #
Like updateReportSpec, but takes a ReportOpts-modifying function.
rawOptsToReportSpec :: Day -> RawOpts -> Either String ReportSpec Source #
Generate a ReportSpec from RawOpts and a provided day, or return an error string if there are regular expression errors.
flat_ :: ReportOpts -> Bool Source #
tree_ :: ReportOpts -> Bool Source #
Legacy-compatible convenience aliases for accountlistmode_.
reportOptsToggleStatus :: Status -> ReportOpts -> ReportOpts Source #
Add/remove this status from the status list. Used by hledger-ui.
simplifyStatuses :: Ord a => [a] -> [a] Source #
Reduce a list of statuses to just one of each status, and if all statuses are present return the empty list.
whichDate :: ReportOpts -> WhichDate Source #
Report which date we will report on based on --date2.
journalValueAndFilterPostings :: ReportSpec -> Journal -> Journal Source #
Convert a Journal's amounts to cost and/or to value (see
journalApplyValuationFromOpts), and filter by the ReportSpec Query.
We make sure to first filter by amt: and cur: terms, then value the
Journal, then filter by the remaining terms.
journalValueAndFilterPostingsWith :: ReportSpec -> Journal -> PriceOracle -> Journal Source #
Like journalValueAndFilterPostings, but takes a PriceOracle as an argument.
journalApplyValuationFromOpts :: ReportSpec -> Journal -> Journal Source #
Convert this journal's postings' amounts to cost and/or to value, if specified by options (-B--cost-V-X--value etc.). Strip prices if not needed. This should be the main stop for performing costing and valuation. The exception is whenever you need to perform valuation _after_ summing up amounts, as in a historical balance report with --value=end. valuationAfterSum will check for this condition.
journalApplyValuationFromOptsWith :: ReportSpec -> Journal -> PriceOracle -> Journal Source #
Like journalApplyValuationFromOpts, but takes PriceOracle as an argument.
mixedAmountApplyValuationAfterSumFromOptsWith :: ReportOpts -> Journal -> PriceOracle -> DateSpan -> MixedAmount -> MixedAmount Source #
Select the Account valuation functions required for performing valuation after summing amounts. Used in MultiBalanceReport to value historical and similar reports.
valuationAfterSum :: ReportOpts -> Maybe (Maybe CommoditySymbol) Source #
If the ReportOpts specify that we are performing valuation after summing amounts, return Just of the commodity symbol we're converting to, Just Nothing for the default, and otherwise return Nothing. Used for example with historical reports with --value=end.
intervalFromRawOpts :: RawOpts -> Interval Source #
Get the report interval, if any, specified by the last of -p/--period, -D--daily, -W--weekly, -M/--monthly etc. options. An interval from --period counts only if it is explicitly defined.
queryFromFlags :: ReportOpts -> Query Source #
Convert report options to a query, ignoring any non-flag command line arguments.
transactionDateFn :: ReportOpts -> Transaction -> Day Source #
Select the Transaction date accessor based on --date2.
postingDateFn :: ReportOpts -> Posting -> Day Source #
Select the Posting date accessor based on --date2.
reportSpan :: Journal -> ReportSpec -> (DateSpan, [DateSpan]) Source #
The effective report span is the start and end dates specified by options or queries, or otherwise the earliest and latest transaction or posting dates in the journal. If no dates are specified by options/queries and the journal is empty, returns the null date span. Also return the intervals if they are requested.
reportSpanBothDates :: Journal -> ReportSpec -> (DateSpan, [DateSpan]) Source #
Like reportSpan, but uses both primary and secondary dates when calculating the span.
reportStartDate :: Journal -> ReportSpec -> Maybe Day Source #
reportEndDate :: Journal -> ReportSpec -> Maybe Day Source #
reportPeriodStart :: ReportSpec -> Maybe Day Source #
reportPeriodOrJournalStart :: ReportSpec -> Journal -> Maybe Day Source #
reportPeriodLastDay :: ReportSpec -> Maybe Day Source #
reportPeriodOrJournalLastDay :: ReportSpec -> Journal -> Maybe Day Source #
reportPeriodName :: BalanceAccumulation -> [DateSpan] -> DateSpan -> Text Source #
Make a name for the given period in a multiperiod report, given the type of balance being reported and the full set of report periods. This will be used as a column heading (or row heading, in a register summary report). We try to pick a useful name as follows:
- ending-balance reports: the period's end date
- balance change reports where the periods are months and all in the same year: the short month name in the current locale
- all other balance change reports: a description of the datespan, abbreviated to compact form if possible (see showDateSpan).