Being more explicit with documenting public API #2235

Activity

1. jku commented on Dec 19, 2022

   

   jku

   on Dec 19, 2022

   Last edited by jku

   Member

   More actions

   I'll leave some comments for ngclient since I think that's the easy case:

   • I'm pretty happy with what is in tuf/ngclient/__init__.py: that really defines the public ngclient API. Defining __all__ sounds good to me -- but not sure if it changes anything from default? Maybe defining __all__ even if it is same as default is good practice? 🤷
   • in hindsight, all of the sub modules could have been internal (so updater.py could be _updater.py or _internal/updater.py)
     • If we did that, probably the only required addition to __init__.py might be a import TargetFile (because the updater API exposes it so makes sense to make it available)
     • This would be an API change but likely not a problematic one

   I think the ngclient changes sound reasonable (not strictly necessary but result would likely be better software)

   👍React with 👍1Reacted by Fridolín Pokorný
2. fridex commented on Jan 26, 2023

   

   fridex

   on Jan 26, 2023

   ContributorAuthor

   More actions

   See also #2234 (comment)
3. lukpueh commented on Apr 1, 2025

   

   lukpueh

   on Apr 1, 2025

   Member

   More actions

   Is there still a wish to add __all__ to tuf.api.init`?