argparse-from-file 1.0__tar.gz → 1.2__tar.gz

{argparse_from_file-1.0/argparse_from_file.egg-info → argparse_from_file-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: argparse-from-file
-Version: 1.0
+Version: 1.2
 Summary: Wrapper for Python's argparse to also read arguments from a file
 Author-email: Mark Blakeney <mark.blakeney@bullet-systems.net>
 License-Expression: GPL-3.0-or-later
@@ -86,7 +86,7 @@ Example `~/.config/myprog-flags.conf`:
 
 `argparse-from-file` automatically adds an `epilog` to the help message
 indicating the configuration file path. If you instead provide a custom `epilog`
-(or `usage` or `description`), you can embed the `#FROM_FILE_PATH#` placeholder,
+(or `usage` or `description`), you can embed a `#FROM_FILE_PATH#` placeholder,
 and it will be replaced with the actual path used.
 
 ## Example

{argparse_from_file-1.0 → argparse_from_file-1.2}/README.md

@@ -73,7 +73,7 @@ Example `~/.config/myprog-flags.conf`:
 
 `argparse-from-file` automatically adds an `epilog` to the help message
 indicating the configuration file path. If you instead provide a custom `epilog`
-(or `usage` or `description`), you can embed the `#FROM_FILE_PATH#` placeholder,
+(or `usage` or `description`), you can embed a `#FROM_FILE_PATH#` placeholder,
 and it will be replaced with the actual path used.
 
 ## Example

{argparse_from_file-1.0 → argparse_from_file-1.2/argparse_from_file.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: argparse-from-file
-Version: 1.0
+Version: 1.2
 Summary: Wrapper for Python's argparse to also read arguments from a file
 Author-email: Mark Blakeney <mark.blakeney@bullet-systems.net>
 License-Expression: GPL-3.0-or-later
@@ -86,7 +86,7 @@ Example `~/.config/myprog-flags.conf`:
 
 `argparse-from-file` automatically adds an `epilog` to the help message
 indicating the configuration file path. If you instead provide a custom `epilog`
-(or `usage` or `description`), you can embed the `#FROM_FILE_PATH#` placeholder,
+(or `usage` or `description`), you can embed a `#FROM_FILE_PATH#` placeholder,
 and it will be replaced with the actual path used.
 
 ## Example

argparse_from_file-1.2/argparse_from_file.py

@@ -0,0 +1,96 @@
+"""
+A very light wrapper around Python's argparse module to prepend a program's
+argument list with default options and arguments read from a user configuration
+file.
+"""
+
+import argparse
+import os
+import shlex
+import sys
+
+import platformdirs
+
+PLACEHOLDER = '#FROM_FILE_PATH#'
+
+
+# Get program name. This function is copied (but very modified) from argparse 3.14.0
+def _prog_name():
+    try:
+        modspec = sys.modules['__main__'].__spec__
+    except (KeyError, AttributeError):
+        # possibly PYTHONSTARTUP or -X presite or other weird edge case
+        # no good answer here, so fall back to the default
+        modspec = None
+
+    if not modspec or modspec.name == '__main__':
+        return os.path.basename(sys.argv[0])
+
+    return modspec.name.removesuffix('.__main__')
+
+
+class ArgumentParser(argparse.ArgumentParser):
+    _top = True
+
+    def __init__(self, *args, **kwargs):
+        self._argv = []
+
+        # Only set up "from file" stuff once, for the top-level
+        if ArgumentParser._top:
+            ArgumentParser._top = False
+
+            # from_file = 'path-to/file': Use this as "from file" name/path. If
+            #   relative then wrt platform specific user config dir.
+            # from_file = '': Do not use a "from file".
+            # from_file = None: Create default "from file" path.
+            if (from_file := kwargs.pop('from_file', None)) is None:
+                from_file = _prog_name() + '-flags.conf'
+
+            if from_file:
+                from_file_path = platformdirs.user_config_path(from_file)
+                from_file_path_str = str(from_file_path)
+                # epilog = 'text string': Set this as epilog, replacing any
+                #   PLACEHOLDER with the above determined "from file" path.
+                # epilog = '': Do not set an epilog.
+                # epilog = None: create default epilog with "from file" path.
+                if (epilog := kwargs.pop('epilog', None)) is None:
+                    epilog = f'Note you can set default starting options in {from_file_path_str}.'
+                else:
+                    epilog = epilog.replace(PLACEHOLDER, from_file_path_str)
+
+                if epilog:
+                    kwargs['epilog'] = epilog
+
+                # Also replace PLACEHOLDER in usage and description.
+                for kw in 'usage', 'description':
+                    if v := kwargs.get(kw):
+                        kwargs[kw] = v.replace(PLACEHOLDER, from_file_path_str)
+
+                # Create list of default args from user file.
+                if from_file_path.is_file():
+                    with from_file_path.open() as fp:
+                        self._argv.extend(
+                            ln
+                            for line in fp
+                            if (ln := line.strip()) and not ln.startswith('#')
+                        )
+            else:
+                from_file_path = None
+
+            self.from_file_path = from_file_path
+
+        return super().__init__(*args, **kwargs)
+
+    def parse_args(self, args=None, namespace=None):  # type: ignore[override]
+        if args is None and self._argv:
+            # Combine args from file and command line, to be parsed
+            argstr = ' '.join(self._argv).strip()
+            args = shlex.split(argstr) + sys.argv[1:]
+            self._argv.clear()
+
+        return super().parse_args(args, namespace)
+
+
+def __getattr__(name: str):
+    "Proxy all other attributes from argparse module."
+    return getattr(argparse, name)

{argparse_from_file-1.0 → argparse_from_file-1.2}/pyproject.toml

@@ -37,5 +37,4 @@ version_scheme = "post-release"
 quote-style = "single"
 skip-magic-trailing-comma = true
 
-
 # vim:se sw=2:

argparse_from_file-1.0/argparse_from_file.py

@@ -1,72 +0,0 @@
-"""
-A very light wrapper around Python's argparse module to prepend a program's
-argument list with default options and arguments read from a user configuration
-file.
-"""
-
-import argparse
-import shlex
-import sys
-from pathlib import Path
-
-import platformdirs
-
-
-class ArgumentParser(argparse.ArgumentParser):
-    def __init__(self, *args, **kwargs):
-        self._argv = []
-
-        # from_file = 'path-to/file': Use this as "from file" name/path. If
-        #   relative then wrt platform specific user config dir.
-        # from_file = '': Do not use a "from file".
-        # from_file = None: Create default "from file" path.
-        if (from_file := kwargs.pop('from_file', None)) is None:
-            from_file = Path(sys.argv[0]).stem + '-flags.conf'
-
-        if from_file:
-            from_file_path = platformdirs.user_config_path(from_file)
-            from_file_path_str = str(from_file_path)
-            # epilog = 'text string': Set this as epilog, replacing any
-            #   '#FROM_FILE_PATH#' with the above determined "from file" path.
-            # epilog = '': Do not set an epilog.
-            # epilog = None: create default epilog with "from file" path.
-            if (epilog := kwargs.pop('epilog', None)) is None:
-                epilog = f'Note you can set default starting options in {from_file_path_str}.'
-            else:
-                epilog = epilog.replace('#FROM_FILE_PATH#', from_file_path_str)
-
-            if epilog:
-                kwargs['epilog'] = epilog
-
-            # Also replace any '#FROM_FILE_PATH#' in usage and description.
-            for kw in 'usage', 'description':
-                if v := kwargs.get(kw):
-                    kwargs[kw] = v.replace('#FROM_FILE_PATH#', from_file_path_str)
-
-            # Create list of default args from user file.
-            if from_file_path.is_file():
-                with from_file_path.open() as fp:
-                    self._argv.extend(
-                        ln
-                        for line in fp
-                        if (ln := line.strip()) and not ln.startswith('#')
-                    )
-        else:
-            from_file_path = None
-
-        self.from_file_path = from_file_path
-        return super().__init__(*args, **kwargs)
-
-    def parse_args(self, args=None, namespace=None):  # type: ignore[override]
-        if args is None and self._argv:
-            # Combine args from file and command line, to be parsed
-            argstr = ' '.join(self._argv).strip()
-            args = shlex.split(argstr) + sys.argv[1:]
-
-        del self._argv
-        return super().parse_args(args, namespace)
-
-
-def __getattr__(name: str):
-    "Proxy all other attributes from argparse module."
-    return getattr(argparse, name)