Merge pull request ywangd#2 from ywangd/dev

Flush commits from ywangd to fork

Author: Ong Yong Xin

CHANGES.md

@@ -7,6 +7,10 @@
     * colored error messages
     * history is now per command 
     * `pip` now supports extras
+    * `pip` will now show error messages for known incompatible packages
+    * `wget` will now show an progress bar
+    * support for unicode symbols im prompt
+    * various bugfixes and minor improvements
 
 ### Version 0.7.0 - 2018-05-04
 * New Features

bin/pip.py

@@ -15,7 +15,7 @@ def main(args):
 
     ns = ap.parse_args(args)
 
-    filename = os.path.join(os.environ['STASH_ROOT'], '.stash_tips')
+    filename = os.path.join(os.environ['STASH_ROOT'], 'data', 'stash_tips.json')
     if not os.path.exists(filename):
         return 1
 

bin/totd.py

@@ -0,0 +1,24 @@
+{
+"reasons": {
+    "C": "This package uses C-Code, which can not be compiled by StaSh.",
+    "unknown": "Reason unknown.",
+    "is_stash": "The name of the package conflicts with StaSh.",
+    "is_pip": "StaSh uses a custom version of PIP. Installing the 'pip' package would likely break StaSh.",
+    "lowlevel_os": "This package uses (relatively) low-level OS functions, which can not be used with Pythonista.",
+    "processes": "This package requires process interaction, which is not possible on iOS",
+    "bundled": "This package is already bundled with Pythonista",
+    "incompatible_dependency": "This package has one or more dependencies which are incompatible with Pythonista."
+},
+"blacklist": {
+    "stash": ["is_stash", true, null],
+    "pip": ["is_pip", true, null],
+    "selenium": ["processes", true, null],
+    "matplotlib": ["bundled", false, null],
+    "mypy": ["C", true, null],
+    "eventlet": ["C", true, null],
+    "scipy": ["C", true, null],
+    "tensorflow": ["C", true, null],
+    "pyobjc": ["C", true, null],
+    "pyttsx3": ["incompatible_dependency", true, null]
+}
+}

data/pip_blacklist.json

@@ -0,0 +1,45 @@
+#PIP blacklist
+-----------------------
+Starting with version 0.7.5, StaSh pip includes a blacklist.
+
+
+It indicates whether a package should not be installed and what reasons
+should be given.
+
+
+## Motivation
+
+The reason for this blacklist is the high number of issues regarding
+installation problems of known incompatible packages. I hope that by
+slowly adding packages to the blacklist we can reduce the amount of
+these issues.
+
+
+The blacklist was initially discussed in issue #376.
+
+
+## Details
+This blacklist is stored as a JSON file at `$STASH_ROOT/data/pip_blacklist.json`.
+It is a dict with two top-level keys:
+
+
+**`reasons`** Is a dict mapping a reasonID (str) to a message (str).
+It is used to reduce redundancy of error messages.
+
+
+**`blacklist`** Is a dict mapping packagename (str) to details (list).
+Every package mentioned in a key of the dict is considered blacklisted.
+
+The first (`i=0`) element of the list is the reasonID (str). Use the `reasons` toplevel
+key to determine the actual reason.
+
+The second (`i=1`) element of the list is a bool indicating whether this
+blacklisting is fatal. If true, it is considered fatal. This means that
+`pip` should abort the installation. Otherwise it is considered nonfatal.
+This means that `pip` should skip the installation, but continue the install.
+This is useful if the package can not be installed, but Pythonista already
+bundles the module.
+
+The third (`i=2`) is either `null`/`None` or a string. If it is a string
+and the package is marked non-fatal, use this string as the packagename instead.
+In this case, requested extras and version specifier are discarded.

.stash_tips renamed to data/stash_tips.json

@@ -328,6 +328,10 @@ def parse_requirement(requirement):
         splitted = specs_s.split(",")
         specs = []
         for vs in splitted:
+            if vs == "":
+                # for some weird reasons, sometimes a trailing ',' is
+                # included in the requirement list.
+                continue
             cmp_end = re.search(version_cmp, vs).end()
             c, v = vs[:cmp_end], vs[cmp_end:]
             specs.append((c, v))

docs/pip_blacklist.md

@@ -0,0 +1,46 @@
+"""
+Tests for the 'totd' command.
+"""
+from stash.tests.stashtest import StashTestCase
+
+
+class TotdTests(StashTestCase):
+    """
+    Tests for the 'totd' command.
+    """
+    
+    def test_help(self):
+        """
+        Test 'totd --help'.
+        """
+        output = self.run_command("totd --help", exitcode=0)
+        self.assertIn("totd", output)
+        self.assertIn("-h", output)
+        self.assertIn("--help", output)
+        self.assertIn("-n", output)
+        self.assertIn("--count", output)
+    
+    def test_count(self):
+        """
+        Test 'totd --count'.
+        """
+        output = self.run_command("totd --count", exitcode=0).replace("\n", "")
+        # ensure that the string is correct
+        self.assertTrue(output.startswith("Total available tips: "))
+        # ensure that number of tips is not zero
+        self.assertFalse(output.endswith(" "))
+    
+    def test_simple(self):
+        """
+        Test a simple 'totd' execution.
+        Ensure that different totds are returned.
+        """
+        known = []
+        n_unique = 0
+        for i in range(100):
+            output = self.run_command("totd", exitcode=0).replace("\n", "")
+            if output not in known:
+                known.append(output)
+                n_unique += 1
+        self.assertGreater(n_unique, 3)
+            

lib/libversion.py

@@ -286,3 +286,21 @@ def test_uninstall(self):
         except ImportError as e:
             # expected failure
             pass
+    
+    def test_blacklist_fatal(self):
+        """test 'pip install <blacklisted-fatal-package>'."""
+        output = self.run_command("pip --verbose install pip", exitcode=1)
+        self.assertIn("StaSh uses a custom version of PIP", output)
+        self.assertIn("PackageBlacklisted", output)
+        self.assertNotIn("Package installed: pip", output)
+    
+    def test_blacklist_nonfatal(self):
+        """test 'pip install <blacklisted-nonfatal-package>'."""
+        output = self.run_command("pip --verbose install matplotlib", exitcode=0)
+        self.assertIn("Warning: package 'matplotlib' is blacklisted, but marked as non-fatal.", output)
+        self.assertIn("This package is already bundled with Pythonista", output)
+        self.assertNotIn("PackageBlacklisted", output)
+        self.assertNotIn("Package installed: matplotlib", output)
+    
+    # TODO: add test for blacklist with alternative.
+