Upgrading argparse from 2.x to 3.x

Comparison of the public API of argparse 2.0.1 and 3.0.2, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	1
Changed signatures	18
Removed class or interface members	1
Changed class or interface members	45
Newly deprecated	0
Requirement changes (engines, peer dependencies)	0
New exports	24

Removed exports

import	export	kind	Before
`argparse`	`SubParser`	class	`class`

Changed signatures

export	Before	After
`argparse · Action`	`class`	`interface`
`argparse · PARSER`	`string`	`"A..."`
`argparse · OPTIONAL`	`string`	`"?"`
`argparse · SUPPRESS`	`string`	`"==SUPPRESS=="`
`argparse · Namespace`	`class`	`interface`
`argparse · REMAINDER`	`string`	`"..."`
`argparse · ONE_OR_MORE`	`string`	`"+"`
`argparse · ZERO_OR_MORE`	`string`	`"*"`
`argparse · ArgumentError`	`class`	`interface`
`argparse · ArgumentGroup`	`class`	`interface`
`argparse · HelpFormatter`	`class`	`interface`
`argparse · ArgumentParser`	`class`	`interface`
`argparse · ArgumentTypeError`	`class`	`interface`
`argparse · RawTextHelpFormatter`	`class`	`interface`
`argparse · BooleanOptionalAction`	`class`	`interface`
`argparse · ActionConstructorOptions`	`number & { _: "ActionConstructorOptions"; }`	`interface`
`argparse · RawDescriptionHelpFormatter`	`class`	`interface`
`argparse · ArgumentDefaultsHelpFormatter`	`class`	`interface`

Removed class or interface members

member	import	Before
`ArgumentGroup.add_argument_group`	`argparse`	`(options?: ArgumentGroupOptions \| undefined): ArgumentGroup`

Changed class or interface members

