On 09/30/2015 10:08 AM, Dougal Matthews wrote:
Hi,
What is the standard practice for defining public API's for OpenStack
libraries? As I am working on refactoring and updating tripleo-common I have
to grep through the projects I know that use it to make sure I don't break
anything.
Personally I would choose to have a policy of "If it is documented, it is
public" because that is very clear and it still allows us to do internal
refactoring.
Otherwise we could use __all__ to define what is public in each file, or
assume everything that doesn't start with an underscore is public.
Cheers,
Dougal
Hi,
my preference would be to follow the same approach which is used in oslo
libraries (I think these libs should be take as a best practice example
if possible). And oslo libs AFAIK use the last of your options.
But if there is a plan to build some thin REST API layer on top if it, I
think that versioning will be necessary. So I would lean to the default
underscore convention in versioned directory structure :).
Jan
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
