Realize

Provides models for representing the results of running a realization.

`Account (BaseModel)` `pydantic-model`

A simplified view of an entire beancount account.

The primary differenece between this and a RealAccount is that it strips out all children and provides some other useful data points like when the account was opened or closed. Removing the children greatly reduces the size of this model, especially when being rendered in something like JSON.

Attributes:

Name	Type	Description
`balance`	`Dict[str, bdantic.models.data.Inventory]`	A mapping of currencies to inventories.
`close`	`Optional[datetime.date]`	The (optional) date the account was closed.
`directives`	`TxnPostings`	All directives associated with this account.
`name`	`str`	The account name.
`open`	`date`	The date the account was opened.

Source code in bdantic/models/realize.py

class Account(BaseModel):
    """A simplified view of an entire beancount account.

    The primary differenece between this and a `RealAccount` is that it strips
    out all children and provides some other useful data points like when the
    account was opened or closed. Removing the children greatly reduces the
    size of this model, especially when being rendered in something like JSON.

    Attributes:
        balance: A mapping of currencies to inventories.
        close: The (optional) date the account was closed.
        directives: All directives associated with this account.
        name: The account name.
        open: The date the account was opened.
    """

    balance: Dict[str, Inventory]
    close: Optional[date]
    directives: TxnPostings
    name: str
    open: date

    @staticmethod
    def parse(obj: realization.RealAccount) -> Account:
        """Parses a beancount RealAccount into this model

        Args:
            obj: The Beancount RealAccount

        Returns:
            A new instance of this model
        """
        txn_postings = TxnPostings.parse(obj.txn_postings)  # type: ignore

        open = txn_postings.filter("[?ty == 'Open']")
        assert open is not None
        assert len(open) == 1

        close = txn_postings.filter("[?ty == 'Close']")
        if close:
            assert len(close) < 2
            close_date = close[0].date
        else:
            close_date = None

        split = obj.balance.split()
        map = {}
        for k, v in split.items():
            map[k] = Inventory.parse(v)

        return Account(
            balance=map,
            close=close_date,
            directives=txn_postings,
            open=open[0].date,
            name=obj.account,
        )

    @staticmethod
    def from_real(ra: RealAccount) -> Account:
        """Creates a new instance of `Account` using details from a
        [RealAccount][bdantic.models.realize.RealAccount].

        Args:
            ra: The RealAccount to use

        Returns:
            A new instance of Account
        """
        open = ra.txn_postings.filter("[?ty == `Open`]")
        assert open is not None
        assert len(open) == 1

        close = ra.txn_postings.filter("[?ty == `Close`]")
        if close:
            assert len(close) < 2
            close_date = close[0].date
        else:
            close_date = None

        return Account(
            balance=ra.cur_map,
            close=close_date,
            directives=ra.txn_postings,
            open=open[0].date,
            name=ra.account,
        )

    def export(self):
        raise NotImplementedError

`from_real(ra)` `staticmethod`

Creates a new instance of Account using details from a RealAccount.

Parameters:

Name	Type	Description	Default
`ra`	`RealAccount`	The RealAccount to use	required

Returns:

Type	Description
`Account`	A new instance of Account

Source code in bdantic/models/realize.py

@staticmethod
def from_real(ra: RealAccount) -> Account:
    """Creates a new instance of `Account` using details from a
    [RealAccount][bdantic.models.realize.RealAccount].

    Args:
        ra: The RealAccount to use

    Returns:
        A new instance of Account
    """
    open = ra.txn_postings.filter("[?ty == `Open`]")
    assert open is not None
    assert len(open) == 1

    close = ra.txn_postings.filter("[?ty == `Close`]")
    if close:
        assert len(close) < 2
        close_date = close[0].date
    else:
        close_date = None

    return Account(
        balance=ra.cur_map,
        close=close_date,
        directives=ra.txn_postings,
        open=open[0].date,
        name=ra.account,
    )

