pyblish / pyblish-base

Pyblish base library - see https://github.com/pyblish/pyblish for details.
Other
127 stars 59 forks source link

Visually separate private from public modules #295

Open mottosso opened 8 years ago

mottosso commented 8 years ago

Goal

Make it unmistakably easy to spot which of the Python modules are for public consumption, and which are internal to the framework.

Implementation

Suffix private modules with an _.

In practice, this means all modules, except api.py and util.py (and main.py for backwards compatibility).

This will likely break a minority of code out there, but in a good way. Users depending on this functionality now will get bit sooner or later and I'd rather have that happen openly, publicly and unambiguously, so we can work towards either exposing private members being used or finding a public way of achieving the goal.