core: add __all__ statements in sopel fix #765

[Exirel]

The __all__ statement in a Python module is used at import time when from module import * is used to expose only a defined list of object to be imported in the locals() environment of the importer.

Even though the Python documentation talks about "sub-modules" to import, it is widely used to define a set of names to import instead (being objects, functions, or sub-modules).

[dgw]

I made some easy tweaks. Adding documentation is a bit more than just adding __all__ statements, but I'm not going to complain about adding docstrings, like ever!

[dgw]

@Exirel I test-rendered the Sphinx docs to make sure your space-less display<target> method links worked as expected, and now I'm wondering if you would object to shortening some of the display names on parameter types. Like, showing sopel (sopel.bot.Sopel) is pretty verbose for that parameter to SopelWrapper, when it's even in the same module.

Also, I found a stray "arround" that I missed when reviewing earlier. :/

[Exirel]

showing sopel (sopel.bot.Sopel) is pretty verbose for that parameter to SopelWrapper

Oh yes, you're right. I don't object, quite the contrary, it's a good idea.

Also, I found a stray "arround" that I missed when reviewing earlier. :/

Will fix that.

[Exirel]

@dgw I added a commit where I added ~ in front of sopel.bot.Sopel, and I tried something with the overridden methods.

[dgw]

Also, I found a stray "arround" that I missed when reviewing earlier. :/

Will fix that.

It's still there. :/

sopel/sopel/bot.py

Line 836 in 87a1ca3

"""Wrapper arround a Sopel instance and a Trigger

Aside from that, I'm ready to ✔️ and .

[Exirel]

Aside from that, I'm ready to heavy_check_mark and .

I forgot, sorry. Should be good now. https://github.com/sopel-irc/sopel/pull/1582/files#diff-1cf03588484fddc0a6c0f9600a2d330cR869

[dgw]

Yep, it's good now.

[dgw]

I'm glad I gave this one more look. We could have broken some plugins that were doing from sopel.formatting import * and then trying to use colors.NAMEs.

[dgw]

Re-approved ✔️

Any further issues that slipped by will be caught by some brave soul running Sopel from source. 😁