member	Before	After
`Action.call`	`(parser: ArgumentParser, namespace: Namespace, values: string \| string[], optionString: string \| null): void`	`(parser: ArgumentParser, namespace: Namespace, values: unknown, option_string?: string \| undefined): void`
`Action.constructor`	`(options: ActionConstructorOptions): Action`
`Namespace.constructor`	`(options: object): Namespace`
`ArgumentError.constructor`	`(argument: Action, message: string): ArgumentError`
`ArgumentGroup.constructor`	`(): ArgumentGroup`
`ArgumentGroup.get_default`	`(dest: string): any`	`(dest: string): unknown`
`ArgumentGroup.add_argument`	`(arg: string, options?: ArgumentOptions \| undefined): void \| (arg1: string, arg2: string, options?: ArgumentOptions \| undefined): void`	`(name: string, ...names: string[]): Action \| (name: string, ...namesAndOptions: [...string[], ArgumentOptions]): Action`
`ArgumentGroup.set_defaults`	`(options?: {} \| undefined): void`	`(options: object): void`
`ArgumentGroup.add_mutually_exclusive_group`	`(options?: { required: boolean; } \| undefined): ArgumentGroup`	`(options?: MutuallyExclusiveGroupOptions \| undefined): MutuallyExclusiveGroup`
`HelpFormatter.constructor`	`(): HelpFormatter`
`ArgumentParser.exit`	`(status: number, message: string): void`	`(status?: number \| undefined, message?: string \| undefined): void`
`ArgumentParser.error`	`(err: string \| Error): void`	`(message: string): void`
`ArgumentParser.parse_args`	`(args?: string[] \| undefined, ns?: object \| Namespace \| undefined): any`	`<T extends object = Namespace>(args?: string[] \| undefined, namespace?: T \| undefined): T`
`ArgumentParser.print_help`	`(): void`	`(file?: Writable \| undefined): void`
`ArgumentParser.constructor`	`(options?: ArgumentParserOptions \| undefined): ArgumentParser`
`ArgumentParser.get_default`	`(dest: string): any`	`(dest: string): unknown`
`ArgumentParser.print_usage`	`(): void`	`(file?: Writable \| undefined): void`
`ArgumentParser.add_argument`	`(arg: string, options?: ArgumentOptions \| undefined): void \| (arg1: string, arg2: string, options?: ArgumentOptions \| undefined): void`	`(name: string, ...names: string[]): Action \| (name: string, ...namesAndOptions: [...string[], ArgumentOptions]): Action`
`ArgumentParser.set_defaults`	`(options?: {} \| undefined): void`	`(options: object): void`
`ArgumentParser.add_subparsers`	`(options?: SubparserOptions \| undefined): SubParser`	`(options?: SubparserOptions \| undefined): SubparsersAction`
`ArgumentParser.parse_known_args`	`(args?: string[] \| undefined, ns?: object \| Namespace \| undefined): any[]`	`<T extends object = Namespace>(args?: string[] \| undefined, namespace?: T \| undefined): [T, string[]]`
`ArgumentParser.add_argument_group`	`(options?: ArgumentGroupOptions \| undefined): ArgumentGroup`	`(options?: ArgumentGroupOptions \| undefined): ArgumentGroup \| (title?: string \| undefined, description?: string \| undefined): ArgumentGroup`
`ArgumentParser.parse_intermixed_args`	`(args?: string[] \| undefined, ns?: object \| Namespace \| undefined): any`	`<T extends object = Namespace>(args?: string[] \| undefined, namespace?: T \| undefined): T`
`ArgumentParser.convert_arg_line_to_args`	`(argLine: string): string[]`	`(arg_line: string): string[]`
`ArgumentParser.parse_known_intermixed_args`	`(args?: string[] \| undefined, ns?: object \| Namespace \| undefined): any[]`	`<T extends object = Namespace>(args?: string[] \| undefined, namespace?: T \| undefined): [T, string[]]`
`ArgumentParser.add_mutually_exclusive_group`	`(options?: { required: boolean; } \| undefined): ArgumentGroup`	`(options?: MutuallyExclusiveGroupOptions \| undefined): MutuallyExclusiveGroup`
`ArgumentOptions.type`	`string \| Function \| undefined`	`ArgumentType \| undefined`
`ArgumentOptions.const`	`any`	`unknown`
`ArgumentOptions.nargs`	`string \| number \| undefined`	`Nargs \| undefined`
`ArgumentOptions.action`	`string \| (new (options: ActionConstructorOptions) => Action) \| undefined`	`string \| ActionClass \| undefined`
`ArgumentOptions.choices`	`string \| string[] \| undefined`	`string \| object \| readonly unknown[] \| undefined`
`ArgumentOptions.default`	`any`	`unknown`
`SubparserOptions.action`	`string \| undefined`	`string \| ActionClass \| undefined`
`SubparserOptions.parser_class`	`(new () => any) \| undefined`	`ArgumentParserClass \| undefined`
`ArgumentTypeError.constructor`	`(message: string): ArgumentTypeError`
`ArgumentGroupOptions.argument_default`	`any`	`unknown`
`RawTextHelpFormatter.constructor`	`(): RawTextHelpFormatter`
`ArgumentParserOptions.formatter_class`	`(new () => HelpFormatter \| ArgumentDefaultsHelpFormatter \| RawDescriptionHelpFormatter \| RawTextHelpFormatter) \| undefined`	`HelpFormatterFactory \| undefined`
`ArgumentParserOptions.argument_default`	`any`	`unknown`
`BooleanOptionalAction.call`	`(parser: ArgumentParser, namespace: Namespace, values: string \| string[], optionString: string \| null): void`	`(parser: ArgumentParser, namespace: Namespace, values: unknown, option_string?: string \| undefined): void`
`BooleanOptionalAction.constructor`	`(options: ActionConstructorOptions): BooleanOptionalAction`
`SubArgumentParserOptions.formatter_class`	`(new () => HelpFormatter \| ArgumentDefaultsHelpFormatter \| RawDescriptionHelpFormatter \| RawTextHelpFormatter) \| undefined`	`HelpFormatterFactory \| undefined`
`SubArgumentParserOptions.argument_default`	`any`	`unknown`
`RawDescriptionHelpFormatter.constructor`	`(): RawDescriptionHelpFormatter`
`ArgumentDefaultsHelpFormatter.constructor`	`(): ArgumentDefaultsHelpFormatter`

Newly deprecated

None detected.

Requirement changes (engines, peer dependencies)

None detected.

New exports (24)

import	export	kind
`argparse`	`Nargs`	type
`argparse`	`FileType`	interface
`argparse`	`Writable`	interface
`argparse`	`ActionClass`	interface
`argparse`	`ArgumentType`	type
`argparse`	`FileTypeResult`	interface
`argparse`	`FileTypeOptions`	interface
`argparse`	`ActionsContainer`	interface
`argparse`	`SubparsersAction`	interface
`argparse`	`ActionConstructor`	interface
`argparse`	`HelpFormatterClass`	interface
`argparse`	`ArgumentParserClass`	interface
`argparse`	`FileTypeConstructor`	interface
`argparse`	`HelpFormatterFactory`	type
`argparse`	`HelpFormatterOptions`	interface
`argparse`	`NamespaceConstructor`	interface
`argparse`	`MutuallyExclusiveGroup`	interface
`argparse`	`ArgumentErrorConstructor`	interface
`argparse`	`HelpFormatterConstructor`	interface
`argparse`	`MetavarTypeHelpFormatter`	interface
`argparse`	`ArgumentParserConstructor`	interface
`argparse`	`ArgumentTypeErrorConstructor`	interface
`argparse`	`MutuallyExclusiveGroupOptions`	interface
`argparse`	`BooleanOptionalActionConstructor`	interface

Frequently asked questions

What are the breaking changes when upgrading argparse from 2 to 3?

Between argparse 2.0.1 and 3.0.2, Vigia found 1 removed exports, 18 changed signatures and 46 removed or changed class or interface members.

What became deprecated in argparse 3?

0 exports or members are newly marked as deprecated in argparse 3.0.2.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/argparse/upgrade?from=2.0.1&to=3.0.2