stdlib/getopt.codon

stdlib/getopt.codon

@@ -1,3 +1,48 @@
+# (c) 2022 Exaloop Inc. All rights reserved.
+# Parts of this file: (c) 2022 Python Software Foundation. All right reserved.
+# License:
+#    1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
+#    the Individual or Organization ("Licensee") accessing and otherwise using Python
+#    3.10.2 software in source or binary form and its associated documentation.
+#
+#    2. Subject to the terms and conditions of this License Agreement, PSF hereby
+#    grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+#    analyze, test, perform and/or display publicly, prepare derivative works,
+#    distribute, and otherwise use Python 3.10.2 alone or in any derivative
+#    version, provided, however, that PSF's License Agreement and PSF's notice of
+#    copyright, i.e., "Copyright © 2001-2022 Python Software Foundation; All Rights
+#    Reserved" are retained in Python 3.10.2 alone or in any derivative version
+#    prepared by Licensee.
+#
+#    3. In the event Licensee prepares a derivative work that is based on or
+#    incorporates Python 3.10.2 or any part thereof, and wants to make the
+#    derivative work available to others as provided herein, then Licensee hereby
+#    agrees to include in any such work a brief summary of the changes made to Python
+#    3.10.2.
+#
+#    4. PSF is making Python 3.10.2 available to Licensee on an "AS IS" basis.
+#    PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
+#    EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
+#    WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
+#    USE OF PYTHON 3.10.2 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.
+#
+#    5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 3.10.2
+#    FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
+#    MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 3.10.2, OR ANY DERIVATIVE
+#    THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+#
+#    6. This License Agreement will automatically terminate upon a material breach of
+#    its terms and conditions.
+#
+#    7. Nothing in this License Agreement shall be deemed to create any relationship
+#    of agency, partnership, or joint venture between PSF and Licensee.  This License
+#    Agreement does not grant permission to use PSF trademarks or trade name in a
+#    trademark sense to endorse or promote products or services of Licensee, or any
+#    third party.
+#
+#    8. By copying, installing or otherwise using Python 3.10.2, Licensee agrees
+#    to be bound by the terms and conditions of this License Agreement.
+
 """
 Parser for command line options.
 
@@ -23,47 +68,49 @@ import os
 class GetoptError:
     _hdr: ExcHeader
 
-    def __init__(self):
-        self._hdr = ('GetoptError', '', '', '', 0, 0)
+    def __init__(self) -> void:
+        self._hdr = ("GetoptError", "", "", "", 0, 0)
 
-    def __init__(self, message: str):
-        self._hdr = ('GetoptError', message, '', '', 0, 0)
+    def __init__(self, message: str) -> void:
+        self._hdr = ("GetoptError", message, "", "", 0, 0)
 
     @property
-    def message(self):
+    def message(self) -> str:
         return self._hdr.msg
 
 
 # Return:
 #   has_arg?
 #   full option name
-def long_has_args(opt: str, longopts: List[str]):
+def long_has_args(opt: str, longopts: List[str]) -> Tuple[bool, str]:
     possibilities = [o for o in longopts if o.startswith(opt)]
     if not possibilities:
-        raise GetoptError(f'option --{opt} not recognized')
+        raise GetoptError(f"option --{opt} not recognized")
     # Is there an exact match?
     if opt in possibilities:
         return False, opt
-    elif opt + '=' in possibilities:
+    elif opt + "=" in possibilities:
         return True, opt
     # No exact match, so better be unique.
     if len(possibilities) > 1:
         # XXX since possibilities contains all valid continuations, might be
         # nice to work them into the error msg
-        raise GetoptError(f'option --{opt} not a unique prefix')
+        raise GetoptError(f"option --{opt} not a unique prefix")
     assert len(possibilities) == 1
     unique_match = possibilities[0]
-    has_arg = unique_match.endswith('=')
+    has_arg = unique_match.endswith("=")
     if has_arg:
         unique_match = unique_match[:-1]
     return has_arg, unique_match
 
 
-def do_longs(opts: List[Tuple[str, str]], opt: str, longopts: List[str], args: List[str]):
+def do_longs(
+    opts: List[Tuple[str, str]], opt: str, longopts: List[str], args: List[str]
+) -> Tuple[List[Tuple[str, str]], List[str]]:
     optarg = ""
     try:
-        i = opt.index('=')
-        opt, optarg = opt[:i], opt[i+1:]
+        i = opt.index("=")
+        opt, optarg = opt[:i], opt[i + 1 :]
     except ValueError:
         pass
 
@@ -71,40 +118,40 @@ def do_longs(opts: List[Tuple[str, str]], opt: str, longopts: List[str], args: L
     if has_arg:
         if optarg == "":
             if not args:
-                raise GetoptError(f'option --{opt} requires argument')
+                raise GetoptError(f"option --{opt} requires argument")
             optarg, args = args[0], args[1:]
     elif optarg != "":
-        raise GetoptError(f'option --{opt} must not have an argument')
-    opts.append(('--' + opt, optarg))
+        raise GetoptError(f"option --{opt} must not have an argument")
+    opts.append(("--" + opt, optarg))
     return opts, args
 
 
-def short_has_arg(opt: str, shortopts: str):
+def short_has_arg(opt: str, shortopts: str) -> bool:
     for i in range(len(shortopts)):
-        if opt == shortopts[i] != ':':
-            return shortopts.startswith(':', i+1)
-    raise GetoptError(f'option -{opt} not recognized')
+        if opt == shortopts[i] != ":":
+            return shortopts.startswith(":", i + 1)
+    raise GetoptError(f"option -{opt} not recognized")
 
 
-def do_shorts(opts: List[Tuple[str, str]], optstring: str, shortopts: str, args: List[str]):
-    while optstring != '':
+def do_shorts(
+    opts: List[Tuple[str, str]], optstring: str, shortopts: str, args: List[str]
+) -> Tuple[List[Tuple[str, str]], List[str]]:
+    while optstring != "":
         opt, optstring = optstring[0], optstring[1:]
-        optarg = ''
+        optarg = ""
         if short_has_arg(opt, shortopts):
-            if optstring == '':
+            if optstring == "":
                 if not args:
-                    raise GetoptError(f'option -{opt} requires argument')
+                    raise GetoptError(f"option -{opt} requires argument")
                 optstring, args = args[0], args[1:]
-            optarg, optstring = optstring, ''
-        opts.append(('-' + opt, optarg))
+            optarg, optstring = optstring, ""
+        opts.append(("-" + opt, optarg))
     return opts, args
 
 
 def getopt(
-    args: List[str],
-    shortopts: str,
-    longopts: List[str] = []
-):
+    args: List[str], shortopts: str, longopts: List[str] = []
+) -> Tuple[List[Tuple[str, str]], List[str]]:
     """
     Parses command line options and parameter list.  args is the
     argument list to be parsed, without the leading reference to the
@@ -144,20 +191,20 @@ def getopt(
 
     # Allow options after non-option arguments?
     all_options_first = False
-    if shortopts.startswith('+'):
+    if shortopts.startswith("+"):
         shortopts = shortopts[1:]
         all_options_first = True
     elif "POSIXLY_CORRECT" in os.environ:
         all_options_first = True
 
     while args:
-        if args[0] == '--':
+        if args[0] == "--":
             prog_args += args[1:]
             break
 
-        if args[0][:2] == '--':
+        if args[0][:2] == "--":
             opts, args = do_longs(opts, args[0][2:], longopts, args[1:])
-        elif args[0][:1] == '-' and args[0] != '-':
+        elif args[0][:1] == "-" and args[0] != "-":
             opts, args = do_shorts(opts, args[0][1:], shortopts, args[1:])
         else:
             if all_options_first: