NEWS.md

In trevorld/r-argparse: Command Line Optional and Positional Argument Parser

argparse 2.2.3

• Character values are now passed as "raw" strings to Python (#51).

• In particular this avoids triggering an error in Python 3.12 when creating a string with escapes not supported by Python e.g. default = "\\D" will continue to return a default value of "\\D" instead of triggering an error.

• However, this also means that any Python accepted escape sequences will no longer be interpreted as an escape sequence. If relying on such behaviour you may need to instead use the appropriate R escape sequences or Unicode values instead of Python escape sequences:

  • E.g. default = "\\t" will now return a default value of "\\t" (a t preceded by an (escaped) backslash) instead of "\t" (a horizontal tab).
  • https://docs.python.org/3/reference/lexical_analysis.html#escape-sequences
  • https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)

• Thanks Matthew Hall (@mdhall272) for bug report.

argparse 2.2.2

• Fixes bug when add_argument() help values ended in a " (#46). Thanks Oliver Dreschel (@oliverdreschel) for bug report.

argparse 2.2.1

• We now support the following ArgumentParser() methods:

• format_help()

• format_usage()
• parse_intermixed_args() (#45)
• parse_known_intermixed_args() (#45)

• set_defaults() (#43). Suggestion of @oliverbothe.

• When an error is thrown by ArgumentParser()$parse_args() and interactive() is FALSE and getOption("error") is NULL then we now use a quieter default error handler that doesn't output a trailing "Execution halted".

• add_argument() now allows "numeric" as an alias for "double" for the type argument (#42). Suggestion of @dariober.

• ArgumentParser() now handles description arguments with newlines in them (#44). Thanks Arthur Gilly (@agilly) for bug report.

argparse 2.1.6

• The errors raised by ArgumentParser()$parse_args() are now of class "argparse_parse_error".

They are now less verbose when interactive() is FALSE (#40).

There may still be a trailing "Execution halted" line output by R's default error handler (when interactive() is FALSE). This can be silenced by setting a new error handler near the top of your Rscript e.g.

r if (!interactive()) options(error=function(e) quit('no', status = 1, runLast = FALSE))

argparse 2.1.5

• add_argument now uses as.logical() logic to cast variables to logical values if type = "logical" and action = "store" or action = "append" instead of using Python's bool() logic (#39).

• We throw an error if we would get an NA by coercion.

• We no longer throw a warning when using type = "logical" and action = "store" suggesting users instead use action = "store_true" or action = "store_false".

argparse 2.1.3

• Prevents extraneous error message from being included in usage message when using Python 3.10 (#36). Thanks @dariober for bug report.

argparse 2.1.2

• Fixes bug when using an argument with action == "append" and a non-NULL default value (#35). Thanks @miker985 for bug report.

argparse 2.1.1

• Parsers now support parse_known_args() (#34). Suggestion of David Lacalle Castillo (@WaterKnight1998).

argparse 2.0.4

• May now specify a named formatter_class argument (as a string) to a subparsers$add_parser() method. Thanks Regina (@oyxf) for bug report.
• May now specify positional arguments in ArgumentParser().

argparse 2.0.3

• Fixes bug when accidentally passing a positional argument to ArgumentParser() when using Python 3.9. Thanks Kurt Hornik for bug report.

argparse 2.0.1

• Improved passing of arguments to Python from R. In particular should fix bug in using add_help argument in ArgumentParser. Thanks George Chlipala for bug report.
• Removes getopt as a dependency.

argparse 2.0.0

• Now uses R6 classes instead of proto classes (#25). The typical user shouldn't need to change any argparse code but I did make private the previously public python_code element of the object returned by ArgumentParser().
• Parsers now support add_subparsers (#14). Suggestion of Zebulun Arendsee.
• Parsers now support add_argument_group (#26). Suggestion of Dario Beraldi.
• Parsers now support add_mutually_exclusive_group (#23). Suggestion of Vince Reuter.

argparse 1.1.1

• Better support for machines only running Python 2.7.
• DESCRIPTION makes explicit that it requires version 1.0.0 of proto dependency. Thanks Christophe Poulet for bug report.

argparse 1.1.0

• Better support for Unicode arguments/options. Thanks Erick Rocha Fonseca for bug report.
• Fix bug when setting type='integer' in add_argument. Thanks Dominik Mueller for bug report and suggested solution.
• The package proto has been moved from Depends to Imports in DESCRIPTION. We now use jsonlite package instead of rjson to parse JSON.
• Better error message when accidentally trying to define a positional argument in ArgumentParser() Suggestion of Alex Reinhart.
• Other error message output when an parsing error is detected have been tweaked slightly.

argparse 1.0.7

• Now supports showing program's version with action='version'. Suggestion of Dario Beraldi.
• Fix bug when setting required=FALSE in add_argument. Thanks Claire D. McWhite for bug report.

argparse 1.0.4

• You can now pass in a character vector to the metavar argument of add_argument. Thanks Paul Newell for bug report and a patch.
• add_argument now throws a warning recommending using action "store_true" or "store_false" if type set to "logical" and action set to "store". Suggestion of Martí Duran Ferrer
• You can now explicitly set a NULL default in add_argument. Previously one could only implicitly set a NULL default by not setting any default at all. Suggestion of Hyunsoo Kim.
• Fixes parsing bug when using a very large argument list. Thanks Taylor Pospisil for bug report.
• Parse error usage message now prints to standard error. User requested help message quit status is now zero. Thanks to PlasmaBinturong for report/request.
• If Python script fails with error pass on error message to user. Thanks to Martí Duran Ferrer for report/request.

argparse 1.0.1

• Fix minor bug when running package tests on machines with both old and new versions of Python. Thanks Prof. Brian Ripley for bug report.

argparse 1.0.0

• Some support for choices argument in parser$add_argument. Thanks Christopher Small for report/request.
• Some support for formatter_class argument in ArgumentParser. Thanks Costas Bouyioukos for report/request.
• Package now looks for Python binaries with findpython::find_python_cmd which is a little bit more robust than the previous argparse::find_python_cmd.
• If interactive() == TRUE then parse_args will no longer quit(status=1) after printing a help message but will instead throw an error. argparse will continue to quit(status=1) after printing a help message for non-interactive Rscripts.

argparse 0.5.3

• Fix bug in parser$add_argument for case when we specify a default vector instead of scalar. Thanks Martin Diehl for bug report.
• find_python_cmd will now also look for a python2.7 binary.
• Website moved to https://github.com/trevorld/argparse

trevorld/r-argparse documentation built on April 13, 2024, 8:50 p.m.