Mercurial > hgrepos > Python > libs > ConfigMix

changeset 319:5427ca342c1e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change the formatting the changelog: remove the dependency on the changelog package. Now the changelog is a bit denser formatted (in the source as in the generated artefacts).
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 05 May 2021 23:12:01 +0200
parents e35bd534b7de
children 98490375d90c
files CHANGES.txt docs/conf.py requirements_docs.txt
diffstat 3 files changed, 163 insertions(+), 242 deletions(-) [+]
line wrap: on
line diff
--- a/CHANGES.txt	Wed May 05 22:46:00 2021 +0200
+++ b/CHANGES.txt	Wed May 05 23:12:01 2021 +0200
@@ -12,284 +12,212 @@
 Pre-1.0 Series
 --------------
 
-.. changelog::
-   :version: none
-   :released: not yet
-
-   .. change::
-      :tags: breaking, misc
-
-      Moved some important public constants from :py:mod:`configmix`
-      into the :py:mod:`configmix.constants` module.
-
-   .. change::
-      :tags: feature
+n/a (n/a)
+~~~~~~~~~
 
-      Configuration tree references are implemented in the ``ref``
-      namespace
-
-   .. change::
-      :tags: feature
-
-      Implemented new access methods
-      :py:meth:`configmix.config.Configuration.getvarl` and
-      :py:meth:`configmix.config.Configuration.getvarl_s`
-
-.. changelog::
-   :version: 0.13
-   :released: 2021-04-21
-
-   .. change::
-      :tags: feature
+- **[breaking] [misc]**
+  Moved some important public constants from :py:mod:`configmix` into
+  the :py:mod:`configmix.constants` module.
 
-      All YAML load functions got a new optional keyword `strict` to detect
-      and prevent duplicate keys within a single YAML document.
-
-      The top-level load function also understands this flag and provides it
-      to low-level-loaders that understand it.
-
-.. changelog::
-   :version: 0.12
-   :released: 2020-12-07
-
-   .. change::
-      :tags: feature
-
-      Provide an ``AWS`` namespace to retrieve some AWS instance metadata.
+- **[feature]**
+  Configuration tree references are implemented in the ``ref``
+  namespace
 
-.. changelog::
-   :version: 0.11
-   :released: 2020-10-05
-
-   .. change::
-      :tags: feature
+- **[feature]** 
+  Implemented new access methods
+  :py:meth:`configmix.config.Configuration.getvarl` and
+  :py:meth:`configmix.config.Configuration.getvarl_s`
 
-      Allow the deletion of key-value pairs while merging configurations.
-
-      This is done by recognizing and handling the special
-      configuration value ``{{::DEL::}}``.
-
-.. changelog::
-   :version: 0.10
-   :released: 2020-09-10
+      
+0.13 (2021-04-21)
+~~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: feature
-
-      Allow loading configuration files from directories when using
-      the "<dir>" prefix in filenames.
-
-      Unknown filetypes within these directories are ignored
-      automatically.
-
-   .. change::
-      :tags: feature
+- **[feature]**
+  All YAML load functions got a new optional keyword `strict` to
+  detect and prevent duplicate keys within a single YAML document.
 
-      Implemented a function to delete an association:
-      :py:func:`configmix.del_assoc`.
-
-.. changelog::
-   :version: 0.9
-   :released: 2020-07-28
+  The top-level load function also understands this flag and provides
+  it to low-level-loaders that understand it.
 
-   .. change::
-      :tags: breaking, feature
-
-      Do not set "root", "self" and "here" variables any more. The old
-      behaviour hindered proper automatic configuration on some PyPy
-      configurations when using `genapplib`.
-
-      Only the INI-parser did set this variables automatically.
+  
+0.12 (2020-12-07)
+~~~~~~~~~~~~~~~~~
 
-.. changelog::
-   :version: 0.8.1
-   :released: 2020-07-08
-
-   .. change::
-      :tags: bugfix
-
-      Allow non-string keys when merging configurations.
-
-.. changelog::
-   :version: 0.8
-   :released: 2020-07-08
-
-   .. change::
-      :tags: breaking, feature
+- **[feature]**
+  Provide an ``AWS`` namespace to retrieve some AWS instance metadata.
 
-      Do not implicitely convert a configuration value to text if the
-      value is the result of just a variable expansion.
-
-.. changelog::
-   :version: 0.7.4
-   :released: 2020-05-21
+  
+0.11 (2020-10-05)
+~~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: feature
-
-      Implemented new namespace function ``OS:node`` to return the node's
-      computername.
+- **[feature]**
+  Allow the deletion of key-value pairs while merging configurations.
 
