Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/changes.rst @ 303:2a2f5b86fe34

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move some important public constants into the .constants sub-module
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 25 Apr 2021 16:09:00 +0200
parents b84f8060d54c
children 98490375d90c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
1 .. -*- coding: utf-8; mode: rst; -*-
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 =========
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
4 Changes
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
5 =========
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
6
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
7 All major changes over the versions are listed here. For breaking
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
8 changes have a look at :ref:`api-changes`, they are listed there in
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
9 detail.
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 .. include:: ../CHANGES.txt
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12
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 .. _api-changes:
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
15
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
16 Breaking Changes
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
17 ================
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
18
303
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
19 none
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
20 ----
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
21
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
22 - Move some important public constants from :py:mod:`configmix` into
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
23 the :py:mod:`configmix.constants` module.
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
24
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
25 This is technically a breaking change while the author does not
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
26 believe that any of the current clients is affected by this
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
27 change.
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
28
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 261
diff changeset
29
261
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
30 0.9
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
31 ---
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
32
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
33 - Do not set "root", "self" and "here" variables any more. This
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
34 hinders proper automatic configuration on some PyPy configurations
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
35 when using `genapplib`.
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
36
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
37 While technically a breaking change no known client is known to
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
38 rely on the previous behaviour.
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
39
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
40 Any only the INI-parser did set this variables automatically.
b84f8060d54c More elaborated changelog for the last change.
Franz Glasner <fzglas.hg@dom66.de>
parents: 253
diff changeset
41
252
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
42
253
16bcd85c7d28 +++++ v0.8
Franz Glasner <fzglas.hg@dom66.de>
parents: 252
diff changeset
43 0.8
252
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
44 ---
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
45
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
46 - Do not implicitely convert a configuration value to text if the
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
47 value is the result of just a variable expansion.
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
48
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
49 While technically a breaking change no known client is known to rely
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
50 on the previous behaviour.
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
51
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
52
176
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
53 0.7
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
54 ---
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
55
201
24f4ab79a3ab FIX: Docu: "Overhowl" -> "Overhaul".
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
56 - A major overhaul of how filename extensions are associated with loaders
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
57 has been done:
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
58
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
59 + Filename extensions in :mod:`fnmatch` style are associated with
205
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
60 file-mode strings.
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
61
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
62 These file-mode strings are associated with loader
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
63 functions separately via the mapping :py:data:`configmix.mode_loaders`.
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
64
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
65 + :py:func:`configmix.set_assoc`, :py:func:`configmix.get_assoc`,
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
66 :py:func:`configmix.clear_assoc` and
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
67 :py:func:`configmix.get_default_assoc` are the new names for the old
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
68 `set_loader()`, `get_loader()`, `clear_loader()` and
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
69 `get_default_loader()` functions.
205
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
70 They are used for associating :mod:`fnmatch` style filename patterns
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
71 to file-mode strings. Previously they associated loader functions
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
72 directly.
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
73
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
74 + :py:func:`configmix.set_assoc` now requires a :mod:`fnmatch` style
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
75 pattern instead of just a file extension string (i.e. a plain trailer).
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
76 The previons dictionary with mapping from filename extensions to loader
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
77 callables is now a list of tuples containing the :mod:`fnmatch` style
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
78 pattern and the corresponding loader callable.
176
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
79
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
80
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
81 0.6
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
82 ---
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
83
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
84 - :py:func:`configmix.safe_merge` does now a deepcopy of all source
160
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
85 configurations when merging. Changes in configuration instances
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
86 afterwards will not be reflected in the merged configuration any
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
87 more.
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
88
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
89 The public signature of :py:func:`configmix.safe_merge` has *not*
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
90 changed.
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: 111
diff changeset
91
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: 111
diff changeset
92 - 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: 111
diff changeset
93 :py:func:`configmix.ini.load` is now "UTF-8". Previously it was undefined
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: 111
diff changeset
94 and therefore dependent on the user's locale.