refactor for OOP

ClericPy · ClericPy · commit 5be66db27e6d · 2021-04-25T01:48:00.000+08:00
diff --git a/README.md b/README.md
@@ -3,17 +3,25 @@
 
 Package your python code (with requirements) into a standalone zip file (like a `jar`).
 
-`zipapps` is a `pure-python library`, without any 3rd-party dependencies. Inspired by [shiv](https://github.com/linkedin/shiv) but unlike `shiv`, this lib will not always create new cache folders while running, and easy to combine multiple `venv.pyz` files then let them work well together.
+`zipapps` is a `pure-python library`, without any 3rd-party dependencies. Inspired by [shiv](https://github.com/linkedin/shiv) but unlike `shiv`, this lib will not always create new cache folders while running, and easy to combine multiple `venv.pyz` files then let them work well together. The `lazy install` mode will give your code the `cross-platform` and `cross-version` feature.
 
 # What is the `.pyz`?
 
 `.pyz` to **Python** is like `.jar` to **Java**. They are both zip archive files which aggregate many packages and associated metadata and resources (text, images, etc.) into one file for distribution. Then what you only need is a Python Interpreter as the runtime environment.
 
-PS: The **pyz** ext could be any other suffixes even without ext names, so you can rename `app.pyz` to `app.zip` as you wish. Depends on [PEP441](https://www.python.org/dev/peps/pep-0441/), then the apps may be `cross-platform` as long as written with pure python code without any C++ building processes.
+PS: The **pyz** ext could be any other suffixes even without ext names, so you can rename `app.pyz` to `app.zip` or `app.py` or others as you wish. Depends on [PEP441](https://www.python.org/dev/peps/pep-0441/) & [zipimport](https://docs.python.org/3/library/zipimport.html), the apps may be `cross-platform` as long as written with pure python code without any C++ building processes.
 
 # When to Use it?
    1. Package your code(package or model) into one zipped file. 
-      1. sometimes togather with the requirements.
+      1. Pure python code without any 3rd-party dependencies.
+      2. Python code with 3rd-party dependencies installed together.
+         1. Some dependencies need to unzip them into the cache folder for dynamic modules(`.so/.pyd`) files exist, such as `psutil`.
+            1. This type of `pyz` is `NOT cross-platform`.
+         2. Some dependencies need not to unzip them, such as requests / bottle.
+      3. Python code with requirements but not be installed while building. (**Recommended**)
+         1. The `lazy install` mode by the arg `-d`.
+         2. But will need to be install at the first running(only once).
+         3. This is `cross-platform` and `cross-python-version` because of their installation paths is standalone.
    2. Run with python interpreter from the venv path.
       1. which means the requirements(need to be unzipped) will be installed to the `venv` folder, not in `pyz` file.
       2. **build** your package into one `pyz` file with `-m package.module:function -p /venv/bin/python`.
@@ -406,6 +414,16 @@ Details:
 
 # Changelogs
 
+- 2021.04.24
+  - remove conflict command args with `pip`
+    - remove `--compile` arg, it will only work for `pip`
+    - `-c` will not be removed, `pip install -c` could use `pip install --constraint` instead
+  - Refactor for OOP(Object-oriented programming)
+    - Will be used as the **first stable version** and end experimental phase
+    - remove `Config` class
+    - show version info and other logs in stderr
+    - `compiled` should not be True while `unzip` is null
+    - a successful message has been added to the tail of logs: `Successfully built`
 - 2021.04.23
   - lazy install mode:
     - fix bug: python version conflict
diff --git a/test_utils.py b/test_utils.py
@@ -255,28 +255,17 @@ def test_create_app_function():
 
     # test compiled
     _clean_paths()
-    app_path = create_app(compiled=True, pip_args=['bottle'])
+    app_path = create_app(unzip='six', compiled=True, pip_args=['six'])
     output, _ = subprocess.Popen(
         [
             sys.executable,
-            str(app_path), '-c', 'import bottle;print(bottle.__cached__)'
+            str(app_path), '-c', 'import six;print(six.__cached__)'
         ],
         stderr=subprocess.PIPE,
         stdout=subprocess.PIPE,
     ).communicate()
     # print(output)
-    assert b'None' in output
-    app_path = create_app(unzip='bottle', compiled=True, pip_args=['bottle'])
-    output, _ = subprocess.Popen(
-        [
-            sys.executable,
-            str(app_path), '-c', 'import bottle;print(bottle.__cached__)'
-        ],
-        stderr=subprocess.PIPE,
-        stdout=subprocess.PIPE,
-    ).communicate()
-    # print(output)
-    assert b'.pyc' in output
+    assert b'.pyc' in output, output
 
     # test unzip with HOME / SELF / TEMP
     _clean_paths()
@@ -352,15 +341,16 @@ def test_create_app_function():
     # test for simple usage
     create_app(pip_args=['six'], output='six.pyz')
     Path('./entry_test.py').write_text('import six;print(six.__file__)')
-    _ = subprocess.Popen(
+    output, error = subprocess.Popen(
         [
             sys.executable, '-m', 'zipapps', '--zipapps', 'six.pyz', '-m',
             'entry_test', '-a', 'entry_test.py'
         ],
         stderr=subprocess.PIPE,
         stdout=subprocess.PIPE,
     ).communicate()
-    assert not any(_)
+    assert not output, output
+    assert b'Successfully built' in error, error
     output, error = subprocess.Popen(
         [sys.executable, './app.pyz'],
         stderr=subprocess.PIPE,
@@ -373,15 +363,15 @@ def test_create_app_function():
     # test for SELF arg
     create_app(pip_args=['six'], output='six.pyz')
     Path('./entry_test.py').write_text('import six;print(six.__file__)')
-    _ = subprocess.Popen(
+    _, error = subprocess.Popen(
         [
             sys.executable, '-m', 'zipapps', '--zipapps', 'SELF/six.pyz', '-m',
             'entry_test', '-a', 'entry_test.py'
         ],
         stderr=subprocess.PIPE,
         stdout=subprocess.PIPE,
     ).communicate()
-    assert not any(_)
+    assert b'Successfully built' in error
     output, error = subprocess.Popen(
         [sys.executable, './app.pyz'],
         stderr=subprocess.PIPE,
@@ -394,15 +384,15 @@ def test_create_app_function():
     # test for without --zipapps
     create_app(pip_args=['six'], output='six.pyz')
     Path('./entry_test.py').write_text('import six;print(six.__file__)')
-    _ = subprocess.Popen(
+    _, error = subprocess.Popen(
         [
             sys.executable, '-m', 'zipapps', '-m', 'entry_test', '-a',
             'entry_test.py'
         ],
         stderr=subprocess.PIPE,
         stdout=subprocess.PIPE,
     ).communicate()
-    assert not any(_)
+    assert b'Successfully built' in error
     output, error = subprocess.Popen(
         [sys.executable, './app.pyz'],
         stderr=subprocess.PIPE,
@@ -473,6 +463,9 @@ def main():
     test all cases
     """
     test_create_app_function()
+    print('=' * 80)
+    print('All tests finished.')
+    print('=' * 80)
 
 
 if __name__ == "__main__":
diff --git a/zipapps/__init__.py b/zipapps/__init__.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-from .main import create_app
+from .main import create_app, __version__
 from .activate_zipapps import activate
-__all__ = ['create_app', 'activate']
-__version__ = '2021.04.23'
+
+__all__ = ['create_app', 'activate', '__version__']
diff --git a/zipapps/__main__.py b/zipapps/__main__.py
@@ -2,7 +2,7 @@
 import sys
 
 from . import __version__
-from .main import Config, create_app
+from .main import ZipApp, create_app
 
 USAGE = r'''
 ===========================================================================
@@ -56,9 +56,9 @@ def main():
     parser.add_argument('--version', action='version', version=__version__)
     parser.add_argument('--output',
                         '-o',
-                        default=Config.DEFAULT_OUTPUT_PATH,
+                        default=ZipApp.DEFAULT_OUTPUT_PATH,
                         help='The path of the output file, defaults to'
-                        f' "{Config.DEFAULT_OUTPUT_PATH}".')
+                        f' "{ZipApp.DEFAULT_OUTPUT_PATH}".')
     parser.add_argument(
         '--python',
         '-p',
@@ -104,7 +104,6 @@ def main():
     parser.add_argument(
         '-cc',
         '--pyc',
-        '--compile',
         '--compiled',
         action='store_true',
         dest='compiled',
@@ -144,11 +143,7 @@ def main():
         default='',
         dest='build_id',
         help='a string to skip duplicate builds,'
-        ' it can be the paths of files/folders which splited by ",", '
-        'then the modify time will be used as build_id. If build_id contains `*`,'
-        ' will use `glob` function to get paths. '
-        'For example, you can set requirements.txt as your build_id by'
-        ' `python3 -m zipapps -b requirements.txt -r requirements.txt` when you use pyz as venv.'
+        ' it can be the paths of files/folders which splited by ",", then the modify time will be used as build_id. If build_id contains `*`, will use `glob` function to get paths. For example, you can set requirements.txt as your build_id by `python3 -m zipapps -b requirements.txt -r requirements.txt` when you use pyz as venv.'
     )
     parser.add_argument(
         '--zipapps',
@@ -184,9 +179,20 @@ def main():
                         dest='sys_paths',
                         help='Paths be insert to sys.path[-1] while running.'
                         ' Support TEMP/HOME/SELF prefix, separated by commas.')
+    parser.add_argument(
+        '--activate',
+        default='',
+        dest='activate',
+        help='Activate the given paths of zipapps app, '
+        'only activate them but not run them, separated by commas.')
     if len(sys.argv) == 1:
         return parser.print_help()
     args, pip_args = parser.parse_known_args()
+    if args.activate:
+        from .activate_zipapps import activate
+        for path in args.activate.split(','):
+            activate(path)
+        return
     return create_app(
         includes=args.includes,
         cache_path=args.cache_path,
diff --git a/zipapps/main.py b/zipapps/main.py