`parse(obj)` `staticmethod`

Parses a beancount RealAccount into this model

Parameters:

Name	Type	Description	Default
`obj`	`realization.RealAccount`	The Beancount RealAccount	required

Returns:

Type	Description
`Account`	A new instance of this model

Source code in bdantic/models/realize.py

@staticmethod
def parse(obj: realization.RealAccount) -> Account:
    """Parses a beancount RealAccount into this model

    Args:
        obj: The Beancount RealAccount

    Returns:
        A new instance of this model
    """
    txn_postings = TxnPostings.parse(obj.txn_postings)  # type: ignore

    open = txn_postings.filter("[?ty == 'Open']")
    assert open is not None
    assert len(open) == 1

    close = txn_postings.filter("[?ty == 'Close']")
    if close:
        assert len(close) < 2
        close_date = close[0].date
    else:
        close_date = None

    split = obj.balance.split()
    map = {}
    for k, v in split.items():
        map[k] = Inventory.parse(v)

    return Account(
        balance=map,
        close=close_date,
        directives=txn_postings,
        open=open[0].date,
        name=obj.account,
    )

`RealAccount (Base)` `pydantic-model`

A model representing a beancount.core.realize.RealAccount.

A RealAccount is represented as a dictionary in beancount which contains additional attributes for describing details about the account. This model matches those details, however, the dictinary representation of a RealAccount is moved to the dedicated children field.

Attributes:

Name	Type	Description
`ty`	`Literal['RealAccount']`	A string literal identifying this model.
`account`	`str`	The account name.
`balance`	`Inventory`	The balance of the account
`children`	`Dict[str, bdantic.models.realize.RealAccount]`	All children that belong to this account.
`cur_map`	`Dict[str, bdantic.models.data.Inventory]`	A map of currencies to their respective balances.
`txn_postings`	`TxnPostings`	A list of directives in which this account appears.

Source code in bdantic/models/realize.py

class RealAccount(Base, smart_union=True):
    """A model representing a `beancount.core.realize.RealAccount`.

    A `RealAccount` is represented as a dictionary in beancount which contains
    additional attributes for describing details about the account. This model
    matches those details, however, the dictinary representation of a
    `RealAccount` is moved to the dedicated `children` field.

    Attributes:
        ty: A string literal identifying this model.
        account: The account name.
        balance: The balance of the account
        children: All children that belong to this account.
        cur_map: A map of currencies to their respective balances.
        txn_postings: A list of directives in which this account appears.
    """

    ty: Literal["RealAccount"] = "RealAccount"
    account: AccountName
    balance: Inventory
    children: Dict[str, RealAccount]
    cur_map: Dict[str, Inventory]
    txn_postings: TxnPostings

    @classmethod
    def parse(cls, obj: realization.RealAccount) -> RealAccount:
        """Parses a beancount RealAccount into this model

        Args:
            obj: The Beancount RealAccount

        Returns:
            A new instance of this model
        """
        children = {}
        for k, v in obj.items():
            children[k] = RealAccount.parse(v)

        split = obj.balance.split()
        map = {}
        for k, v in split.items():
            map[k] = Inventory.parse(v)

        return RealAccount(
            account=obj.account,
            balance=Inventory.parse(obj.balance),
            children=children,
            cur_map=map,
            txn_postings=TxnPostings.parse(obj.txn_postings),  # type: ignore
        )

    def export(self) -> realization.RealAccount:
        """Exports this model into a beancount RealAccount

        Returns:
            A new instance of a beancount RealAccount
        """
        ra = realization.RealAccount(self.account)
        for k, v in self.children.items():
            ra[k] = v.export()

        ra.txn_postings = self.txn_postings.export()  # type: ignore
        ra.balance = self.balance.export()

        return ra

    def to_account(self) -> Account:
        """Converts this RealAccount into an Account instance.

        Returns:
            A new Account instance
        """
        return Account.from_real(self)

`export(self)`

Exports this model into a beancount RealAccount

