add --sys-paths to include new paths of sys.path

Author: ClericPy

README.md

@@ -373,6 +373,11 @@ Details:
 
 # Changelogs
 
+- 2021.04.11
+  - add `--sys-paths` to include new paths of sys.path
+    - support TEMP/HOME/SELF prefix, separated by commas
+    - sometimes be used for separating pyz code from requirements
+      - requirements often be installed by `pip install xxx -t $SOME_PATH`
 - 2021.04.01
   - use `ensurepip` instead of install `pip` while running with `lazy-install`
   - `unzip_path` has been set to `SELF/zipapps_cache` by default when `lazy_install` is `True`

test_utils.py

@@ -440,6 +440,21 @@ def test_create_app_function():
     assert stdout_output.count(b'zipapps_cache') == 2, stdout_output.count(
         b'zipapps_cache')
 
+    # test sys_path
+    _clean_paths()
+    # pip install by given --target
+    args = [
+        sys.executable, '-m', 'pip', 'install', 'bottle', '-t', './bottle_env'
+    ]
+    subprocess.Popen(args=args).wait()
+    mock_requirement = Path('_requirements.txt')
+    mock_requirement.write_text('bottle')
+    old_file = create_app(sys_paths='SELF/bottle_env')
+    output = subprocess.check_output([
+        sys.executable, 'app.pyz', '-c', "import bottle;print(bottle.__file__)"
+    ]).decode()
+    assert 'bottle_env' in output
+
 
 def main():
     """

zipapps/__init__.py

@@ -2,4 +2,4 @@
 from .main import create_app
 from .activate_zipapps import activate
 __all__ = ['create_app', 'activate']
-__version__ = '2021.04.01'
+__version__ = '2021.04.11'

zipapps/__main__.py

@@ -156,7 +156,7 @@ def main():
         default='',
         dest='env_paths',
         help='Default --zipapps arg if it is not given while running.'
-        ' Support TEMP/HOME/SELF prefix.')
+        ' Support TEMP/HOME/SELF prefix, separated by commas.')
     parser.add_argument(
         '--delay',
         '-d',
@@ -167,6 +167,14 @@ def main():
         dest='lazy_install',
         help='Install packages with pip while running, which means '
         'requirements will not be install into pyz file.')
+    parser.add_argument('--sys-paths',
+                        '--sys-path',
+                        '--py-path',
+                        '--python-path',
+                        default='',
+                        dest='sys_paths',
+                        help='Paths be insert to sys.path[-1] while running.'
+                        ' Support TEMP/HOME/SELF prefix, separated by commas.')
     if len(sys.argv) == 1:
         return parser.print_help()
     args, pip_args = parser.parse_known_args()
@@ -187,6 +195,7 @@ def main():
         build_id=args.build_id,
         env_paths=args.env_paths,
         lazy_install=args.lazy_install,
+        sys_paths=args.sys_paths,
     )
 
 

zipapps/ensure_zipapps_template.py

@@ -34,16 +34,16 @@ def prepare_path():
     """Template code for zipapps entry point. Run with current PYTHONPATH"""
     # PYTHONPATH=./app.pyz
     zip_file_path = Path(__file__).parent.absolute()
-    python_path_list = [str(zip_file_path)]
+    _zipapps_python_path_list = [str(zip_file_path)]
     unzip = os.environ.get('ZIPAPPS_UNZIP') or r'''{unzip}'''
     if unzip:
         _cache_folder = os.environ.get('ZIPAPPS_CACHE') or os.environ.get(
             'UNZIP_PATH') or r'''{unzip_path}'''
 
         _cache_folder_path = ensure_path(_cache_folder)
         _cache_folder_path = _cache_folder_path / zip_file_path.stem
-        _cache_folder_abs_path = str(_cache_folder_path.absolute())
-        python_path_list.insert(0, _cache_folder_abs_path)
+        _cache_folder_path_str = str(_cache_folder_path.absolute())
+        _zipapps_python_path_list.insert(0, _cache_folder_path_str)
         ts_file_name = '_zip_time_{ts}'
         if not (_cache_folder_path / ts_file_name).is_file():
             # check timestamp difference by file name, need to refresh _cache_folder
@@ -57,7 +57,7 @@ def prepare_path():
                     file_dir_name = os.path.splitext(
                         member.filename.split('/')[0])[0]
                     if unzip == '*' or member.filename in _need_unzip_names or file_dir_name in _need_unzip_names:
-                        zf.extract(member, path=_cache_folder_abs_path)
+                        zf.extract(member, path=_cache_folder_path_str)
             # lazy pip install
             lazy_pip_dir = _cache_folder_path / r'''{LAZY_PIP_DIR_NAME}'''
             if lazy_pip_dir.is_dir():
@@ -69,23 +69,31 @@ def prepare_path():
                 import subprocess
                 shell_args = [
                     sys.executable, '-m', 'pip', 'install', '--target',
-                    _cache_folder_abs_path
+                    _cache_folder_path_str
                 ] + {pip_args_repr}
                 with subprocess.Popen(shell_args,
-                                      cwd=_cache_folder_abs_path) as proc:
+                                      cwd=_cache_folder_path_str) as proc:
                     proc.wait()
     sep = ';' if sys.platform == 'win32' else ':'
     ignore_system_python_path = {ignore_system_python_path}
+    _new_sys_paths = r'''{sys_paths}'''.strip()
+    if _new_sys_paths:
+        new_sys_paths = [str(ensure_path(p)) for p in _new_sys_paths.split(',')]
+    else:
+        new_sys_paths = []
     if ignore_system_python_path:
         sys.path.clear()
         # env of Popen is not valid for win32 platform, use os.environ instead.
-        os.environ['PYTHONPATH'] = sep.join(python_path_list)
+        _new_paths = _zipapps_python_path_list + new_sys_paths
     else:
-        os.environ['PYTHONPATH'] = sep.join(python_path_list) + sep + (
-            os.environ.get('PYTHONPATH') or '')
+        _old_path = os.environ.get('PYTHONPATH') or ''
+        _new_paths = _zipapps_python_path_list + [_old_path] + new_sys_paths
+    os.environ['PYTHONPATH'] = sep.join(_new_paths)
     # let the dir path first
-    paths = [path for path in python_path_list if path not in sys.path]
-    sys.path = paths + sys.path
+    zipapps_paths = [
+        path for path in _zipapps_python_path_list if path not in sys.path
+    ]
+    sys.path = zipapps_paths + sys.path + new_sys_paths
 
 
 prepare_path()

zipapps/main.py

@@ -61,6 +61,7 @@ def prepare_entry(
     ts='None',
     env_paths: str = '',
     pip_args: list = None,
+    sys_paths: str = '',
 ):
     unzip_names = set(unzip.split(',')) if unzip else set()
     warning_names: typing.Dict[str, dict] = {}
@@ -114,6 +115,7 @@ def prepare_entry(
         'env_paths': env_paths,
         'LAZY_PIP_DIR_NAME': Config.LAZY_PIP_DIR_NAME,
         'pip_args_repr': repr(pip_args),
+        'sys_paths': sys_paths,
     }
     code = get_data('zipapps', '_entry_point.py').decode('u8')
     (cache_path / '__main__.py').write_text(code.format(**kwargs))
@@ -214,6 +216,7 @@ def create_app(
     build_id: str = '',
     env_paths: str = '',
     lazy_install: bool = False,
+    sys_paths: str = '',
 ):
     tmp_dir: tempfile.TemporaryDirectory = None
     try:
@@ -269,6 +272,7 @@ def create_app(
             ts=set_timestamp(_cache_path),
             env_paths=env_paths,
             pip_args=pip_args,
+            sys_paths=sys_paths,
         )
         if compiled:
             if not unzip: