Mercurial > hgrepos > Python > libs > ConfigMix
annotate CHANGES.txt @ 223:90dd0d04b926 v0.7.1
+++++ v0.7.1
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Fri, 10 May 2019 09:36:07 +0200 |
| parents | 51a355095838 |
| children | 8b1c52d5e7d5 |
| 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 | 2 |
| 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 | 6 |
| 7 .. _changelog: | |
| 8 | |
| 9 Changelog | |
| 10 ========= | |
| 11 | |
| 12 Pre-1.0 Series | |
| 13 -------------- | |
| 14 | |
| 15 .. changelog:: | |
| 223 | 16 :version: 0.7.1 |
| 17 :released: 2019-05-10 | |
|
216
c03c9162f7e6
Prepare next version (planned: 0.7.1.dev1)
Franz Glasner <fzglas.hg@dom66.de>
parents:
211
diff
changeset
|
18 |
|
217
b869e792310e
FIX: Extra merged and unsafe merges in configmix.safe_load
Franz Glasner <fzglas.hg@dom66.de>
parents:
216
diff
changeset
|
19 .. change:: |
|
221
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
20 :tags: feature |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
21 |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
22 :py:func:`configmix.load` and :py:func:`configmix.safe_load` got a |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
23 new keyword argument `extras` that (if given) will be used as the |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
24 *last* configuration dictionary to be merged into the configuration. |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
25 |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
26 This can be used to overwrite configuration file settings from |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
27 commandline arguments. |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
28 |
|
6f0f39a9a46f
configmix.load() and .safe_load() got a new keyword argument "extras" to be merged in as last configuration dictionary
Franz Glasner <fzglas.hg@dom66.de>
parents:
218
diff
changeset
|
29 .. change:: |
|
217
b869e792310e
FIX: Extra merged and unsafe merges in configmix.safe_load
Franz Glasner <fzglas.hg@dom66.de>
parents:
216
diff
changeset
|
30 :tags: bugfix |
|
b869e792310e
FIX: Extra merged and unsafe merges in configmix.safe_load
Franz Glasner <fzglas.hg@dom66.de>
parents:
216
diff
changeset
|
31 |
|
218
b56586789838
FIX: Docu: Sphinx reference syntax to a Python function
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
217
diff
changeset
|
32 :py:func:`configmix.safe_load` did some preliminary unsafe merges |
|
217
b869e792310e
FIX: Extra merged and unsafe merges in configmix.safe_load
Franz Glasner <fzglas.hg@dom66.de>
parents:
216
diff
changeset
|
33 from `defaults` and an extra additional unneeded merge. |
|
b869e792310e
FIX: Extra merged and unsafe merges in configmix.safe_load
Franz Glasner <fzglas.hg@dom66.de>
parents:
216
diff
changeset
|
34 |
|
216
c03c9162f7e6
Prepare next version (planned: 0.7.1.dev1)
Franz Glasner <fzglas.hg@dom66.de>
parents:
211
diff
changeset
|
35 .. changelog:: |
| 211 | 36 :version: 0.7 |
| 37 :released: 2019-05-06 | |
|
170
c247a5dc35ed
Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
167
diff
changeset
|
38 |
|
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
|
39 .. change:: |
| 182 | 40 :tags: breaking |
| 41 | |
|
192
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
42 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
|
43 the :py:data:`configmix.mode_loaders` dictionary directly. |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
44 |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
45 .. change:: |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
46 :tags: breaking |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
47 |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
48 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
|
49 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
|
50 :py:func:`configmix.get_assoc`, |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
51 :py:func:`configmix.clear_assoc`, |
| 182 | 52 :py:func:`configmix.get_default_assoc`. |
| 53 | |
|
192
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
54 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
|
55 dictionary. |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
56 |
| 182 | 57 .. 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
|
58 :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
|
59 |
|
1ff11462a5c1
The associations from filename extensions to parsers are "fnmatch" style patterns now.
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
170
diff
changeset
|
60 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
|
61 :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
|
62 |
|
192
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
63 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
|
64 the currently defined associations and therefore gets the |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
65 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
|
66 |
|
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
|
67 .. 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
|
68 :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
|
69 |
|
192
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
70 :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
|
71 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
|
72 already existing default configuration into which all additional |
|
46c7d872db83
Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents:
182
diff
changeset
|
73 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
|
74 |
|
195
28e6c1413947
Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents:
192
diff
changeset
|
75 .. change:: |
|
28e6c1413947
Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents:
192
diff
changeset
|
76 :tags: feature |
|
28e6c1413947
Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents:
192
diff
changeset
|
77 |
|
198
0b855758ba08
An additional TOML-related unittest (types)
Franz Glasner <fzglas.hg@dom66.de>
parents:
195
diff
changeset
|
78 Added support for TOML style configuration files. This needs |
|
204
bbc1aa40d781
Doc: use the correct URL for the source of the used toml library: https://github.com/uiri/toml
Franz Glasner <fzglas.hg@dom66.de>
parents:
203
diff
changeset
|
79 the external package :py:mod:`toml` (from https://github.com/uiri/toml). |
|
195
28e6c1413947
Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents:
192
diff
changeset
|
80 |
|
170
c247a5dc35ed
Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
167
diff
changeset
|
81 |
|
c247a5dc35ed
Begin development of a version 0.7 with some API changes
Franz Glasner <f.glasner@feldmann-mg.com>
parents:
167
diff
changeset
|
82 .. changelog:: |
| 91 | 83 :version: 0.6 |
| 167 | 84 :released: 2019-03-14 |
| 91 | 85 |
| 86 .. 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
|
87 :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
|
88 |
| 222 | 89 Reimplemented :py:func:`configmix.safe_merge` to do 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
|
90 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
|
91 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
|
92 |
|
d51a18e5b0e3
Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents:
103
diff
changeset
|
93 .. 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
|
94 :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
|
95 |
|
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
|
96 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
|
97 :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
|
98 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
|
99 |
|
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
|
100 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
|
101 |
|
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
|
102 .. change:: |
|
147
8b7333caba25
Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents:
139
diff
changeset
|
103 :tags: breaking, feature |
|
8b7333caba25
Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents:
139
diff
changeset
|
104 |
|
203
b2a5442867e7
Doc: Wording: "allow" -> "support"
Franz Glasner <fzglas.hg@dom66.de>
parents:
198
diff
changeset
|
105 Support comment-like key-value pairs with configuration keys starting |
|
147
8b7333caba25
Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents:
139
diff
changeset
|
106 with ``__doc`` or ``__comment``. |
|
8b7333caba25
Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents:
139
diff
changeset
|
107 |
|
8b7333caba25
Put the new comment-key feature into CHANGES
Franz Glasner <hg@dom66.de>
parents:
139
diff
changeset
|
108 .. change:: |
|
166
b5ce9a8461bf
Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents:
164
diff
changeset
|
109 :tags: misc |
|
b5ce9a8461bf
Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents:
164
diff
changeset
|
110 |
|
b5ce9a8461bf
Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents:
164
diff
changeset
|
111 Use the filesystem encoding where appripriate. |
|
b5ce9a8461bf
Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents:
164
diff
changeset
|
112 |
|
b5ce9a8461bf
Use the filesystem encoding explicitely where appropriate.
Franz Glasner <fzglas.hg@dom66.de>
parents:
164
diff
changeset
|
113 .. change:: |
| 91 | 114 :tags: doc |
| 115 | |
| 93 | 116 Begin the documentation with `Sphinx <http://www.sphinx-doc.org>`_ |
| 117 | |
| 118 .. change:: | |
| 119 :tags: test | |
| 120 | |
| 121 Begin formal unittests | |
| 91 | 122 |
|
97
1b4d95f60650
Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents:
93
diff
changeset
|
123 .. change:: |
|
1b4d95f60650
Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents:
93
diff
changeset
|
124 :tags: feature |
|
1b4d95f60650
Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents:
93
diff
changeset
|
125 |
|
1b4d95f60650
Build a tree-ish configuration from an INI style configuration file
Franz Glasner <hg@dom66.de>
parents:
93
diff
changeset
|
126 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
|
127 |
|
122
21d92ff8cf31
Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents:
120
diff
changeset
|
128 .. change:: |
|
21d92ff8cf31
Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents:
120
diff
changeset
|
129 :tags: feature |
|
21d92ff8cf31
Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents:
120
diff
changeset
|
130 |
|
203
b2a5442867e7
Doc: Wording: "allow" -> "support"
Franz Glasner <fzglas.hg@dom66.de>
parents:
198
diff
changeset
|
131 Support JSON formatted files as configuration files also (suffix ".json"). |
|
122
21d92ff8cf31
Begin the handling of JSON-style configuration files
Franz Glasner <hg@dom66.de>
parents:
120
diff
changeset
|
132 |
|
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
|
133 .. 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
|
134 :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
|
135 |
|
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
|
136 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
|
137 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
|
138 |
|
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
|
139 |
| 91 | 140 .. changelog:: |
| 141 :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
|
142 :released: 2016-04-19 |
| 91 | 143 |
| 144 .. change:: | |
| 145 :tags: feature | |
| 146 | |
| 147 First really used release. |