-   .. change::
-      :tags: bugfix
-
-      The ``OS`` namespace lookup did not handle non-existing variables
-      properly and ignored the `default` parameter.
+  This is done by recognizing and handling the special configuration
+  value ``{{::DEL::}}``.
 
 
-.. changelog::
-   :version: 0.7.3
-   :released: 2020-05-13
+0.10 (2020-09-10)
+~~~~~~~~~~~~~~~~~
+
+- **[feature]**
+  Allow loading configuration files from directories when using the
+  "<dir>" prefix in filenames.
+
+  Unknown filetypes within these directories are ignored
+  automatically.
+
+- **[feature]**
+  Implemented a function to delete an association:
+  :py:func:`configmix.del_assoc`.
+
+
+0.9 (2020-07-28)
+~~~~~~~~~~~~~~~~
+
+- **[breaking] [feature]**
+  Do not set "root", "self" and "here" variables any more. The old
+  behaviour hindered proper automatic configuration on some PyPy
+  configurations when using `genapplib`.
+
+  Only the INI-parser did set this variables automatically.
+
+
+0.8.1 (2020-07-08)
+~~~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags:
+- **[bugfix]**
+  Allow non-string keys when merging configurations.
+
+  
+0.8 (2020-07-08)
+~~~~~~~~~~~~~~~~
+
+- **[breaking] [feature]**
+  Do not implicitely convert a configuration value to text if the
+  value is the result of just a variable expansion.
+
 
-      No code changes.
+0.7.4 (2020-05-21)
+~~~~~~~~~~~~~~~~~~
+
+- **[feature]**
+  Implemented new namespace function ``OS:node`` to return the node's
+  computername.
+
+- **[bugfix]**
+  The ``OS`` namespace lookup did not handle non-existing variables
+  properly and ignored the `default` parameter.
+
+
+0.7.3 (2020-05-13)
+~~~~~~~~~~~~~~~~~~
+
+- No code changes.
 
 
-.. changelog::
-   :version: 0.7.2
-   :released: 2019-05-13
+0.7.2 (2019-05-13)
+~~~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: feature
-
-      Implemented a loader with key ``-*-ignore-*-`` effectively
-      ignores the contents of given file. No file extensions are by
-      default associated with this loader.
+- **[feature]**
+  Implemented a loader with key ``-*-ignore-*-`` effectively ignores
+  the contents of given file. No file extensions are by default
+  associated with this loader.
 
 
-.. changelog::
-   :version: 0.7.1
-   :released: 2019-05-10
-
-   .. change::
-      :tags: feature
+0.7.1 (2019-05-10)
+~~~~~~~~~~~~~~~~~~
 
-      :py:func:`configmix.load` and :py:func:`configmix.safe_load` got a
-      new keyword argument `extras` that (if given) will be used as the
-      *last*  configuration dictionary to be merged into the configuration.
+- **[feature]**
+  :py:func:`configmix.load` and :py:func:`configmix.safe_load` got a
+  new keyword argument `extras` that (if given) will be used as the
+  *last* configuration dictionary to be merged into the configuration.
 
-      This can be used to overwrite configuration file settings from
-      commandline arguments.
+  This can be used to overwrite configuration file settings from
+  commandline arguments.
 
-   .. change::
-      :tags: bugfix
-
-      :py:func:`configmix.safe_load` did some preliminary unsafe merges
-      from `defaults` and an extra additional unneeded merge.
+- **[bugfix]**
+  :py:func:`configmix.safe_load` did some preliminary unsafe merges
+  from `defaults` and an extra additional unneeded merge.
 
 
-.. changelog::
-   :version: 0.7
-   :released: 2019-05-06
+0.7 (2019-05-06)
+~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: breaking
-
-      Additional or alternative loaders can be installed by changing
-      the :py:data:`configmix.mode_loaders` dictionary directly.
+- **[breaking]**
+  Additional or alternative loaders can be installed by changing the
+  :py:data:`configmix.mode_loaders` dictionary directly.
 
-   .. change::
-      :tags: breaking
+- **[breaking]**
+  The public functions to associate filename extensions to filemodes
+  have been renamed to :py:func:`configmix.set_assoc`,
+  :py:func:`configmix.get_assoc`, :py:func:`configmix.clear_assoc`,
+  :py:func:`configmix.get_default_assoc`.
 
-      The public functions to associate filename extensions to filemodes
-      have been renamed to :py:func:`configmix.set_assoc`,
-      :py:func:`configmix.get_assoc`,
-      :py:func:`configmix.clear_assoc`,
-      :py:func:`configmix.get_default_assoc`.
-
-      The filemodes must be keys in the :py:data:`configmix.mode_loaders`
-      dictionary.
+  The filemodes must be keys in the :py:data:`configmix.mode_loaders`
+  dictionary.
 
-   .. change::
-      :tags: breaking, feature
+- **[breaking] [feature]**
+  The associations from filename extensions to parsers are
+  :py:mod:`fnmatch` style patterns now.
 
