Fixed tsm script install in executable path

Author: dhondta

docs/pages/helpers.md

@@ -246,9 +246,13 @@ Tinyscript also provides modified/additional `pathlib`-related classes:
     - `choice(*filetypes:str)`: chooses a random file in the current folder among the given extensions (mentioning the dot ; e.g. `.py`)
     - `find(name:str, regex:bool)`: finds a file or folder, using `name` as a regex or not
     - `generate(prefix:str, suffix:str, length:int, alphabet:str)`: generates a random folder name (guaranteed to be non-existent) using the given prefix, suffix, length and alphabet, and returns the joined path
+    - `is_executable()`: checks whether the path is executable
     - `is_hidden()`: checks whether the current file/folder is hidden
+    - `is_in_path_env_var()`: checks whether the path (if not a folder, its `.dirname`) is in the `PATH` environment variable
+    - `is_readable()`: checks whether the path is readable
     - `is_samepath(other_path:str|Path)`: checks whether the given path is the same
     - `is_under(path:str|Path)`: checks whether the path is under the given parent path
+    - `is_writable()`: checks whether the path is writable
     - `iterfiles()`: iterates over files only
     - `iterpubdir()`: iterates over visible directories only
     - `listdir(filter_func:lambda, sort:bool)`: list the current path based on a filter function, sorted or not

pyproject.toml

