annotate CHANGES.txt @ 195:28e6c1413947

Added support for TOML style configuration files
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 03 May 2019 21:51:09 +0200
parents 46c7d872db83
children 0b855758ba08
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
103
2eac386f825a FIX: Typo in Emacs line: indent-tags-mode -> indent-tabs-mode
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 97
diff changeset
1 .. -*- coding: utf-8; mode: rst; indent-tabs-mode: nil; -*-
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
3 ..
166
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
4 .. Valid tags: breaking, feature, bugfix, misc, test, doc
103
2eac386f825a FIX: Typo in Emacs line: indent-tags-mode -> indent-tabs-mode
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 97
diff changeset
5 ..
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
6
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
7 .. _changelog:
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
8
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
9 Changelog
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
10 =========
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
11
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12 Pre-1.0 Series
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
13 --------------
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
14
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
15 .. changelog::
170
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
16 :version: 0.7.dev1
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
17 :released: unreleased
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
18
171
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
19 .. change::
182
3c0ff52b2bdb Changelog
Franz Glasner <fzglas.hg@dom66.de>
parents: 172
diff changeset
20 :tags: breaking
3c0ff52b2bdb Changelog
Franz Glasner <fzglas.hg@dom66.de>
parents: 172
diff changeset
21
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
22 Additional or alternative loaders can be installed by changing
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
23 the :py:data:`configmix.mode_loaders` dictionary directly.
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
24
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
25 .. change::
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
26 :tags: breaking
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
27
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
28 The public functions to associate filename extensions to filemodes
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
29 have been renamed to :py:func:`configmix.set_assoc`,
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
30 :py:func:`configmix.get_assoc`,
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
31 :py:func:`configmix.clear_assoc`,
182
3c0ff52b2bdb Changelog
Franz Glasner <fzglas.hg@dom66.de>
parents: 172
diff changeset
32 :py:func:`configmix.get_default_assoc`.
3c0ff52b2bdb Changelog
Franz Glasner <fzglas.hg@dom66.de>
parents: 172
diff changeset
33
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
34 The filemodes must be keys in the :py:data:`configmix.mode_loaders`
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
35 dictionary.
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
36
182
3c0ff52b2bdb Changelog
Franz Glasner <fzglas.hg@dom66.de>
parents: 172
diff changeset
37 .. change::
171
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
38 :tags: breaking, feature
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
39
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
40 The associations from filename extensions to parsers are
172
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 171
diff changeset
41 :py:mod:`fnmatch` style patterns now.
171
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
42
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
43 Calling :py:func:`configmix.set_assoc` by default prepends to
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
44 the currently defined associations and therefore gets the
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
45 highest priority. Appending is possible also.
171
1ff11462a5c1 The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 170
diff changeset
46
172
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 171
diff changeset
47 .. change::
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 171
diff changeset
48 :tags: feature
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 171
diff changeset
49
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
50 :py:func:`configmix.load` and :py:func:`configmix.safe_load` got
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
51 a keyword argument `defaults` that allow the provision of an
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
52 already existing default configuration into which all additional
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 182
diff changeset
53 configuration settings are merged into.
172
8138d56d7cd3 ".load" and ".safe_load" get a keyword parameter "defaults" that allows the provision of a configuration dictionary with default settings
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 171
diff changeset
54
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
55 .. change::
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
56 :tags: feature
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
57
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
58 Handle TOML style configuration files also.
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
59
170
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
60
c247a5dc35ed Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 167
diff changeset
61 .. changelog::
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
62 :version: 0.6
167
d8155c429171 +++++ v0.6
Franz Glasner <fzglas.hg@dom66.de>
parents: 166
diff changeset
63 :released: 2019-03-14
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
64
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
65 .. change::
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
66 :tags: breaking, feature
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
67
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
68 Reimplement :py:func:`configmix.safe_merge` do to a deepcopy of all
118
e37fc67ae7f3 Changes: Document that previously "safe_merge()" made sort of shallow copies
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
69 source configurations when merging. Previously is was sort of a
e37fc67ae7f3 Changes: Document that previously "safe_merge()" made sort of shallow copies
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
70 shallow copy.
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
71
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
72 .. change::
120
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
73 :tags: breaking, feature
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
74
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
75 The default file encoding when reading INI style files with
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
76 :py:func:`configmix.ini.load` is now "UTF-8". Previously it was
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
77 undefined and therefore dependent on the user's locale.
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
78
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
79 An `encoding` keyword argument can be specified explicitely now.
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
80
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 118
diff changeset
81 .. change::
147
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
82 :tags: breaking, feature
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
83
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
84 Allow comment-like key-value pairs with configuration keys starting
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
85 with ``__doc`` or ``__comment``.
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
86
8b7333caba25 Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents: 139
diff changeset
87 .. change::
166
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
88 :tags: misc
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
89
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
90 Use the filesystem encoding where appripriate.
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
91
b5ce9a8461bf Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents: 164
diff changeset
92 .. change::
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
93 :tags: doc
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
94
93
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
95 Begin the documentation with `Sphinx <http://www.sphinx-doc.org>`_
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
96
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
97 .. change::
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
98 :tags: test
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
99
84b9578cacce Start with unit tests
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
100 Begin formal unittests
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
101
97
1b4d95f60650 Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
102 .. change::
1b4d95f60650 Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
103 :tags: feature
1b4d95f60650 Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
104
1b4d95f60650 Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
105 Build a tree of configuration settings from INI files
1b4d95f60650 Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
106
122
21d92ff8cf31 Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents: 120
diff changeset
107 .. change::
21d92ff8cf31 Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents: 120
diff changeset
108 :tags: feature
21d92ff8cf31 Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents: 120
diff changeset
109
21d92ff8cf31 Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents: 120
diff changeset
110 Allow JSON formatted files as configuration files also (suffix ".json").
21d92ff8cf31 Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents: 120
diff changeset
111
139
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
112 .. change::
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
113 :tags: feature
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
114
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
115 Allow custom configuration filename extensions and custom loaders that
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
116 can handle custom configuration file syntax styles.
c87b0dc54e1d Allow custom configuration filename extensions and custom loaders that can handle custom configuration file syntax styles
Franz Glasner <hg@dom66.de>
parents: 122
diff changeset
117
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 103
diff changeset
118
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
119 .. changelog::
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
120 :version: 0.5
118
e37fc67ae7f3 Changes: Document that previously "safe_merge()" made sort of shallow copies
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
121 :released: 2016-04-19
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
122
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
123 .. change::
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
124 :tags: feature
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
125
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
126 First really used release.