tariochbctools.importers.general package

Submodules

tariochbctools.importers.general.mailAdapterImporter module

class tariochbctools.importers.general.mailAdapterImporter.MailAdapterImporter(importers)[source]

Bases: ImporterProtocol

An importer adapter that fetches file from mails and then calls another importer.

extract(file, existing_entries)[source]

Extract transactions from a file.

If the importer would like to flag a returned transaction as a known duplicate, it may opt to set the special flag “__duplicate__” to True, and the transaction should be treated as a duplicate by the extraction code. This is a way to let the importer use particular information about previously imported transactions in order to flag them as duplicates. For example, if an importer has a way to get a persistent unique id for each of the imported transactions. (See this discussion for context: https://groups.google.com/d/msg/beancount/0iV-ipBJb8g/-uk4wsH2AgAJ)

Parameters:

  • file – A cache.FileMemo instance.

  • existing_entries – An optional list of existing directives loaded from the ledger which is intended to contain the extracted entries. This is only provided if the user provides them via a flag in the extractor program.

Returns:

A list of new, imported directives (usually mostly Transactions) extracted from the file.

file_account(file)[source]

Return an account associated with the given file.

Note: If you don’t implement this method you won’t be able to move the files into its preservation hierarchy; the bean-file command won’t work.

Also, normally the returned account is not a function of the input file–just of the importer–but it is provided anyhow.

Parameters:

file – A cache.FileMemo instance.

Returns:

The name of the account that corresponds to this importer.

identify(file)[source]

Return true if this importer matches the given file.

Parameters:

file – A cache.FileMemo instance.

Returns:

A boolean, true if this importer can handle this file.

tariochbctools.importers.general.mt940importer module

class tariochbctools.importers.general.mt940importer.Importer(regexps, account)[source]

Bases: IdentifyMixin, ImporterProtocol

An importer for MT940 files.

extract(file, existing_entries)[source]

Extract transactions from a file.

If the importer would like to flag a returned transaction as a known duplicate, it may opt to set the special flag “__duplicate__” to True, and the transaction should be treated as a duplicate by the extraction code. This is a way to let the importer use particular information about previously imported transactions in order to flag them as duplicates. For example, if an importer has a way to get a persistent unique id for each of the imported transactions. (See this discussion for context: https://groups.google.com/d/msg/beancount/0iV-ipBJb8g/-uk4wsH2AgAJ)

Parameters:

  • file – A cache.FileMemo instance.

  • existing_entries – An optional list of existing directives loaded from the ledger which is intended to contain the extracted entries. This is only provided if the user provides them via a flag in the extractor program.

Returns:

A list of new, imported directives (usually mostly Transactions) extracted from the file.

file_account(file)[source]

Return an account associated with the given file.

Note: If you don’t implement this method you won’t be able to move the files into its preservation hierarchy; the bean-file command won’t work.

Also, normally the returned account is not a function of the input file–just of the importer–but it is provided anyhow.

Parameters:

file – A cache.FileMemo instance.

Returns:

The name of the account that corresponds to this importer.

identify(file)[source]

Return true if this importer matches the given file.

Parameters:

file – A cache.FileMemo instance.

Returns:

A boolean, true if this importer can handle this file.

prepare_narration(trxdata)[source]
prepare_payee(trxdata)[source]

tariochbctools.importers.general.priceLookup module

class tariochbctools.importers.general.priceLookup.PriceLookup(existing_entries, baseCcy: str)[source]

Bases: object

fetchPrice(instrument: str, date: date)[source]
fetchPriceAmount(instrument: str, date: date)[source]

Module contents