Ignore F401 for __init__.py files

[mbr0wn]

These files routinely import other modules without immediately using them with the intention of making them available to the importing module. Moreover, they are rarely even supposed to be used within the same __init__.py file. Marking all of them 'noqa: F410' is redundant.

[github-actions]

Thank you for contributing! 👋

[github-actions]

Thank you for contributing! 👋

Since this changes the Coding Conventions, I'll @-mention the appropriate NI engineers.
@alejandro5042
@DavidCurtiss
@irwand
@jryckman
@kcuzner
@mshafer-NI
@neilvana
@nethrasuresh
@pakdev
@rtzoeller
@sbethur
@stick152
@tkrebes
@Adithyak1998
@innagarc
@ShibaniRout

[mshafer-NI]

Have you considered declaring the __all__ list? this creates a reference while also explicitly declaring the API.
(reference https://docs.python.org/3/tutorial/modules.html#importing-from-a-package)

[mbr0wn]

Hey @mshafer-NI ,

I don't understand the connection to this change request. I'm talking about not having to amend files like this: https://github.com/ni/python-styleguide/blob/main/ni_python_styleguide/_utils/__init__.py

If I understand this correctly, __all__ is for people doing from x import * (which they shouldn't do according to our own style guide). This doesn't apply to existing __init__.py files that already import stuff from submodules.

[mshafer-NI]

__all__ is set in the __init__ file (and yes, it's impact is on clients doing from from x import *)

I'll send you an example offline

[mbr0wn]

@mshafer-NI thanks for sending those explanations, and also the docs on __all__, I learned something along the way.

After processing it for a few days, I still think this here is the right way to go. Also, having scoured peoples thoughts and opinions I really think that __all__ should be used when from X import * does something undesirable, like export functions we want otherwise not exported, or trigger some action that takes long. It should not be used just so we can disable F401 warnings without having to type noqa: F401. The downside of using __all__ is that you now have to maintain lists of exports when doing other changes, which increases maintenance burden and redundancy in __init__.py files.

[mshafer-NI]

Thanks for the response. Two notes:

1. This is a drastic departure from current direction and requires more changes in this PR (this rule becomes an "Avoid" instead of "Do Not", and it needs a lot more examples of when is ok and when is not)
2. We will need buy-in from the rest of the PWG members. I've added this to the agenda for our next meeting on April 17th and will forward you the invite.

[mbr0wn]

The suggestion I'm making is extremely narrow (just limited to __init__.py files), so we should keep the "Do Not" (but I guess we need to update the title). Everything that was previously done to avoid this error (use noqa or duplicate symbol names into __all__) is still valid and won't throw errors/warnings. I think this won't break the bank 😄

[mbr0wn]

I updated the language according to our conversation.

[irwand]

Thank you for your patience with this.