openstack
/
oslo.config
Code Issues Proposed changes
oslo.config/doc/source/index.rst

8.7 KiB
Raw Blame History

oslo.config

An OpenStack library for parsing configuration options from the command line and configuration files.

Contents

cfg opts types configopts cfgfilter helpers fixture parser exceptions namespaces styleguide generator contributing

Release Notes

1.4.0.0a2

Dependency changes:

  • netaddr (0.7.6) is required.
  • stevedore (0.14) is required.

New features/APIs:

  • A new oslo-config-generator utility for generating sample configuration files.
  • A ConfigFilter wrapper class to allow controlling the visibilty of private configuration options.
  • 1284684: Add new cfg.IPOpt type.

Bugfixes:

  • Add CLI option support to config fixture.

Cleanups:

  • Replaced 'e.g.' with 'for example'.
  • Fix confusing logic in _Namespace._get_cli_value().
  • Changes imports order to pass H305, enables check.

Docs:

  • Fix typos some method parameter docs.

Thanks to Christian Berendt, David Stanek, Jakub Libosvar, liu-sheng Mark McLoughlin and Petr Blaho for their contributions to this release.

1.4.0.0a1

Dependency changes:

  • Newer six (1.7.0, previously 1.5.2)
  • Newer hacking (0.9.1, previously 0.8.0)
  • Newer versions of oslo.sphinx 1.2.x are supported.

New features/APIs:

Bug fixes:

  • Add warning about interpolating values from groups
  • 1284969: Reject option names prefixed with '_'
  • 1284969: Avoid using too generic names in _Namespace.
  • 1283960: Fix deprecated_opts for cli options
  • 1329478: Fix an issue with validating max integer values.

Cleanups:

  • 1321274: Log string format arguments changed to function parameters.
  • 1331449: Remove print statement from types.Dict

Python 3:

  • Fix test_version on Python 3.4

Tests:

  • 1279973: Add test case for hyphenated option names.
  • Add more tests for positional CLI opts.
  • Import run_cross_tests.sh from oslo-incubator.
  • Move py33 env before py2x

Docs:

  • Add section titles and fix markup of docstring.
  • Add a doc sample for how to use the required field
  • Fix docstring for _Namespace._get_cli_value

Thanks to Ben Nemec, Christian Berendt, Cyril Roelandt, Davanum Srinivas, David Stanek, Doug Hellmann, Mark McLoughlin, Matthew Treinish, Radomir Dopieralski and YAMAMOTO Takashi for their contributions to this release.

1.3.0

Dependency changes:

  • Newer six (1.5.2, previously unspecified version)
  • Newer hacking (0.8.0, previously 0.5.6)
  • oslotest (unspecified) and mock (1.0) are now required
  • Newer testtools (0.9.34, was 0.9.32), testrepository (0.0.18) and python-subunit (0.0.18)
  • sphinx 1.2 or later is not supported
  • oslo.sphinx has been renamed to oslosphinx

New features/APIs:

  • Support for custom option types.
  • 1262148: Added support of operator '==' to cfg.Opt.
  • Add the ability to validate default options value.

Bugfixes:

  • 1282250: Do substitution on overrides and defaults too.
  • 1255354: Throw exception if --config-dir doesn't exist.
  • 1259729: Fix for parsing error with Dollar Sign ($) in values.
  • 1244674: Fix to make ConfigOpts no longer obscure IOErrors

Python 3:

  • Support building wheels (PEP-427).

Docs:

  • Fix docstring of parsing order.
  • 1277168: Switch over to oslosphinx.
  • Add Style Guide for help of config options

Tests:

  • Convert to oslo.test.

Cleanups:

  • Include the 'meta' trove classifiers for python versions.
  • Follow style guide for help strings.
  • Add py33 trove classifier.
  • Fix a whitespace in a comment.
  • 1229324: Remove extraneous vim configuration comments.
  • 1257295: Fix some misspellings.
  • 1262424: Remove copyright from empty files.
  • Fix spelling errors in docstrings and comments.
  • Utilizes assertIsNone and assertIsNotNone.
  • Replace assertEquals with assertEqual.

Thanks to Alex Gaynor, Andreas Jaeger, Ben Nemec, Davanum Srinivas, Dirk Mueller, Doug Hellmann, Eric Guo, Jay S. Bryant, Jonathan LaCour, Julien Danjou, Lars Butler, Lianhao Lu, llg8212, Maxim Kulkin, Sascha Peilicke, Shane Wang, skudriashev, YAMAMOTO Takashi and Zhongyue Luo for their contributions to this release.

1.2.1

bf70519 Fix subparsers add_parser() regression 3d59667 Expand DeprecatedOpt documentation

Thanks to Ian Wienand and Mark McLoughlin for their contributions to this relase.

1.2.0

  • 1223667: Fix DictOpt to split only the first colon
  • 1228995: Disallow duplicate keys in DictOpt
  • Explicit version removed from setup.cfg
  • Dependency version updates

Thanks to Julien Danjou, Mark McLoughlin and Zhongyue Luo for their contributions to this release.

1.2.0a4

  • Add auto-create support for OptGroup instances (see review 41865)
  • Publish full API docs to docs.openstack.org
  • Finished Python 3 support
  • 1196601: Raise an exception if print_help() is called before __call__
  • Fix DeprecatedOpt equality test
  • Use oslo.sphinx

Thanks to Davanum Srinivas, Doug Hellmann, Flavio Percoco, Julien Danjou, Luis A. Garcia, Mark McLoughlin, Sergey Lukjanov and Zhongyue Luo for their contributions to this release.

1.2.0a3

  • 1176817: Fix the priority of CLI args vs config file values
  • 1123043: New 'choices' param to StrOpt constructor
  • cfg-reload-config-files: Add new ConfigOpts.reload_config_files() method
  • 1194742: Fix regression which meant we weren't registering our namespace package
  • 1185959: Make --help output order alphabetical
  • More progress on python3 support
  • Fix obscure cache clearing race condition
  • Move from tools/pip-requires to requirements.txt
  • Include missing .testr.conf in dist tarball

Thanks to Chuck Short, Davanum Srinivas, Dirk Mueller, Fengqian.Gao, Mark McLoughlin, Monty Taylor, Sergey Lukjanov and Zhongyue Luo for their contributions to this release.

1.2.0a2

  • Fix MultiConfigParser API breakage in 1.2.0a1

1.2.0a1

  • Solid progress has been made adding Python 3 support.
  • cfg-lowercase-groups: uppercase section names in config files are now normalized to lowercase.
  • Support has been added for dictionary style options with the DictOpt class.
  • Multiple deprecated option names per option are now supported via the deprecated_opts argument.
  • The package build process now uses pbr.
  • The package tests are now run using testr.
  • The package coding style checks are now performed using hacking.

Thanks to Chuck Short, Davanum Srinivas, Dirk Mueller, James E. Blair, Mark McLoughlin, Monty Taylor, Steven Deaton and Zhongyue Luo for their contributions to this release.

1.1.1

  • 1160922: Fix set_defaults() to handle multiple arguments
  • 1175096: Fix the title argument to OptGroup

Indices and tables

  • genindex
  • modindex
  • search