Remove dependency on ConfigObj

[Ryan J Ollos]

It seems like the dependency on ConfigObj in tracopt.perm.authz_policy may be unnecessary. After extracting a class from the trac.config module that provides a thin wrapper over ConfigParser, we can use that class instead of ConfigObj.

[Ryan J Ollos]

Proposed changes in log:rjollos.git:t11982-remove-configobj:

• More testing is needed. I plan to add more tests before committing.
• One test is commented out. The issue is already captured in #11538. ConfigParser doesn't throw an exception due to duplicate sections or options.
• Further modifications are possible when #11339 is implemented. I'd like to extract a class that can read and write a configuration file but has no coupling the ComponentManager or Option classes. The class with knowledge of ComponentManager and Option would utilize this extracted class to read and write the environment configuration. The extracted class could be utilized by the authz_policy module so that we have the capability to write authz files as well as read them.

[Ryan J Ollos]

Revised changes in log:rjollos.git:t11982-remove-configobj.1. Tested so far on Mac OSX with Python 2.6 and Python 2.7.

[Ryan J Ollos]

Tested also with Python 2.6 and 2.7 on Windows 7. Committed to trunk in [13993:13995]. More work on config module is forthcoming in #6551, and yet-to-be-created tickets.

I'll update the 1.1 documentation soon to remove ConfigObj from the optional dependencies.

[Jun Omae]

I started to confirm [13393:13995]. At least, I think we should move the following try...except ImportError:... statements in trac/config.py to trac/util/compat.py like cleandoc() in trac-1.0.5​.

 29 try:
 30     from collections import OrderedDict
 31 except ImportError:
 32     from trac.util.compat import OrderedDict

After moving that, we could simply replace with:

from trac.util.compat import OrderedDict

[Ryan J Ollos]

Thanks, I modified the imports and removed some Python 2.7 compatibility code in the OrderedDict class in [13996].

Documentation edited in:

• TracDev/ApiChanges/1.3@8
• 1.1/TracFineGrainedPermissions@6
• TracDev/ApiChanges/1.1.5@3

[Ryan J Ollos]

Minor additional change in [14036].

[Ryan J Ollos]

Additional refactoring committed in [14130]: localizes utf-8 encoding / decoding to the UnicodeConfigParser class and removes ConfigurationStub.

[Ryan J Ollos]

Additional refactoring is proposed in log:rjollos.git:t11982_refactoring_configuration. The aim is to avoid directly accessing UnicodeConfigParser._sections, not just because it is bad practice to access a protected attribute, but because the contents of _sections is utf-8 encoded and the content is decoded to unicode through the public interface of UnicodeConfigParser. All of the config module code works with unicode strings, except UnicodeConfigParser which serves as the boundary for encoding/decoding.

[Ryan J Ollos]

Committed to trunk in [14138].

[Ryan J Ollos]

These changes introduced a regression described in comment:8:ticket:12649.