Module: amount_entry

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from cl.runtime.records.dataclasses_extensions import missing
from cl.convince.entries.entry import Entry
from cl.convince.entries.entry_key import EntryKey


@dataclass(slots=True, kw_only=True)
class AmountEntry(Entry):
    """Amount with or without currency specification."""

    amount: float = missing()
    """Numerical value for the amount including any units multiplier (e.g. 1,000,000 for 1m)."""

    currency_entry: EntryKey | None = None
    """Optional entry for the currency if specified along with the amount."""

Classes

Amount with or without currency specification.

Expand source code

@dataclass(slots=True, kw_only=True)
class AmountEntry(Entry):
    """Amount with or without currency specification."""

    amount: float = missing()
    """Numerical value for the amount including any units multiplier (e.g. 1,000,000 for 1m)."""

    currency_entry: EntryKey | None = None
    """Optional entry for the currency if specified along with the amount."""

Ancestors

Entry
EntryKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Static methods

def check_entry_id(entry_id: str) -> None: Inherited from: Entry.check_entry_id

Check that the unique identifier is compliant with the expected format.
def get_entry_id(record_type: str, title: str, body: str | None = None, data: str | None = None) -> str: Inherited from: Entry.get_entry_id

Create the unique identifier from parameters.
def get_key_type() -> Type: Inherited from: Entry.get_key_type

Return key type even when called from a record.
def parse_optional_bool(field_value: str | None, *, field_name: str | None = None) -> bool | None: Inherited from: Entry.parse_optional_bool

Parse an optional boolean value.
def parse_required_bool(field_value: str | None, *, field_name: str | None = None) -> bool: Inherited from: Entry.parse_required_bool

Parse an optional boolean value.

Fields

var amount -> float: Numerical value for the amount including any units multiplier (e.g. 1,000,000 for 1m).
var approved_by -> UserKey | None: Inherited from: Entry.approved_by

User who recorded the approval.
var body -> str | None: Inherited from: Entry.body

Optional body of the entry if not completely described by the title (included in MD5 hash).
var currency_entry -> EntryKey | None: Optional entry for the currency if specified along with the amount.
var data -> str | None: Inherited from: Entry.data

Optional supporting data in YAML format (included in MD5 hash).
var entry_id -> str: Inherited from: Entry.entry_id

Based on record type, title and MD5 hash of body and data if present, EntryUtil.create_id is used to generate.
var few_shot -> bool | None: Inherited from: Entry.few_shot

If True, use this entry as a few-shot example.
var title -> str: Inherited from: Entry.title

Title of a long entry or complete description of a short one (included in MD5 hash).

Methods

def get_key(self) -> EntryKey: Inherited from: Entry.get_key

Return a new key object whose fields populated from self, do not return self.
def get_text(self) -> str: Inherited from: Entry.get_text

Get the complete text of the entry.
def init(self) -> None: Inherited from: Entry.init

Generate entry_id in ‘type: title’ format followed by an MD5 hash of body and data if present.
def init_all(self) -> None: Inherited from: Entry.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.
def run_propose(self) -> None: Inherited from: Entry.run_propose

Generate or regenerate the proposed value.