Do not raise a DeprecationWarning in stripe.app_info

[akx]

Fixes #1167.

Regressed in 0c7ad96 (#1153).

[CLAassistant]

All committers have signed the CLA.

[akx]

cc @pakrym-stripe

[pakrym-stripe]

I'm afraid we need that line for the reason the comment outlined.
Will wrapping that import with

        with warnings.catch_warnings():
            warnings.filterwarnings("ignore", category=DeprecationWarning)

work?

[akx]

@pakrym-stripe What is the late import the comment refers to? I tried figuring it out, but no luck.

As I see it, the line

stripe-python/stripe/__init__.py

Line 18 in 5ab12c6

import stripe.app_info

ends up importing app_info, so app_info is <module 'stripe.app_info' from '/usr/local/lib/python3.12/site-packages/stripe/app_info.py'> after that (and a deprecation warning was emitted).

Then, the name is overwritten with None some lines later:

stripe-python/stripe/__init__.py

Line 31 in 5ab12c6

app_info: Optional[AppInfo] = None

[pakrym-stripe]

Yes, and app_info variable is used for a different purpose. If you don't import app_info module early, the late import will overwrite the stripe.app_info. This was a naming mistake on our part, unfortunately.

[akx]

I'm still not following the terminology "late import" here, unless you mean this corner-case situation (which is not really what I'd call a late import), when an user imports stripe, then separately does import stripe.app_info and not from stripe import app_info (note how the import order has an effect too):

(no-deprecation-warning-on-import) $ python -c 'import stripe; import stripe.app_info as ai; from stripe import app_info as ai2; print(ai, ai2)'
<module 'stripe.app_info'> <module 'stripe.app_info'>
(no-deprecation-warning-on-import) $ python -c 'import stripe; from stripe import app_info as ai2; import stripe.app_info as ai; print(ai, ai2)'
<module 'stripe.app_info'> None

(master) $ python -c 'import stripe; import stripe.app_info as ai; from stripe import app_info as ai2; print(ai, ai2)'
None None
(master) $ python -c 'import stripe; from stripe import app_info as ai2; import stripe.app_info as ai; print(ai, ai2)'
None None

(Across all of GitHub, there seems to be exactly one place that does import stripe.app_info: this repository and this line of code.)

[akx]

Also, with the current setup there's actually no point in stripe.app_info even having the DeprecationWarning in the first place; since it's implicitly imported by import stripe, trying to re-import it would not emit the warning again (because the module will have already been executed).

On that note, if you like, @pakrym-stripe, I can rework this PR to just remove the DeprecationWarning from there.

[pakrym-stripe]

unless you mean this corner-case situation (which is not really what I'd call a late import), when an user imports stripe, then separately does import stripe.app_info

Yep, that.

python -c 'import stripe; import stripe.app_info; print(stripe.app_info)'
<module 'stripe.app_info' from '/Users/pakrym/stripe/stripe-python/stripe/app_info.py'>

If stripe.app_info if not eagerly imported in __init__, the separate import of stripe.app_info will overwrite stripe.app_info.

Also, with the current setup there's actually no point in stripe.app_info even having the DeprecationWarning in the first place; since it's implicitly imported by import stripe, trying to re-import it would not emit the warning again (because the module will have already been executed).

You are right here, but we'd like to keep all backward compatibility re-exporting files uniform. We also have have a linter that depend on the warning being there (https://github.com/stripe/stripe-python/blob/master/flake8_stripe/flake8_stripe.py#L136)

[akx]

I think the suggested warnings.catch_warnings() filter thing is a bit of a silly waste of users' cycles (especially since it's not thread-safe, etc., etc.), if the simplest option is to get rid of the deprecation warning (with a suitable comment explaining why it's not there) and adding an exemption for that file – after all, there are per-file-ignores for IMP102s already.

[pakrym-stripe]

Alright, but please leave the

  The stripe.app_info package is deprecated, please change your
    imports to import from stripe directly.
    From:
      from stripe.app_info import AppInfo
    To:
      from stripe import AppInfo

part as a comment

[akx]

@pakrym-stripe Okiedoke, changed. Flake8 seems to be happy locally too.

[pakrym-stripe]

Great work! Thank you for your help @akx !