Allow setting stripe.max_network_retries to affect HTTPClients

[timvisher]

Motivation

Before this patch, setting stripe.max_network_retries had no affect on
the following code.

import stripe
import sys

stripe.api_key = sys.argv[1]
stripe.max_network_retries = 5
client = stripe.http_client.RequestsClient(timeout=0.1)
stripe.default_http_client = client
stripe.log = 'info'

while True:
    try:
        charges = stripe.Charge.list()
    except stripe.error.APIConnectionError as e:
        print(e.user_message)
        break

message='Request to Stripe api' method=get path=https://api.stripe.com/v1/charges
Unexpected error communicating with Stripe.  If this problem persists,
let us know at [email protected].

(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))

After the patch, I can utilize stripe.max_network_retries effectively.

message='Request to Stripe api' method=get path=https://api.stripe.com/v1/charges
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 1 for request get https://api.stripe.com/v1/charges after sleeping 0.50 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 2 for request get https://api.stripe.com/v1/charges after sleeping 0.98 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 3 for request get https://api.stripe.com/v1/charges after sleeping 1.87 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 4 for request get https://api.stripe.com/v1/charges after sleeping 1.99 seconds.'
Unexpected error communicating with Stripe.  If this problem persists,
let us know at [email protected].

(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))

Cross Reference

Workaround

Until this is merged it's possible to work around this issue by directly
setting the HTTPClient's _max_network_retries method:

import stripe
import sys

stripe.api_key = sys.argv[1]
client = stripe.http_client.RequestsClient(timeout=0.1)
client._max_network_retries = lambda: 5
stripe.default_http_client = client
stripe.log = 'info'

while True:
    try:
        charges = stripe.Charge.list()
    except stripe.error.APIConnectionError as e:
        print(e.user_message)
        break

message='Request to Stripe api' method=get path=https://api.stripe.com/v1/charges
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 1 for request get https://api.stripe.com/v1/charges after sleeping 0.50 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 2 for request get https://api.stripe.com/v1/charges after sleeping 0.59 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 3 for request get https://api.stripe.com/v1/charges after sleeping 1.77 seconds.'
message="Encountered a retryable error Unexpected error communicating with Stripe.  If this problem persists,\nlet us know at [email protected].\n\n(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))"
message='Initiating retry 4 for request get https://api.stripe.com/v1/charges after sleeping 1.98 seconds.'
Unexpected error communicating with Stripe.  If this problem persists,
let us know at [email protected].

(Network error: ReadTimeout: HTTPSConnectionPool(host='api.stripe.com', port=443): Read timed out. (read timeout=0.1))~

[timvisher]

Happy to squash after approval. :)

[brandur-stripe]

@timvisher Thanks for the contribution Tim! I don't think I 100% follow the patch — do you know why the variable must be explicitly imported under certain conditions?

[timvisher]

@brandur-stripe IIUC, it's not that it's under certain conditions but that python doesn't propagate values changes to module variables after import.

I don't have an easy way to demonstrate this in a shell, I don't think, but basically once I have value imported, if I set it again the module that imported it doesn't see the update. The way to get the update is to re-import it.

I may be wrong on this point though. I'm more of a Clojure rather than a Python dev. :)

[timvisher]

I assume, given the Cross Reference, that this is either a common pattern or the only way to accomplish this while still maintaining the module API constraints (setting things on stripe.* rather than initializing sub-components with some new value).

[brandur-stripe]

Ah, yes that makes sense. Would you mind squashing then? This looks good to me.

[timvisher]

All done (in case you didn't see the squash). :)

[brandur-stripe]

Thanks again!

[brandur-stripe]

Released as 2.10.1.