Returns:

Type	Description
`realization.RealAccount`	A new instance of a beancount RealAccount

Source code in bdantic/models/realize.py

def export(self) -> realization.RealAccount:
    """Exports this model into a beancount RealAccount

    Returns:
        A new instance of a beancount RealAccount
    """
    ra = realization.RealAccount(self.account)
    for k, v in self.children.items():
        ra[k] = v.export()

    ra.txn_postings = self.txn_postings.export()  # type: ignore
    ra.balance = self.balance.export()

    return ra

`parse(obj)` `classmethod`

Parses a beancount RealAccount into this model

Parameters:

Name	Type	Description	Default
`obj`	`realization.RealAccount`	The Beancount RealAccount	required

Returns:

Type	Description
`RealAccount`	A new instance of this model

Source code in bdantic/models/realize.py

@classmethod
def parse(cls, obj: realization.RealAccount) -> RealAccount:
    """Parses a beancount RealAccount into this model

    Args:
        obj: The Beancount RealAccount

    Returns:
        A new instance of this model
    """
    children = {}
    for k, v in obj.items():
        children[k] = RealAccount.parse(v)

    split = obj.balance.split()
    map = {}
    for k, v in split.items():
        map[k] = Inventory.parse(v)

    return RealAccount(
        account=obj.account,
        balance=Inventory.parse(obj.balance),
        children=children,
        cur_map=map,
        txn_postings=TxnPostings.parse(obj.txn_postings),  # type: ignore
    )

`to_account(self)`

Converts this RealAccount into an Account instance.

Returns:

Type	Description
`Account`	A new Account instance

Source code in bdantic/models/realize.py

def to_account(self) -> Account:
    """Converts this RealAccount into an Account instance.

    Returns:
        A new Account instance
    """
    return Account.from_real(self)

`TxnPostings (BaseList)` `pydantic-model`

A model representing the txnpostings found within RealAccount's.

Source code in bdantic/models/realize.py

class TxnPostings(BaseList):
    """A model representing the txnpostings found within RealAccount's."""

    __root__: List[ModelTxnPosting]

    @classmethod
    def parse(
        cls,
        obj: List[BeanTxnPosting],
    ) -> TxnPostings:
        return TxnPostings(
            __root__=[_type_map[type(d)].parse(d) for d in obj]  # type: ignore
        )

    def export(self) -> List[BeanTxnPosting]:
        return [d.export() for d in self.__root__]

`export(self)`

Exports this model into it's associated beancount type

Returns:

Type	Description
`List[BeanTxnPosting]`	A new instance of the beancount type

Source code in bdantic/models/realize.py

def export(self) -> List[BeanTxnPosting]:
    return [d.export() for d in self.__root__]

`parse(obj)` `classmethod`

Parses a beancount type into this model

Parameters:

Name	Type	Description	Default
`obj`	`List[BeanTxnPosting]`	The Beancount type to parse	required

Returns:

Type	Description
`TxnPostings`	A new instance of this model

Source code in bdantic/models/realize.py

@classmethod
def parse(
    cls,
    obj: List[BeanTxnPosting],
) -> TxnPostings:
    return TxnPostings(
        __root__=[_type_map[type(d)].parse(d) for d in obj]  # type: ignore
    )

Realize

Account (BaseModel) pydantic-model

from_real(ra) staticmethod

parse(obj) staticmethod

RealAccount (Base) pydantic-model

export(self)

parse(obj) classmethod

to_account(self)

TxnPostings (BaseList) pydantic-model

export(self)

parse(obj) classmethod

`Account (BaseModel)` `pydantic-model`

`from_real(ra)` `staticmethod`

`parse(obj)` `staticmethod`

`RealAccount (Base)` `pydantic-model`

`export(self)`

`parse(obj)` `classmethod`

`to_account(self)`

`TxnPostings (BaseList)` `pydantic-model`

`export(self)`

`parse(obj)` `classmethod`