ChargingManagerImplementation

Implementation of the ChargingManager Protocol - this is only meant to be instantiated internally.

Hierarchy

• ChargingManager
  • ChargingManagerImplementation

Index

Methods

• __aenter__
• __aexit__
• __init__
• calculate_max_event_charge_count_within_limit
• calculate_total_charged_amount
• charge
• get_charged_event_count
• get_max_total_charge_usd
• get_pricing_info

Properties

• LOCAL_CHARGING_LOG_DATASET_NAME

Methods

__aenter__

• async __aenter__(): None

• Initialize the charging manager - this is called by the Actor class and shouldn't be invoked manually.

  ---

  Returns None

__aexit__

• async __aexit__(exc_type, exc_value, exc_traceback): None

• Parameters

  • exc_type: type[BaseException] | None

  • exc_value: BaseException | None

  • exc_traceback: TracebackType | None

  Returns None

__init__

• __init__(configuration, client): None

• Parameters

  • configuration: Configuration

  • client: ApifyClientAsync

  Returns None

calculate_max_event_charge_count_within_limit

• calculate_max_event_charge_count_within_limit(event_name): int | None

• Overrides ChargingManager.calculate_max_event_charge_count_within_limit

  Calculate how many instances of an event can be charged before we reach the configured limit.

  ---

  Parameters

  • event_name: str

    Name of the inspected event.

  Returns int | None

calculate_total_charged_amount

• calculate_total_charged_amount(): Decimal

• Overrides ChargingManager.calculate_total_charged_amount

  Calculate the total amount of money charged for pay-per-event events so far.

  ---

  Returns Decimal

charge

• async charge(event_name, count): ChargeResult

• Overrides ChargingManager.charge

  Charge for a specified number of events - sub-operations of the Actor.

  This is relevant only for the pay-per-event pricing model.

  ---

  Parameters

  • event_name: str

    Name of the event to be charged for.

  • optionalcount: int = 1

    Number of events to charge for.

  Returns ChargeResult

get_charged_event_count

• get_charged_event_count(event_name): int

• Overrides ChargingManager.get_charged_event_count

  Get the number of events with the given name that were charged so far.

  ---

  Parameters

  • event_name: str

    Name of the inspected event.

  Returns int

get_max_total_charge_usd

• get_max_total_charge_usd(): Decimal

• Overrides ChargingManager.get_max_total_charge_usd

  Get the configured maximum total charge for this Actor run.

  ---

  Returns Decimal

get_pricing_info

• get_pricing_info(): ActorPricingInfo

• Overrides ChargingManager.get_pricing_info

  Retrieve detailed information about the effective pricing of the current Actor run.

  This can be used for instance when your code needs to support multiple pricing models in transition periods.

  ---

  Returns ActorPricingInfo

Properties

LOCAL_CHARGING_LOG_DATASET_NAME

LOCAL_CHARGING_LOG_DATASET_NAME: Undefined