apm-agent-python icon indicating copy to clipboard operation
apm-agent-python copied to clipboard

updated the __all__ section to include all 22 publicly exposed varia…

Open md-adil opened this issue 1 month ago • 6 comments

What does this pull request do?

This makes it clear which symbols are part of the public API and improves IDE autocomplete and static analysis for Python integrations using this package.

md-adil avatar Dec 04 '25 19:12 md-adil

💚 CLA has been signed

:robot: GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

github-actions[bot] avatar Dec 04 '25 19:12 github-actions[bot]

❌ Author of the following commits did not sign a Contributor Agreement: 5dd814b

Please, read and sign the above mentioned agreement if you want to contribute to this project

Hi team, I’ve already signed the Elastic CLA, but the CLA check on this PR still shows “not signed” and asks me to sign again.

I verified:

  • I used the same GitHub account while signing the CLA.
  • My Git commit email matches my GitHub primary email.

Could you please re-trigger or manually validate the CLA check?
Thanks!

md-adil avatar Dec 05 '25 14:12 md-adil

cla/check

xrmx avatar Dec 09 '25 14:12 xrmx

@md-adil If you look at the commit history in https://github.com/elastic/apm-agent-python/pull/2504/commits you'll see that your commit is not linked to your account. I guess that's because you commit with an email that is different than the one you use on github. I think that's the reason CLA check is red.

xrmx avatar Dec 09 '25 14:12 xrmx

@md-adil If you look at the commit history in https://github.com/elastic/apm-agent-python/pull/2504/commits you'll see that your commit is not linked to your account. I guess that's because you commit with an email that is different than the one you use on github. I think that's the reason CLA check is red.

Yep thanks,

i was just checking account, not the commit. it's done!

md-adil avatar Dec 09 '25 15:12 md-adil

@md-adil which tools are struggling with not having the symbols in __all__?

xrmx avatar Dec 16 '25 08:12 xrmx

all

Some tools rely on __all__ to determine which names are publicly exported. In VS Code, this is handled by Pylance (Pyright) for auto-imports, IntelliSense, and static analysis. If a symbol is exposed at runtime but missing from __all__, those tools treat it as non-public.

async_capture_span is just one example of a symbol that was available but not listed in __all__. This PR ensures that __all__ accurately reflects all intended public exports, so editor tooling and static analysis behave consistently.

md-adil avatar Dec 16 '25 09:12 md-adil