This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Modular interpolation in configparser
Type: enhancement Stage: resolved
Components: Library (Lib) Versions: Python 3.2
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: lukasz.langa Nosy List: asolovyov, eric.araujo, fdrake, georg.brandl, lukasz.langa, rhettinger
Priority: normal Keywords: needs review, patch

Created on 2010-11-22 03:16 by lukasz.langa, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
configparser_interpolation.diff lukasz.langa, 2010-11-22 03:16 Refactoring to enable modular interpolation
Messages (4)
msg122078 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2010-11-22 03:16
SUMMARY
=======

This is a refactoring of configparser raised from discussions on #6517 and #9876. It solves both issues and makes the code quite elegant. Best part is, it's fully backwards compatible [1].

In the patch I basically did:
a) move the interpolation functionality out of the parsers
b) deprecate RCP and CP in favor of SCP
c) refactor the resulting code to get rid of duplicates

This means that actually despite the generalization and introduction of deprecation warnings, configparser lost 22 lines in the process. The implementation is complete and unit tested.


WHAT'S LEFT TO DO
=================

1. Obviously the new `interpolation` __init__ argument needs docs. This includes the docstrings on *Interpolation classes that describe how the algorithms work.

2. `ExtendedInterpolation` class implementing the buildout syntax, that would satisfy the request from #9876.

3. Once we have more interpolation implementations new test cases will be added to test_cfgparser.py.

Will do all three when I have any opinions on the current direction.


REVIEW HINTS
============

I need some thumbs up or advice on the design decisions made.

1. `interpolation` now takes a class, __init__ instantiates an object on its own. Do tell if taking an object upfront would be a better approach.

2. *Interpolation classes have methods which take the parser as an argument. Do tell if making it an object attribute would be a better approach.

All other points of interest during a review naturally apply here too.



[1] Assuming _names are private and can be moved around when needed.
msg122537 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2010-11-27 18:24
Patch reposted here for review: http://codereview.appspot.com/3309043/
msg122744 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2010-11-28 22:57
Review posted.
msg123258 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2010-12-03 16:29
Committed in rev 86976.
History
Date User Action Args
2022-04-11 14:57:09adminsetgithub: 54708
2010-12-03 16:29:45lukasz.langasetstatus: open -> closed
resolution: accepted
messages: + msg123258

stage: patch review -> resolved
2010-11-28 22:57:23fdrakesetmessages: + msg122744
2010-11-27 18:24:44lukasz.langasetmessages: + msg122537
2010-11-23 12:38:18asolovyovsetnosy: + asolovyov
2010-11-22 03:20:05lukasz.langalinkissue9876 superseder
2010-11-22 03:18:56lukasz.langalinkissue6517 superseder
2010-11-22 03:16:24lukasz.langacreate