Lazy import loaders's dependencies

Author: j178

README-EN.md

@@ -42,7 +42,7 @@ git clone https://github.com/yihong0618/GitHubPoster.git
 ## pip install
 
 ```
-pip3 install -U github_poster
+pip3 install -U 'github_poster[all]'
 ```
 
 ## Install(Python3.6+)

README.md

@@ -54,7 +54,7 @@ git clone https://github.com/yihong0618/GitHubPoster.git
 ## pip 安装
 
 ```
-pip3 install -U github_poster
+pip3 install -U 'github_poster[all]'
 ```
 
 ## 安装(Python3.6+)

github_poster/circluar_drawer.py

@@ -162,7 +162,6 @@ def _draw_circle_segment(
         center,
         key_animate,
     ):
-        color = self.make_color(self.poster.length_range_by_date, length)
         color = self.make_color(self.poster.length_range_by_date, length)
         r1 = rr.lower()
         r2 = (

github_poster/cli.py

@@ -4,19 +4,20 @@
 
 import argparse
 import os
+import sys
 
 from github_poster.circluar_drawer import CircularDrawer
 from github_poster.config import TYPE_INFO_DICT
 from github_poster.drawer import Drawer
+from github_poster.err import DepNotInstalledError
 from github_poster.loader import LOADER_DICT
 from github_poster.poster import Poster
-from github_poster.skyline import Skyline
 from github_poster.utils import parse_years
 
 OUT_FOLDER = os.path.join(os.getcwd(), "OUT_FOLDER")
 
 
-def main():
+def run():
     """Handle command line arguments and call other modules as needed."""
     p = Poster()
     args_parser = argparse.ArgumentParser()
@@ -133,6 +134,14 @@ def main():
 
     # generate skyline
     if args.with_skyline:
+        try:
+            from github_poster.skyline import Skyline
+        except ImportError:
+            raise Exception(
+                "Skyline dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[skyline]' to install."
+            )
+
         if args.skyline_year:
             year = args.skyline_year
         else:
@@ -153,5 +162,12 @@ def main():
         s.make_skyline()
 
 
+def main():
+    try:
+        run()
+    except DepNotInstalledError as e:
+        print(e, file=sys.stderr)
+
+
 if __name__ == "__main__":
     main()

github_poster/err.py

@@ -12,3 +12,8 @@ class CircularDrawError(BaseDrawError):
     """
 
     pass
+
+
+class DepNotInstalledError(Exception):
+    def __str__(self):
+        return self.args[0]

github_poster/loader/__init__.py

@@ -13,7 +13,7 @@
 from github_poster.loader.json_loader import JsonLoader
 from github_poster.loader.kindle_loader import KindleLoader
 from github_poster.loader.leetcode_loader import LeetcodeLoader
-from github_poster.loader.multiple_loader import MutipleLoader
+from github_poster.loader.multiple_loader import MultipleLoader
 from github_poster.loader.notion_loader import NotionLoader
 from github_poster.loader.nrc_loader import NRCLoader
 from github_poster.loader.ns_loader import NSLoader
@@ -43,7 +43,7 @@
     "kindle": KindleLoader,
     "wakatime": WakaTimeLoader,
     "dota2": Dota2Loader,
-    "multiple": MutipleLoader,
+    "multiple": MultipleLoader,
     "nike": NRCLoader,
     "notion": NotionLoader,
     "garmin": GarminLoader,
@@ -71,7 +71,7 @@
     "TwitterLoader",
     "WakaTimeLoader",
     "YouTubeLoader",
-    "MutipleLoader",
+    "MultipleLoader",
     "NotionLoader",
     "NRCLoader",
     "LOADER_DICT",

github_poster/loader/base_loader.py

@@ -4,7 +4,6 @@
 from http.cookies import SimpleCookie
 
 import pendulum
-import pytz
 from requests.utils import cookiejar_from_dict
 
 from github_poster.loader.config import TIME_ZONE
@@ -33,6 +32,11 @@ def __init__(self, from_year, to_year, _type, **kwargs):
         self.special_number2 = None
         self.number_list = []
         self.year_list = self._make_years_list()
+        self.try_import_deps()
+
+    @classmethod
+    def try_import_deps(cls):
+        pass
 
     def _make_years_list(self):
         return list(range(int(self.from_year), int(self.to_year) + 1))
@@ -66,7 +70,7 @@ def make_special_number(self):
             self.special_number2 = number_list_set[-1 * int(number_list_set_len * 0.50)]
 
     def adjust_time(self, time):
-        tc_offset = datetime.now(pytz.timezone(self.time_zone)).utcoffset()
+        tc_offset = datetime.now(pendulum.timezone(self.time_zone)).utcoffset()
         return time + tc_offset
 
     @staticmethod

github_poster/loader/bilibili_loader.py

@@ -1,6 +1,5 @@
 import time
 from collections import defaultdict
-from http.cookies import SimpleCookie
 
 import pendulum
 import requests

github_poster/loader/from_github_issue_loader.py

@@ -1,6 +1,6 @@
 import pendulum
-from github import Github
 
+from github_poster.err import DepNotInstalledError
 from github_poster.loader.base_loader import BaseLoader
 
 
@@ -12,6 +12,16 @@ def __init__(self, from_year, to_year, _type, **kwargs):
         # for private repo
         self.token = kwargs.get("github_token", "")
 
+    @classmethod
+    def try_import_deps(cls):
+        try:
+            import github
+        except ImportError:
+            raise DepNotInstalledError(
+                "GitHub dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[github]' to install."
+            ) from None
+
     @classmethod
     def add_loader_arguments(cls, parser, optional):
         parser.add_argument(
@@ -45,6 +55,8 @@ def __map_func(comment):
             return 0
 
     def get_api_data(self):
+        from github import Github
+
         if self.token:
             u = Github(self.token)
             me = u.get_user().login

github_poster/loader/garmin_loader.py

@@ -1,7 +1,6 @@
 from collections import defaultdict
 
-from garminconnect import Garmin
-
+from github_poster.err import DepNotInstalledError
 from github_poster.loader.base_loader import BaseLoader
 
 
@@ -19,6 +18,16 @@ def __init__(self, from_year, to_year, _type, **kwargs):
         self.is_cn = kwargs.get("cn", False)
         self.client = None
 
+    @classmethod
+    def try_import_deps(cls):
+        try:
+            import garminconnect
+        except ImportError:
+            raise DepNotInstalledError(
+                "Garmin dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[garmin]' to install."
+            ) from None
+
     @classmethod
     def add_loader_arguments(cls, parser, optional):
         parser.add_argument(
@@ -37,6 +46,8 @@ def add_loader_arguments(cls, parser, optional):
         )
 
     def _get_access(self):
+        from garminconnect import Garmin
+
         try:
             self.client = Garmin(
                 self.garmin_user_name, self.garmin_password, is_cn=self.is_cn

github_poster/loader/gpx_loader.py

@@ -2,8 +2,7 @@
 import os
 from collections import defaultdict
 
-import gpxpy
-
+from github_poster.err import DepNotInstalledError
 from github_poster.loader.base_loader import BaseLoader, LoadError
 from github_poster.loader.config import GPX_ACTIVITY_NAME_TUPLE
 
@@ -18,6 +17,16 @@ def __init__(self, from_year, to_year, _type, **kwargs):
         self.after = None
         self.base_dir = kwargs.get("gpx_dir", "")
 
+    @classmethod
+    def try_import_deps(cls):
+        try:
+            import gpxpy
+        except ImportError:
+            raise DepNotInstalledError(
+                "GPX dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[gpx]' to install."
+            ) from None
+
     @classmethod
     def add_loader_arguments(cls, parser, optional):
         parser.add_argument(
@@ -45,6 +54,8 @@ def _list_gpx_files(self):
                 yield path_name
 
     def __parse_gpx(self, file_name):
+        import gpxpy
+
         with open(file_name) as f:
             gpx = gpxpy.parse(f)
             try:

github_poster/loader/jike_loader.py

@@ -1,6 +1,5 @@
 import json
 import time
-from http.cookies import SimpleCookie
 from random import randint
 from re import compile
 

github_poster/loader/multiple_loader.py

@@ -6,7 +6,7 @@
 from github_poster.loader.base_loader import BaseLoader
 
 
-class MutipleLoader(BaseLoader):
+class MultipleLoader(BaseLoader):
     def __init__(self, from_year, to_year, _type, **kwargs):
         super().__init__(from_year, to_year, _type)
         self.types = kwargs.get("types", "")

github_poster/loader/strava_loader.py

@@ -1,8 +1,7 @@
 import datetime
 from collections import defaultdict
 
-import stravalib
-
+from github_poster.err import DepNotInstalledError
 from github_poster.loader.base_loader import BaseLoader, LoadError
 
 
@@ -11,6 +10,8 @@ class StravaLoader(BaseLoader):
 
     def __init__(self, from_year, to_year, _type, **kwargs):
         super().__init__(from_year, to_year, _type)
+        import stravalib
+
         self.before = None
         self.after = None
         self.number_by_date_dict = defaultdict(float)
@@ -20,6 +21,16 @@ def __init__(self, from_year, to_year, _type, **kwargs):
         self.refresh_token = kwargs.get("strava_refresh_token", "")
         self.strava_access = False
 
+    @classmethod
+    def try_import_deps(cls):
+        try:
+            import stravalib
+        except ImportError:
+            raise DepNotInstalledError(
+                "Strava dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[strava]' to install."
+            ) from None
+
     @classmethod
     def add_loader_arguments(cls, parser, optional):
         parser.add_argument(

github_poster/loader/twitter_loader.py

@@ -1,5 +1,4 @@
-import twint
-
+from github_poster.err import DepNotInstalledError
 from github_poster.loader.base_loader import BaseLoader
 
 
@@ -9,9 +8,21 @@ class TwitterLoader(BaseLoader):
 
     def __init__(self, from_year, to_year, _type, **kwargs):
         super().__init__(from_year, to_year, _type)
+        import twint
+
         self.user_name = kwargs.get("twitter_user_name", "")
         self.c = twint.Config()
 
+    @classmethod
+    def try_import_deps(cls):
+        try:
+            import twint
+        except ImportError:
+            raise DepNotInstalledError(
+                "Twitter dependencies are not installed, "
+                "please use 'pip3 install -U github_poster[twitter]' to install."
+            ) from None
+
     @classmethod
     def add_loader_arguments(cls, parser, optional):
         parser.add_argument(
@@ -23,6 +34,8 @@ def add_loader_arguments(cls, parser, optional):
         )
 
     def get_api_data(self):
+        import twint
+
         self.c.Username = self.user_name
         self.c.Custom["tweet"] = ["id"]
         self.c.Custom["user"] = ["bio"]

requirements.txt

@@ -1,13 +1 @@
-PyGithub
-gpxpy
-stravalib
-svgwrite
-pendulum
-requests
-colour
-# my fork from sdf
-sdf_fork
-# my fork twint for twitter loader
-twint_fork
-# for garmin connect
-garminconnect
+-e .[all]