@@ -37,7 +37,7 @@ classifiers = [
 ]
 dependencies = [
   "argcomplete>=3.0.8",
-  "asciistuff>=1.2.6",
+  "asciistuff>=1.3.0",
   "bitstring==4.0.2",
   "codext>=1.15.0",
   "coloredlogs",

requirements.txt

@@ -1,5 +1,5 @@
 argcomplete>=3.0.8
-asciistuff>=1.2.6
+asciistuff>=1.3.0
 bitstring>3
 codext>=1.15.0
 coloredlogs

src/tinyscript/VERSION.txt

@@ -1 +1 @@
-1.30.6
+1.30.7

src/tinyscript/__main__.py

@@ -25,7 +25,18 @@
 """
 
 
-BIN = Path("~/.bin", expand=True, create=True)
+for _bin in ["~/.bin", "~/.local/bin", "~/.opt/bin"]:
+    BIN = Path(_bin, expand=True, create=True)
+    if BIN.is_in_path_env_var():
+        break
+    BIN = None
+if BIN is None:
+    for p in os.environ['PATH'].split(":"):
+        p = Path(p, expand=True)
+        if p.is_writable():
+            BIN = p
+            break
+
 CACHE = ts.ConfigPath("tinyscript", create=True).joinpath("cache.json")
 DUNDERS = ["__author__", "__email__", "__version__", "__copyright__", "__license__"]
 SOURCES = ts.ConfigPath("tinyscript").joinpath("sources.conf")
@@ -49,21 +60,21 @@ def __download(url, **kw):
             content = b"".join(chunk for chunk in resp.iter_content(chunk_size=4096)).decode()
             return content, _parse_metadata(content)
     except requests.exceptions.Timeout:
-        logger.error("Request for '%s' timed out" % url)
+        logger.error(f"Request for '{url}' timed out")
     except requests.exceptions.TooManyRedirects:
-        logger.error("Too many redirects for '%s'" % url)
+        logger.error(f"Too many redirects for '{url}'")
     except requests.exceptions.RequestException as e:
         resp = e.response
         if resp:
-            logger.error("'%s' cannot be opened (status code: %d - %s)" % (url, resp.status_code, resp.reason))
+            logger.error(f"'{url}' cannot be opened (status code: {resp.status_code} - {resp.reason})")
         else:
             logger.error(str(e))
     return None, {}
 
 
 def _fetch_source(target):
     target = target.strip(" \r\n")
-    logger.info("Fetching source '%s'..." % target)
+    logger.info(f"Fetching source '{target}'...")
     CACHE.touch()
     with CACHE.open() as f:
         try:
@@ -97,7 +108,7 @@ def _get_sources_list(fetch=False):
                 if source == "" or source.startswith("#"):
                     continue
                 if fetch:
-                    logger.info("Fetching source '%s'..." % source)
+                    logger.info(f"Fetching source '{source}'...")
                     __download(source)
                 r.append(source)
     return r
@@ -111,12 +122,12 @@ def _iter_sources(source=None):
             try:
                 yield cache, source, cache[source]
             except KeyError:
-                logger.error("Source '%s' does not exist" % source)
+                logger.error(f"Source '{source}' does not exist")
         else:
             for source, scripts in cache.items():
                 yield cache, source, scripts
     else:
-        logger.warning("No cache available ; please use 'tinyscript update' to get script links from sources")
+        logger.warning("No cache available ; please use 'tsm update' to get script links from sources")
 
 
 def _parse_metadata(content):
@@ -160,17 +171,21 @@ def main():
         s, sources = args.url, _get_sources_list()
         if not args.fetch or args.fetch and _fetch_source(s):
             if s in sources:
-                logger.warning("Source '%s' already exists" % s)
+                logger.warning(f"Source '{s}' already exists")
             else:
                 with SOURCES.open('a') as f:
                     f.write(s)
-                logger.info("Added source '%s'" % s)
+                logger.info(f"Added source '{s}'")
     elif args.command == "install":
-        script = BIN.joinpath(args.name)
+        if BIN is None:
+            script = Path(args.name)
+            logger.warning("Could not find a suitable path from the PATH environment variable to put the script in")
+        else:
+            script = BIN.joinpath(args.name)
         if script.exists() and not args.force:
             meta = _parse_metadata(script.read_text())
             v = meta.get('version')
-            logger.warning(("Script '%s' already exists" % args.name) + [" (version: %s)" % v, ""][v is None])
+            logger.warning((f"Script '{args.name}' already exists") + [f" (version: {v})", ""][v is None])
         else:
             local_v = __version(_parse_metadata(script.read_text()).get('version') if script.exists() else "0.0.0")
             for cache, source, scripts in _iter_sources(args.source):
@@ -185,11 +200,11 @@ def main():
                         script.write_text(content)
                         cache[source][args.name].update(meta)
                         script.chmod(args.mode)
-                        logger.info("Script '%s' %s" % (args.name, status))
+                        logger.info(f"Script '{args.name}' {status}")
                     else:
                         logger.warning("Remote script has a lower version, hence not updated")
+                    _update_cache(cache)
                     break
-            _update_cache(cache)
     elif args.command == "new":
         new_script(args.name, args.target)
     elif args.command == "remove-source":
@@ -199,18 +214,18 @@ def main():
             l = len(sources)
             new = [_ for _ in sources if _.strip(" #\r\n") != s]
             if l == len(new):
-                logger.warning("'%s' not found" % s)
+                logger.warning(f"'{s}' not found")
             else:
                 f.seek(0)
                 f.truncate()
                 f.writelines(new)
-                logger.info("Removed source '%s'" % s)
+                logger.info(f"Removed source '{s}'")
     elif args.command == "search":
         for cache, source, scripts in _iter_sources(args.source):
             for name, data in scripts.items():
                 link = data['link']
                 if re.search(args.pattern, name) or args.extended and re.search(args.pattern, link):
-                    print("%s\n  URL   : %s\n  Source: %s" % (name, link, source))
+                    print(f"{name}\n  URL   : {link}\n  Source: {source}")
                     if args.fetch:
                         _, meta = __download(link, headers={'Range': "bytes=32-1024"})
                         cache[source][name] = {'link': link}
@@ -228,7 +243,7 @@ def main():
                                      ["\n", ""]["email" in dunders]
                             elif k == "email":
                                 if "author" in dunders:
-                                    s += " (%s)\n" % v
+                                    s += f" ({v})\n"
                             else:
                                 func = globals().get(k, lambda s: s)
                                 try:
@@ -247,5 +262,5 @@ def main():
                         continue
                     _fetch_source(l)
         else:
-            logger.warning("'%s' does not exist" % SOURCES)
+            logger.warning(f"'{SOURCES}' does not exist")
 

src/tinyscript/argreparse.py

@@ -288,7 +288,7 @@ def add_mutually_exclusive_group(self, **kwargs):
 class _NewArgumentGroup(_ArgumentGroup, _NewActionsContainer):
     """ Alternative argparse._ArgumentGroup for modifying argument groups handling in the modified ActionsContainer. """
     pass
-        
+
 
 class _NewMutuallyExclusiveGroup(_MutuallyExclusiveGroup, _NewArgumentGroup):
     """ Alternative argparse._MutuallyExclusiveGroup for modifying arguments mutually exclusive groups handling in the

src/tinyscript/helpers/path.py

@@ -210,6 +210,15 @@ def generate(self, prefix="", suffix="", length=8, alphabet="0123456789abcdef"):
                 return new
     rand_folder_name = generate
 
+    def is_executable(self):
+        """ Check if the path can be executed. """
+        return os.access(str(self.expanduser().absolute()), os.X_OK)
+    
+    def is_in_path_env_var(self):
+        """ Check if the current path is in the PATH environment variable. """
+        return (self.dirname if self.is_file() else self).expanduser().absolute() in \
+               [Path(p, expand=True) for p in os.environ['PATH'].split(":")]
+    
     def is_hidden(self):
         """ Check if the current path is hidden. """
         if DARWIN:
@@ -234,6 +243,14 @@ def is_under(self, parentpath):
             p = Path(p.dirname)
         return p in self.absolute().parents
 
+    def is_readable(self):
+        """ Check if the path can be read. """
+        return os.access(str(self.expanduser().absolute()), os.R_OK)
+    
+    def is_writable(self):
+        """ Check if the path can be written. """
+        return os.access(str(self.expanduser().absolute()), os.W_OK)
+    
     def iterfiles(self, filetype=None, filename_only=False, relative=False):
         """ List all files from the current directory. """
         for i in self.iterdir():

tests/test_helpers_path.py

@@ -69,6 +69,10 @@ def test_file_extensions(self):
         self.assertEqual(FILE.generate(), FILE)
         self.assertRaises(TypeError, FILE.append_text, 0)
         self.assertTrue(FILE.is_under(FILE))
+        self.assertIsNotNone(FILE.is_executable())
+        self.assertIsNotNone(FILE.is_readable())
+        self.assertIsNotNone(FILE.is_writable())
+        self.assertIsNotNone(FILE.is_in_path_env_var())
         self.assertTrue(FILE.copy(FILE2).is_file())
         FILE2.remove()
         self.assertFalse(FILE2.copy(FILE).is_file())
@@ -89,6 +93,10 @@ def test_folder_extensions(self):
         self.assertNotEqual(len(list(PATH.find("test"))), 0)
         self.assertNotEqual(len(list(PATH.find("te*"))), 0)
         self.assertEqual(len(list(PATH.find("test2.+", True))), 0)
+        self.assertIsNotNone(PATH.is_executable())
+        self.assertIsNotNone(PATH.is_readable())
+        self.assertIsNotNone(PATH.is_writable())
+        self.assertIsNotNone(PATH.is_in_path_env_var())
 
     def test_config_path(self):
         PATH = ConfigPath("test-app", file=True)