pydoc > getopt

man perldoc info pydoc3 ri search

📛 NAME

getopt - Parser for command line options.

🚀 Quick Reference

Use Case	Command	Description
Parse short options	opts, args = getopt.getopt(sys.argv[1:], 'ho:v')	Parse -h, -o val, -v
Parse long options	opts, args = getopt.getopt(sys.argv[1:], '', ['help', 'output='])	Parse --help, --output=file
GNU‑style intermixed	opts, args = getopt.gnu_getopt(sys.argv[1:], 'ho:', ['help', 'output='])	Options and non‑options can be mixed
Handle errors	try: ... except getopt.GetoptError as e: print(e)	Catch invalid options

🌐 MODULE REFERENCE

https://docs.python.org/3.10/library/getopt.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

📖 DESCRIPTION

This module helps scripts to parse the command line arguments in sys.argv. It supports the same conventions as the Unix getopt() function (including the special meanings of arguments of the form '-' and '--'). Long options similar to those supported by GNU software may be used as well via an optional third argument. This module provides two functions and an exception:

• getopt() — Parse command line options
• gnu_getopt() — Like getopt(), but allow option and non‑option arguments to be intermixed.
• GetoptError — exception (class) raised with 'opt' attribute, which is the option involved with the exception.

🧬 CLASSES

Exception hierarchy: builtins.Exception(builtins.BaseException) → GetoptError

🐍 GetoptError

class GetoptError(builtins.Exception)

Exception raised when an unrecognized option is found or when a required argument is missing.

• __init__(self, msg, opt='') — Initialize self. msg describes the error, opt is the problematic option string.
• __str__(self) — Return str(self).

Data descriptors:

• msg — error message (default '')
• opt — option involved (default '')

Method resolution order: GetoptError → builtins.Exception → builtins.BaseException → builtins.object

🔄 error alias

error = GetoptError — convenience alias for backward compatibility.

⚙️ FUNCTIONS

getopt()

getopt(args, shortopts, longopts=[]) → (opts, args)

Parses command line options and parameter list. args is the argument list to be parsed, without the leading reference to the running program. Typically, this means sys.argv[1:]. shortopts is the string of option letters that the script wants to recognize, with options that require an argument followed by a colon (i.e., the same format that Unix getopt() uses). If specified, longopts is a list of strings with the names of the long options which should be supported. The leading '--' characters should not be included in the option name. Options which require an argument should be followed by an equal sign ('=').

The return value consists of two elements: the first is a list of (option, value) pairs; the second is the list of program arguments left after the option list was stripped (this is a trailing slice of the first argument). Each option‑and‑value pair returned has the option as its first element, prefixed with a hyphen (e.g., '-x'), and the option argument as its second element, or an empty string if the option has no argument. The options occur in the list in the same order in which they were found, thus allowing multiple occurrences. Long and short options may be mixed.

gnu_getopt()

gnu_getopt(args, shortopts, longopts=[]) → (opts, args)

This function works like getopt(), except that GNU style scanning mode is used by default. This means that option and non‑option arguments may be intermixed. The getopt() function stops processing options as soon as a non‑option argument is encountered.

If the first character of the option string is '+', or if the environment variable POSIXLY_CORRECT is set, then option processing stops as soon as a non‑option argument is encountered.

📦 DATA

__all__ = ['GetoptError', 'error', 'getopt', 'gnu_getopt']

📁 FILE

/usr/lib/python3.10/getopt.py

📛 NAME 🚀 Quick Reference 🌐 MODULE REFERENCE 📖 DESCRIPTION 🧬 CLASSES ⚙️ FUNCTIONS 📦 DATA 📁 FILE