[CASSANDRA-17914] Argparse module migration as the Python Optparse is deprecated

• Type: Improvement
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 4.0.11, 4.1.4, 5.0-alpha1, 5.0
• Component/s: CQL/Interpreter
• Change Category: Code Clarity
• Complexity: Normal
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/b4b9f319832a2dfa3c07acfba0b3dbeeb71cb26b

Test and Documentation Plan

Optparse to Argparse test writeup 

 

I copied the old optparse code (cqlshmain.py for trunk and cqlsh.py for 4.0 and 4.1) into a new file called optparse_test_main.py and placed it in the same folder as cqlshmain.py. Then I created a copy of the test file (cqlsh.py) in its same folder called optparse_test.py. I am running each argument individually on both files to see if they get the same output. 

 

	Same
--version	yes
-c	Yes
--no-color	Yes
--browser	Yes
--ssl	Yes
-u	Yes
-p	Yes
-k	Yes
-f	Yes
--debug	Yes
--coverage	Yes
--encoding	Yes
--cqlshrc	Yes
--credentials	Yes
--cqlversion	Yes
--protocol-version	Yes
-e	Yes
--connect-timeout	Yes
--request-timeout	Yes
-t	Yes
-v	Yes
--insecure-password-without-warning	yes

 

• Assignee: Vineet Gali
• Reporter: Brad Schoening

Authors

Vineet Gali

Reviewers

Brandon Williams, Stefan Miklosovic

• Created: 21/Sep/22 19:07
• Updated: 12/Sep/23 13:03
• Resolved: 25/Jul/23 08:48

Description

Deprecated since version 2.7: The optparse module is deprecated and will not be developed further; development will continue with the argparse module.

Argparse is described in PEP 389 – argparse - New Command Line Parsing Module

 

A partial upgrade path from optparse to argparse:

https://docs.python.org/3/library/argparse.html#upgrading-optparse-code

• Replace all optparse.OptionParser.add_option() calls with ArgumentParser.add_argument() calls.

• Replace (options, args) = parser.parse_args() with args = parser.parse_args() and add additional ArgumentParser.add_argument() calls for the positional arguments. Keep in mind that what was previously called options, now in the argparse context is called args.

• Replace optparse.OptionParser.disable_interspersed_args() by using parse_intermixed_args() instead of parse_args().

• Replace callback actions and the callback_* keyword arguments with type or action arguments.

• Replace string names for type keyword arguments with the corresponding type objects (e.g. int, float, complex, etc).

• Replace optparse.Values with Namespace and optparse.OptionError and optparse.OptionValueError with ArgumentError.

• Replace strings with implicit arguments such as %default or %prog with the standard Python syntax to use dictionaries to format strings, that is, %(default)s and %(prog)s.

• Replace the OptionParser constructor version argument with a call to parser.add_argument('--version', action='version', version='<the version>').

Issue Links

• links to: https://github.com/apache/cassandra/pull/2428
• links to: https://github.com/apache/cassandra/pull/2473 4.0
• links to: https://github.com/apache/cassandra/pull/2474 - 4.1