1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
# R overlay -- config package, entryutil
# -*- coding: utf-8 -*-
# Copyright (C) 2012-2014 André Erdmann <dywi@mailerd.de>
# Distributed under the terms of the GNU General Public License;
# either version 2 of the License, or (at your option) any later version.
"""provides config utility functions that are normally not needed."""
__all__ = [ 'list_entries', ]
import re
import textwrap
import roverlay.config.exceptions
from roverlay.config.entrymap import CONFIG_ENTRY_MAP
def deref_entry ( name ):
# COULDFIX: raise ConfigOptionNotFound
entry_name = name.lower()
entry_next = CONFIG_ENTRY_MAP [entry_name]
while isinstance ( entry_next, str ):
entry_name = entry_next
entry_next = CONFIG_ENTRY_MAP [entry_name]
return ( entry_name, entry_next )
# --- end of deref_entry (...) ---
def deref_entry_safe ( name ):
visited = set()
entry_name = name.lower()
try:
entry_next = CONFIG_ENTRY_MAP [entry_name]
except KeyError:
# entry does not exist
raise roverlay.config.exceptions.ConfigOptionNotFound ( name )
while isinstance ( entry_next, str ):
visited.add ( entry_name )
entry_name = entry_next
try:
entry_next = CONFIG_ENTRY_MAP [entry_name]
except KeyError:
raise roverlay.config.exceptions.ConfigEntryMapException (
"dangling config map entry {!r} (<- {!r})".format (
entry_name, name
)
)
if entry_name in visited:
raise roverlay.config.exceptions.ConfigEntryMapException (
"cyclic config entry detected for {!r}!".format ( name )
)
return ( entry_name, entry_next )
# --- end of deref_entry_safe (...) ---
def find_config_path ( name ):
entry_name, entry = deref_entry_safe ( name )
if entry:
try:
return entry ['path']
except KeyError:
return entry_name.split ( '_' )
else:
# hidden entry
raise roverlay.config.exceptions.ConfigOptionNotFound ( name )
# --- end of find_config_path (...) ---
def iter_visible_entries():
for entry_key, entry in CONFIG_ENTRY_MAP.items():
if entry is not None:
# else entry is disabled
yield ( entry_key, entry )
# --- end of iter_visible_entries (...) ---
def iter_entries_with_value_type ( value_types ):
for key, entry in iter_visible_entries():
if isinstance ( entry, dict ):
if entry.get ( 'value_type' ) in value_types:
yield ( key, entry )
elif entry and isinstance ( entry, str ):
# ^ not really necessary
real_key, real_entry = deref_entry_safe ( key )
if (
isinstance ( real_entry, dict )
and real_entry.get ( 'value_type' ) in value_types
):
yield ( key, real_entry )
# -- end for
# --- end of iter_entries_with_value_type (...) ---
def iter_config_keys():
for key, entry in CONFIG_ENTRY_MAP.items():
if isinstance ( entry, dict ):
yield key
# --- end of iter_config_keys (...) ---
def _iter_entries():
"""Iterates through all entries in CONFIG_ENTRY_MAP and yields config
entry information (entry name, description).
"""
for entry_key, entry in iter_visible_entries():
name = entry_key.upper()
if isinstance ( entry, dict ):
description = entry.get ( 'description' ) or entry.get ( 'desc' )
if description:
if isinstance ( description, str ):
yield ( name, description )
else:
yield ( name, '\n'.join ( map ( str, description ) ) )
else:
yield ( name, )
elif isinstance ( entry, str ) and entry:
yield ( name, "alias to " + entry.upper() )
else:
yield ( name, )
def list_entries ( newline_after_entry=True ):
"""Returns a string that lists (and describes) all config entries.
arguments:
* newline_after_entry -- insert an empty line after each config entry
"""
wrapper = textwrap.TextWrapper (
initial_indent = 2 * ' ',
subsequent_indent = 3 * ' ',
#width = 75,
)
remove_ws = re.compile ( "\s+" )
wrap = wrapper.wrap
lines = list()
for entry in sorted ( _iter_entries(), key = lambda x : x[0] ):
lines.append ( entry [0] )
if len ( entry ) > 1:
lines.extend ( wrap ( remove_ws.sub ( ' ', entry [1] ) ) )
if newline_after_entry:
lines.append ( '' )
return '\n'.join ( lines )
|
GitWeb