Repository navigation
happybase emulation docs mention private api #1761
Description
the page at https://googlecloudplatform.github.io/gcloud-python/latest/happybase-package.html mentions make_row() and make_ordered_row(), both of which are not public api. please don't mention those at all. :)
(fyi: i'm the happybase author)
Activity
dhermes commentedon Apr 28, 2016
@wbolster
happybase.table.make_rowandhappybase.table.make_ordered_roware both public in thehappybase.tablemodule / namespace. I realize they are helpers / not intended for users, but the names don't start with_, hence they are public. I'm happy to remove them since they both just raise aNotImplementedError.I totally recognized your name, though thanks for the reminder you're the author.
wbolster commentedon Apr 28, 2016
well, as i am the author, i can assure you that api is not public. regardless of its name. these functions serve no use to the end user of the library.
to clear up your misunderstanding: the public api is even more limited. the whole
happybase.tablemodule is not public, nor are any of its sibling modules. the only public api is the one described in the documentation, and it's exported/imported from the mainhappybasepackage. anything that useshappybase.submodule.somethingis poking into internals, and that should not be done, even though we're consenting adults.dhermes commentedon Apr 28, 2016
Gotcha. I didn't realize. I'd suggest renaming those modules with an
_to make that clear / be in line with Python convention.rimey commentedon Apr 28, 2016
I'm not sure how common it is to add a leading underscore to the names of private modules in the wider Python world.
dhermes commentedon Apr 29, 2016
Having a leading underscore is the "definition" of non-public. Maybe I'm crazy?
wbolster commentedon May 2, 2016
There is no single definition of what consitutes private/public in Python.
In general, for more established and matured projects, documented API and documented usage patterns (e.g. this class is public API, but instantiation should only happen through this other class) constitute what should be considered public API, and by extension, everything else is not public API.
Naming conventions and things like
__all__surely help here, but those are never leading and often insufficient anyway to express the intentions of the author/maintainer.Removing mention of undocumented HappyBase functions.
chore: remove sync response logs in AuthorizedSession (#1761)
fix: Due to upstream change in dataset, updates expected results (#1761)
feat: add support for df.loc[list, column(s)] (#1761)