Improve readability and testability of code#11
Improve readability and testability of code#11joeyshi12 wants to merge 9 commits intoForrestKnight:masterfrom
Conversation
|
A lot of this is very helpful! I haven't gone through all of it, but I will. The only issue I see with it is that it's quite a bit different from the YouTube Data API doc code. That may be better, but it could cause some trouble in the future for others trying to understand the code. Let me think on this a bit longer. |
Good point. I can isolate some of the YouTube boilerplate code better and remove some of my changes to that specific part later. But, I think using an adapter for the api client helps to unbundle some complex logic in the main method and it will also offer some nice auto-completion hints from the ide (good for potential contributors) since we would have an interface for the api client in the codebase. |
Issue
Having all the logic bundled within a single main method is difficult to understand and test, so I broke up the code as much as I could in a way that could address both these problems.
Changes
YoutubeClientAdapter) to interface functions from the youtube api client and implement helper methods for the main methodYoutubeClientAdaptertestsviews,likes, etc..) to the statistics comment (stat_comment) to simplify generating new comment strings using theString.formatmethod (perhaps we should think about localizing this string in the future?)YoutubeClientAdapter#get_channel_videosrather than invoking a fetch operation for each videoratioto 0 in main method if there are 0 likes to avoid division by 0 errorAPI_KEYfor the.envfile__pycache__,.vscodeto .gitignore