Module: pay_receive

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 abc import ABC
from dataclasses import dataclass
from cl.runtime.records.record_mixin import RecordMixin
from cl.tradeentry.trades.pay_receive_key import PayReceiveKey


@dataclass(slots=True, kw_only=True)
class PayReceive(PayReceiveKey, RecordMixin[PayReceiveKey], ABC):
    """Determines if we pay or receive payments or periodic coupons for a trade or leg."""

    comment: str | None = None
    """Optional comment."""

    def get_key(self) -> PayReceiveKey:
        return PayReceiveKey(pay_receive_id=self.pay_receive_id)

Classes

class PayReceive (*, pay_receive_id: str = None, comment: str | None = None)

Determines if we pay or receive payments or periodic coupons for a trade or leg.

Expand source code

@dataclass(slots=True, kw_only=True)
class PayReceive(PayReceiveKey, RecordMixin[PayReceiveKey], ABC):
    """Determines if we pay or receive payments or periodic coupons for a trade or leg."""

    comment: str | None = None
    """Optional comment."""

    def get_key(self) -> PayReceiveKey:
        return PayReceiveKey(pay_receive_id=self.pay_receive_id)

Ancestors

PayReceiveKey
KeyMixin
RecordMixin
abc.ABC
typing.Generic

Static methods

def get_key_type() -> Type: Inherited from: PayReceiveKey.get_key_type

Return key type even when called from a record.

Fields

var comment -> str | None: Optional comment.
var pay_receive_id -> str: Inherited from: PayReceiveKey.pay_receive_id

Unique PayReceive identifier.

Methods

def get_key(self) -> PayReceiveKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.