-      The associations from filename extensions to parsers are
-      :py:mod:`fnmatch` style patterns now.
-
-      Calling :py:func:`configmix.set_assoc` by default prepends to
-      the currently defined associations and therefore gets the
-      highest priority. Appending is possible also.
+  Calling :py:func:`configmix.set_assoc` by default prepends to the
+  currently defined associations and therefore gets the highest
+  priority. Appending is possible also.
 
-   .. change::
-      :tags: feature
+- **[feature]**
+  :py:func:`configmix.load` and :py:func:`configmix.safe_load` got a
+  keyword argument `defaults` that allow the provision of an already
+  existing default configuration into which all additional
+  configuration settings are merged into.
 
-      :py:func:`configmix.load` and :py:func:`configmix.safe_load` got
-      a keyword argument `defaults` that allow the provision of an
-      already existing default configuration into which all additional
-      configuration settings are merged into.
-
-   .. change::
-      :tags: feature
-
-      Added support for TOML style configuration files. This needs
-      the external package :py:mod:`toml` (from https://github.com/uiri/toml).
+- **[feature]**
+  Added support for TOML style configuration files. This needs the
+  external package :py:mod:`toml` (from https://github.com/uiri/toml).
 
 
-.. changelog::
-   :version: 0.6
-   :released: 2019-03-14
+0.6 (2019-03-14)
+~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: breaking, feature
-
-      Reimplemented :py:func:`configmix.safe_merge` to do a deepcopy of all
-      source configurations when merging. Previously is was sort of a
-      shallow copy.
+- **[breaking] [feature]**
+  Reimplemented :py:func:`configmix.safe_merge` to do a deepcopy of
+  all source configurations when merging. Previously is was sort of a
+  shallow copy.
 
-   .. change::
-      :tags: breaking, feature
-
-      The default file encoding when reading INI style files with
-      :py:func:`configmix.ini.load` is now "UTF-8". Previously it was
-      undefined and therefore dependent on the user's locale.
+- **[breaking] [feature]**
+  The default file encoding when reading INI style files with
+  :py:func:`configmix.ini.load` is now "UTF-8". Previously it was
+  undefined and therefore dependent on the user's locale.
 
-      An `encoding` keyword argument can be specified explicitely now.
+  An `encoding` keyword argument can be specified explicitely now.
 
-   .. change::
-      :tags: breaking, feature
-
-      Support comment-like key-value pairs with configuration keys starting
-      with ``__doc`` or ``__comment``.
+- **[breaking] [feature]**
+  Support comment-like key-value pairs with configuration keys
+  starting with ``__doc`` or ``__comment``.
 
-   .. change::
-      :tags: misc
-
-      Use the filesystem encoding where appripriate.
+- **[misc]**
+  Use the filesystem encoding where appripriate.
 
-   .. change::
-      :tags: doc
-
-      Begin the documentation with `Sphinx <http://www.sphinx-doc.org>`_
+- **[doc]**
+  Begin the documentation with `Sphinx <http://www.sphinx-doc.org>`_
 
-   .. change::
-      :tags: test
-
-      Begin formal unittests
+- **[test]**
+  Begin formal unittests
 
-   .. change::
-      :tags: feature
-
-      Build a tree of configuration settings from INI files
-
-   .. change::
-      :tags: feature
+- **[feature]**
+  Build a tree of configuration settings from INI files
 
-      Support JSON formatted files as configuration files also (suffix ".json").
+- **[feature]**
+  Support JSON formatted files as configuration files also (suffix
+  ".json").
 
-   .. change::
-      :tags: feature
-
-      Allow custom configuration filename extensions and custom loaders that
-      can handle custom configuration file syntax styles.
+- **[feature]**  
+  Allow custom configuration filename extensions and custom loaders
+  that can handle custom configuration file syntax styles.
 
 
-.. changelog::
-   :version: 0.5
-   :released: 2016-04-19
+0.5 (2016-04-19)
+~~~~~~~~~~~~~~~~
 
-   .. change::
-      :tags: feature
-
-      First really used release.
+- **[feature]]**
+  First really used release.
--- a/docs/conf.py	Wed May 05 22:46:00 2021 +0200
+++ b/docs/conf.py	Wed May 05 23:12:01 2021 +0200
@@ -51,7 +51,6 @@
     'sphinx.ext.todo',
     'sphinx.ext.ifconfig',
 #   'sphinx.ext.viewcode',
-    'changelog',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -209,12 +208,6 @@
 autoclass_content = 'both'
 
 
-# -- Options for changelog ---------------------------------------------------
-
-changelog_inner_tag_sort = ['breaking', 'feature', 'bugfix', 'misc',
-                            'test', 'doc']
-
-
 def setup(app):
     #
     # Custom release_date variable with a custom substitution |release_date|
--- a/requirements_docs.txt	Wed May 05 22:46:00 2021 +0200
+++ b/requirements_docs.txt	Wed May 05 23:12:01 2021 +0200
@@ -1,4 +1,4 @@
 -r requirements_tests.txt
 docutils>=0.14
 Sphinx>=1.7
-changelog>=0.4
+