Hledger.Read.InputOptions

Various options to use when reading journal files. Similar to CliOptions.inputflags, simplifies the journal-reading functions.

Types and helpers for input options

data InputOpts

Constructors

InputOpts

Fields

• mformat_ :: Maybe StorageFormat

  a file/storage format to try, unless overridden by a filename prefix. Nothing means try all.

• mrules_file_ :: Maybe FilePath

  a conversion rules file to use (when reading CSV)

• aliases_ :: [String]

  account name aliases to apply

• anon_ :: Bool

  do light anonymisation/obfuscation of the data

• new_ :: Bool

  read only new transactions since this file was last read

• new_save_ :: Bool

  save latest new transactions state for next time

• pivot_ :: String

  use the given field's value as the account name

• forecast_ :: Maybe DateSpan

  span in which to generate forecast transactions

• reportspan_ :: DateSpan

  a dirty hack keeping the query dates in InputOpts. This rightfully lives in ReportSpec, but is duplicated here.

• auto_ :: Bool

  generate automatic postings when journal is parsed

• infer_equity_ :: Bool

  generate automatic equity postings from transaction prices

• balancingopts_ :: BalancingOpts

  options for balancing transactions

• strict_ :: Bool

  do extra error checking (eg, all posted accounts are declared, no prices are inferred)

• _ioDay :: Day

  today's date, for use with forecast transactions XXX this duplicates _rsDay, and should eventually be removed when it's not needed anymore.

Instances

Show InputOpts

Defined in Hledger.Read.InputOptions

Methods

showsPrec :: Int -> InputOpts -> ShowS

show :: InputOpts -> String

showList :: [InputOpts] -> ShowS

HasBalancingOpts InputOpts

Defined in Hledger.Read.InputOptions

Methods

balancingOpts :: Lens' InputOpts BalancingOpts

commodity_styles :: Lens' InputOpts (Maybe (Map CommoditySymbol AmountStyle))

ignore_assertions :: Lens' InputOpts Bool

infer_transaction_prices :: Lens' InputOpts Bool

HasInputOpts InputOpts

Defined in Hledger.Read.InputOptions

Methods

inputOpts :: Lens' InputOpts InputOpts

aliases :: Lens' InputOpts [String]

anon__ :: Lens' InputOpts Bool

auto__ :: Lens' InputOpts Bool

balancingopts :: Lens' InputOpts BalancingOpts

forecast :: Lens' InputOpts (Maybe DateSpan)

infer_equity :: Lens' InputOpts Bool

ioDay :: Lens' InputOpts Day

mformat :: Lens' InputOpts (Maybe StorageFormat)

mrules_file :: Lens' InputOpts (Maybe FilePath)

new__ :: Lens' InputOpts Bool

new_save :: Lens' InputOpts Bool

pivot :: Lens' InputOpts String

reportspan :: Lens' InputOpts DateSpan

strict :: Lens' InputOpts Bool

class HasInputOpts c where

Minimal complete definition

inputOpts

Methods

inputOpts :: Lens' c InputOpts

aliases :: Lens' c [String]

anon__ :: Lens' c Bool

auto__ :: Lens' c Bool

balancingopts :: Lens' c BalancingOpts

forecast :: Lens' c (Maybe DateSpan)

infer_equity :: Lens' c Bool

ioDay :: Lens' c Day

mformat :: Lens' c (Maybe StorageFormat)

mrules_file :: Lens' c (Maybe FilePath)

new__ :: Lens' c Bool

new_save :: Lens' c Bool

pivot :: Lens' c String

reportspan :: Lens' c DateSpan

strict :: Lens' c Bool

Instances

HasInputOpts InputOpts

Defined in Hledger.Read.InputOptions

Methods

inputOpts :: Lens' InputOpts InputOpts

aliases :: Lens' InputOpts [String]

anon__ :: Lens' InputOpts Bool

auto__ :: Lens' InputOpts Bool

balancingopts :: Lens' InputOpts BalancingOpts

forecast :: Lens' InputOpts (Maybe DateSpan)

infer_equity :: Lens' InputOpts Bool

ioDay :: Lens' InputOpts Day

mformat :: Lens' InputOpts (Maybe StorageFormat)

mrules_file :: Lens' InputOpts (Maybe FilePath)

new__ :: Lens' InputOpts Bool

new_save :: Lens' InputOpts Bool

pivot :: Lens' InputOpts String

reportspan :: Lens' InputOpts DateSpan

strict :: Lens' InputOpts Bool

definputopts :: InputOpts

forecastPeriod :: InputOpts -> Journal -> Maybe DateSpan

Get the Maybe the DateSpan to generate forecast options from. This begins on: - the start date supplied to the `--forecast` argument, if present - otherwise, the later of - the report start date if specified with -b-pdate: - the day after the latest normal (non-periodic) transaction in the journal, if any - otherwise today. It ends on: - the end date supplied to the `--forecast` argument, if present - otherwise the report end date if specified with -e-pdate: - otherwise 180 days (6 months) from today.