All notable changes to this project will be documented in this file. Versions
follow Semantic Versioning
(<major>.<minor>.<patch>). Backward incompatible (breaking) changes will
only be introduced in major versions with advance notice in the Deprecated
section of releases.
savenow supports saving to an fsspec path #86.
- Multifile save not working correctly for subclasses #63.
link_argumentsnot working for subcommands #82.
- Multiple subcommand settings without explicit subcommand is now a warning instead of exception.
- Support for parsing
MappingandMutableMappingtypes. - Support for parsing
frozenset,MutableSequenceandMutableSettypes.
- Don't discard
init_argswith non-changing--*.class_pathargument. - Don't ignore
KeyErrorin call to instantiate_classes #81. - Optional subcommands fail with a KeyError #68.
- Conflicting namespace for subclass key in subcommand.
instantiate_classesnot working for subcommand keys #70.- Proper file not found message from _ActionConfigLoad #64.
parse_pathnot parsing inner config files.
- Docstrings no longer supported for python 3.5.
- Show warning when
--*.class_pathdiscards previousinit_args. - Trigger error when
parse_argscalled with non-string value. - ActionParser accepts both title and help, title having preference.
- Multiple subcommand settings allowed if explicit subcommand given.
datetime.timedeltanow supported as a type.- New function
class_from_functionto add signature of functions that return an instantiated class.
--*.init_args.*causing crash when overriding value from config file.
- Signature functions not working for classes implemented with
__new__. instantiate_classesfailing when keys not present in config object.
lazy_instancefunction for serializable class type defaults.- Support for parsing multiple matched default config files #58.
--*.class_pathand--*.init_args.*arguments not being parsed.--helpbroken when default_config_files fail to parse #60.- Pattern in default_config_files not using sort.
- Decorator for final classes and an is_final_class function to test it.
- Support for final classes as type hint.
add_subclass_argumentsnow supports multiple classes given as tuple.add_subclass_argumentsnow supports the instantiate parameter.
- Parsing of relative paths inside inner configs for type hint actions.
- Method
instantiate_classesthat instantiates subclasses and class groups. - Support for
link_argumentsthat are applied on instantiation. - Method
add_subclass_argumentsnow supports skipping of arguments. - Added support for Type in type hints #59.
- Custom string template to avoid problems with percent symbols in docstrings.
- Type hint Any not correctly serializing Enum and registered type values.
- Inner config file support for subclass type hints in signatures and CLI #57.
- Forward fail_untyped setting to nested subclass type hints.
- With fail_untyped=True use type from default value instead of Any.
- Registered types and typing types incorrectly considered subclass types.
- Better structure of type hint error messages to ease understanding.
--print_configcan now be given before other arguments without value.- Fixed conversion of flat namespace to dict when there is a nested empty namespace.
- Fixed issue with get_defaults with default config file and parse_as_dict=False.
- Fixed bug in save which failed when there was an int key.
--print_confignow only receives a value with=syntax.add_{class,method,function,dataclass}_argumentsnow return a list of added arguments.
- Path support for fsspec file systems using the 's' mode flag.
- set_config_read_mode function that can enable fsspec for config reading.
- Option for print_config and dump with help as yaml comments.
- print_config only added to parsers when ActionConfigFile is added.
- set_url_support functionality now should be done with set_config_read_mode.
- Link argument arrow
<=can be confused as less or equal, changed to<--.
- add_dataclass_arguments not making parameters without default as required #54.
- Removed from signature add methods required option included by mistake.
- CLI now has
--configoptions at subcommand and subsubcommand levels. - CLI now adds subcommands with help string taken from docstrings.
- print_config at subcommand level for global config with implicit subcommands.
- New Path_drw predefined type.
- Type hint arguments now support
nargs='?'. - Signature methods can now skip arguments within init_args of subclasses.
- Removed skip_check from ActionPathList which was never implemented.
- ActionPath should no longer be used, instead paths are given as type.
- Actions not being applied for subsubcommand values.
- handle_subcommands not correctly inferring subsubcommand.
- fail_untyped now adds untyped parameters as type Any and if no default then default set to None.
--*.helpoption being added for non-subclass types.- Iterable and Sequence types not working for python>=3.7 #53.
- set_defaults method now works for arguments within subcommands.
- CLI set_defaults option to allow overriding of defaults.
- CLI return_parser option to ease inclusion in documentation.
- save_path_content attribute to save paths content on config save.
- New
link_argumentsmethod to derive an argument value from others. - print_config now includes subclass init_args if class_path given.
- Subclass type hints now also have a
--*.helpoption.
- Signature parameters whose name starts with "_" are skipped.
- The repr of Path now has the form
Path_{mode}(.
- CLI now does instantiate_subclasses before running.
- New method add_dataclass_arguments.
- Dataclasses are now supported as a type.
- New predefined type Path_dc.
- Experimental Callable type support.
- Signature methods with nested key can be made required.
- Support for Literal types.
- New option in signatures methods to not fail for untyped required.
- Generation of yaml now uses internally pyyaml's safe_dump.
- New cleaner implementation for type hints support.
- Moved deprecated code to a module specific for this.
- Path types repr now has format Path(rel[, cwd=dir]).
- instantiate_subclasses now always returns a dict.
- ActionEnum should no longer be used, instead enums are given as type.
- Deserialization of types not being done for nested config files.
- Help fails saying required args missing if default config file exists #48.
- ActionYesNo arguments failing when parsing from environment variable #49.
- Path class now supports home prefix '~' #45.
- yaml/json dump kwargs can now be changed via attributes dump_yaml_kwargs and dump_json_kwargs.
- Now by default dump/save/print_config preserve the add arguments and argument groups order (only CPython>=3.6) #46.
- ActionParser group title now defaults to None if not given #47.
- Add argument with type Enum or type hint giving an action now raises error #45.
- Parser help now also considers default_config_files and shows which config file was loaded #47.
- get_default method now also considers default_config_files.
- get_defaults now raises ParserError if default config file not valid.
- default_config_files property not removing help group when setting None.
- ActionParser now moves all actions to the parent parser.
- The help of ActionParser arguments is now shown in the main help #41.
- Use of required in ActionParser parsers not working #43.
- Nested options with names including dashes not working #42.
- DefaultHelpFormatter not properly using env_prefix to show var names.
- Function to register additional types for use in parsers.
- Type hint support for complex and UUID classes.
- PositiveInt and NonNegativeInt now gives error instead of silently truncating when given float.
- Types created with restricted_number_type and restricted_string_type now share a common TypeCore base class.
- ActionOperators not give error if type already registered.
- List[Tuple] types not working correctly.
- Some nested dicts kept as Namespace by dump.
- Parsing of relative paths in default_config_files not working.
- Description of tuple type in the readme.
- Tuples with ellipsis are now supported #40.
- Using dict as type incorrectly considered as class requiring class_path.
- Nested tuples were not working correctly #40.
- CLI crashed for class method when zero args given after subcommand.
- Options before subcommand provided in config file gave subcommand not given.
- Arguments in groups without help not showing required, type and default.
- Required arguments help incorrectly showed null default value.
- Various improvements and fixes to the readme.
- Save with multifile=True now creates original jsonnet file for ActionJsonnet.
- default_config_files is now a property of parser objects.
- Table in readme to ease understanding of extras requires for optional features #38.
- Save with multifile=True uses file extension to choose json or yaml format.
- Better exception message when using ActionJsonSchema and jsonschema not installed #38.
- Changed actions so that keyword arguments are visible in API.
- Fixed save method short description which was copy paste of dump.
- Added missing docstring in instantiate_subclasses method.
- Fixed crash when using
--helpand ActionConfigFile not given help string. - Standardized capitalization and punctuation of: help, config, version.
- instantiate_subclasses work properly when init_args not present.
- Addressed a couple of issues pointed out by sonarcloud.
- New add_subclass_arguments method to add as type with a specific help option.
- Automatic Optional for arguments with default None #30.
- CLI now supports running methods from classes.
- Signature arguments can now be loaded from independent config files #32.
- add_argument now supports enable_path for type based on jsonschema.
- print_config can now be given as value skip_null to exclude null entries.
- Improved description of parser used as standalone and for ActionParser #34.
- Removed
__cwd__and top level__path__that were not needed.
- ActionYesNo argument in help the type is now bool.
- Correctly skip self in add_method_arguments for inherited methods.
- Prevent failure of dump in cleanup_actions due to new _ActionConfigLoad.
- Prevent failure in save_paths for dict with int keys.
- Avoid duplicate config check failure message with subcommands.
- Support for multiple levels of subcommands #29.
- Default description of subcommands explaining use of
--help.
- add_class_arguments incorrectly added arguments from
__call__instead of__init__for callable classes.
- Functions to add arguments from classes, methods and functions.
- CLI function that allows creating a line command line interface with a single line of code inspired by Fire.
- Typing module that includes predefined types and type generator functions for paths and restricted numbers/strings.
- Extended support to add_argument type to allow complex type hints.
- Parsers now include
--print_configoption to dump defaults. - Support argcomplete for tab completion of arguments.
- ArgumentParsers by default now use as error_handler the usage_and_exit_error_handler.
- error_handler and formatter_class no longer accept as value a string.
- Changed SimpleNamespace to Namespace to avoid unnecessary differences with argparse.
- ActionOperators should no longer be used, the new alternative is restricted number types.
The change log was introduced in v3.0.0. For details of the changes for previous versions take a look at the git log. It more or less reads like a change log.