alibabacloud_oss_v2.retry package

Submodules

alibabacloud_oss_v2.retry.backoff module

Modules for backoff

class alibabacloud_oss_v2.retry.backoff.BackoffDelayer[source]

Bases: ABC

Abstract base class for backoff delayer.

abstract backoff_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Returns:

delay duration in second.

Return type:

float

class alibabacloud_oss_v2.retry.backoff.EqualJitterBackoff(base_delay: float, max_backoff: float)[source]

Bases: BackoffDelayer

EqualJJitterBackoff implements equal jitter backoff. ceil = min(2 ^ attempts * baseDealy, maxBackoff) ceil/2 + [0.0, 1.0) *(ceil/2 + 1)

Parameters:

  • base_delay (float) – the base delay duration in second

  • max_backoff (float) – the max duration in second

backoff_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Returns:

delay duration in second.

Return type:

float

class alibabacloud_oss_v2.retry.backoff.FixedDelayBackoff(backoff: float)[source]

Bases: BackoffDelayer

FixedDelayBackoff implements fixed backoff.

Parameters:

backoff (float) – the delay duration in second

backoff_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Returns:

delay duration in second.

Return type:

float

class alibabacloud_oss_v2.retry.backoff.FullJitterBackoff(base_delay: float, max_backoff: float)[source]

Bases: BackoffDelayer

FullJitterBackoff implements capped exponential backoff with jitter. [0.0, 1.0) * min(2 ^ attempts * baseDealy, maxBackoff)

Parameters:

  • base_delay (float) – the base delay duration in second

  • max_backoff (float) – the max duration in second

backoff_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Returns:

delay duration in second.

Return type:

float

alibabacloud_oss_v2.retry.error_retryable module

Modules for error retryable

class alibabacloud_oss_v2.retry.error_retryable.ClientErrorRetryable[source]

Bases: ErrorRetryable

ClientErrorRetryable implements client’s error checker

is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Returns:

True if the error is retryable.

Return type:

bool

class alibabacloud_oss_v2.retry.error_retryable.ErrorRetryable[source]

Bases: ABC

Abstract base class for backoff delayer.

abstract is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Returns:

True if the error is retryable.

Return type:

bool

class alibabacloud_oss_v2.retry.error_retryable.HTTPStatusCodeRetryable[source]

Bases: ErrorRetryable

HTTPStatusCodeRetryable implements http status checker

is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Returns:

True if the error is retryable.

Return type:

bool

class alibabacloud_oss_v2.retry.error_retryable.ServiceErrorCodeRetryable[source]

Bases: ErrorRetryable

ServiceErrorCodeRetryable implements service’s error code checker

is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Returns:

True if the error is retryable.

Return type:

bool

alibabacloud_oss_v2.retry.retryer_impl module

Modules for retryer

class alibabacloud_oss_v2.retry.retryer_impl.NopRetryer[source]

Bases: Retryer

nop retryer

is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Return type:

bool

Returns:

True if the error is retryable.

max_attempts() → int[source]

Retrieve max attempts.

Return type:

int

Returns:

max attempts.

retry_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Return type:

float

Returns:

delay duration in second.

class alibabacloud_oss_v2.retry.retryer_impl.StandardRetryer(max_attempts: int | None = None, max_backoff: float | None = None, base_delay: float | None = None, error_retryables: List[ErrorRetryable] | None = None, backoff_delayer: BackoffDelayer | None = None)[source]

Bases: Retryer

standard retryer

Parameters:

  • max_attempts (int, optional) – max retry attempt

  • max_backoff (float, optional) – the max duration in second.

  • base_delay (float, optional) – the base delay duration in second.

  • error_retryables ([ErrorRetryable], optional) – error retryables list.

  • backoff_delayer ([BackoffDelayer], optional) – backoff delayer.

is_error_retryable(error: Exception) → bool[source]

Check whether the error is retryable.

Parameters:

error (Exception) – the error meets

Return type:

bool

Returns:

True if the error is retryable.

max_attempts() → int[source]

Retrieve max attempts.

Return type:

int

Returns:

max attempts.

retry_delay(attempt: int, error: Exception) → float[source]

Returns the delay that should be used before retrying the attempt.

Parameters:

  • attempt (int) – current retry attempt

  • error (Exception) – the error meets

Return type:

float

Returns:

delay duration in second.

Module contents