forked fromgitpython-developers/GitPython
- Notifications
You must be signed in to change notification settings - Fork0
Expand file tree
/
Copy pathconfig.py
More file actions
593 lines (488 loc) · 22.6 KB
/
config.py
File metadata and controls
593 lines (488 loc) · 22.6 KB
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
# config.py
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
"""Module containing module parser implementation able to properly read and write
configuration files"""
importabc
fromfunctoolsimportwraps
importinspect
importlogging
importos
importre
fromcollectionsimportOrderedDict
fromgit.compatimport (
string_types,
FileType,
defenc,
force_text,
with_metaclass,
PY3
)
fromgit.utilimportLockFile
importos.pathasosp
try:
importConfigParserascp
exceptImportError:
# PY3
importconfigparserascp
__all__= ('GitConfigParser','SectionConstraint')
log=logging.getLogger('git.config')
log.addHandler(logging.NullHandler())
classMetaParserBuilder(abc.ABCMeta):
"""Utlity class wrapping base-class methods into decorators that assure read-only properties"""
def__new__(cls,name,bases,clsdict):
"""
Equip all base-class methods with a needs_values decorator, and all non-const methods
with a set_dirty_and_flush_changes decorator in addition to that."""
kmm='_mutating_methods_'
ifkmminclsdict:
mutating_methods=clsdict[kmm]
forbaseinbases:
methods= (tfortininspect.getmembers(base,inspect.isroutine)ifnott[0].startswith("_"))
forname,methodinmethods:
ifnameinclsdict:
continue
method_with_values=needs_values(method)
ifnameinmutating_methods:
method_with_values=set_dirty_and_flush_changes(method_with_values)
# END mutating methods handling
clsdict[name]=method_with_values
# END for each name/method pair
# END for each base
# END if mutating methods configuration is set
new_type=super(MetaParserBuilder,cls).__new__(cls,name,bases,clsdict)
returnnew_type
defneeds_values(func):
"""Returns method assuring we read values (on demand) before we try to access them"""
@wraps(func)
defassure_data_present(self,*args,**kwargs):
self.read()
returnfunc(self,*args,**kwargs)
# END wrapper method
returnassure_data_present
defset_dirty_and_flush_changes(non_const_func):
"""Return method that checks whether given non constant function may be called.
If so, the instance will be set dirty.
Additionally, we flush the changes right to disk"""
defflush_changes(self,*args,**kwargs):
rval=non_const_func(self,*args,**kwargs)
self._dirty=True
self.write()
returnrval
# END wrapper method
flush_changes.__name__=non_const_func.__name__
returnflush_changes
classSectionConstraint(object):
"""Constrains a ConfigParser to only option commands which are constrained to
always use the section we have been initialized with.
It supports all ConfigParser methods that operate on an option.
:note:
If used as a context manager, will release the wrapped ConfigParser."""
__slots__= ("_config","_section_name")
_valid_attrs_= ("get_value","set_value","get","set","getint","getfloat","getboolean","has_option",
"remove_section","remove_option","options")
def__init__(self,config,section):
self._config=config
self._section_name=section
def__del__(self):
# Yes, for some reason, we have to call it explicitly for it to work in PY3 !
# Apparently __del__ doesn't get call anymore if refcount becomes 0
# Ridiculous ... .
self._config.release()
def__getattr__(self,attr):
ifattrinself._valid_attrs_:
returnlambda*args,**kwargs:self._call_config(attr,*args,**kwargs)
returnsuper(SectionConstraint,self).__getattribute__(attr)
def_call_config(self,method,*args,**kwargs):
"""Call the configuration at the given method which must take a section name
as first argument"""
returngetattr(self._config,method)(self._section_name,*args,**kwargs)
@property
defconfig(self):
"""return: Configparser instance we constrain"""
returnself._config
defrelease(self):
"""Equivalent to GitConfigParser.release(), which is called on our underlying parser instance"""
returnself._config.release()
def__enter__(self):
self._config.__enter__()
returnself
def__exit__(self,exception_type,exception_value,traceback):
self._config.__exit__(exception_type,exception_value,traceback)
classGitConfigParser(with_metaclass(MetaParserBuilder,cp.RawConfigParser,object)):
"""Implements specifics required to read git style configuration files.
This variation behaves much like the git.config command such that the configuration
will be read on demand based on the filepath given during initialization.
The changes will automatically be written once the instance goes out of scope, but
can be triggered manually as well.
The configuration file will be locked if you intend to change values preventing other
instances to write concurrently.
:note:
The config is case-sensitive even when queried, hence section and option names
must match perfectly.
If used as a context manager, will release the locked file."""
#{ Configuration
# The lock type determines the type of lock to use in new configuration readers.
# They must be compatible to the LockFile interface.
# A suitable alternative would be the BlockingLockFile
t_lock=LockFile
re_comment=re.compile(r'^\s*[#;]')
#} END configuration
optvalueonly_source=r'\s*(?P<option>[^:=\s][^:=]*)'
OPTVALUEONLY=re.compile(optvalueonly_source)
OPTCRE=re.compile(optvalueonly_source+r'\s*(?P<vi>[:=])\s*'+r'(?P<value>.*)$')
deloptvalueonly_source
# list of RawConfigParser methods able to change the instance
_mutating_methods_= ("add_section","remove_section","remove_option","set")
def__init__(self,file_or_files,read_only=True,merge_includes=True):
"""Initialize a configuration reader to read the given file_or_files and to
possibly allow changes to it by setting read_only False
:param file_or_files:
A single file path or file objects or multiple of these
:param read_only:
If True, the ConfigParser may only read the data , but not change it.
If False, only a single file path or file object may be given. We will write back the changes
when they happen, or when the ConfigParser is released. This will not happen if other
configuration files have been included
:param merge_includes: if True, we will read files mentioned in [include] sections and merge their
contents into ours. This makes it impossible to write back an individual configuration file.
Thus, if you want to modify a single configuration file, turn this off to leave the original
dataset unaltered when reading it."""
cp.RawConfigParser.__init__(self,dict_type=OrderedDict)
# Used in python 3, needs to stay in sync with sections for underlying implementation to work
ifnothasattr(self,'_proxies'):
self._proxies=self._dict()
self._file_or_files=file_or_files
self._read_only=read_only
self._dirty=False
self._is_initialized=False
self._merge_includes=merge_includes
self._lock=None
self._acquire_lock()
def_acquire_lock(self):
ifnotself._read_only:
ifnotself._lock:
ifisinstance(self._file_or_files, (tuple,list)):
raiseValueError(
"Write-ConfigParsers can operate on a single file only, multiple files have been passed")
# END single file check
file_or_files=self._file_or_files
ifnotisinstance(self._file_or_files,string_types):
file_or_files=self._file_or_files.name
# END get filename from handle/stream
# initialize lock base - we want to write
self._lock=self.t_lock(file_or_files)
# END lock check
self._lock._obtain_lock()
# END read-only check
def__del__(self):
"""Write pending changes if required and release locks"""
# NOTE: only consistent in PY2
self.release()
def__enter__(self):
self._acquire_lock()
returnself
def__exit__(self,exception_type,exception_value,traceback):
self.release()
defrelease(self):
"""Flush changes and release the configuration write lock. This instance must not be used anymore afterwards.
In Python 3, it's required to explicitly release locks and flush changes, as __del__ is not called
deterministically anymore."""
# checking for the lock here makes sure we do not raise during write()
# in case an invalid parser was created who could not get a lock
ifself.read_onlyor (self._lockandnotself._lock._has_lock()):
return
try:
try:
self.write()
exceptIOError:
log.error("Exception during destruction of GitConfigParser",exc_info=True)
exceptReferenceError:
# This happens in PY3 ... and usually means that some state cannot be written
# as the sections dict cannot be iterated
# Usually when shutting down the interpreter, don'y know how to fix this
pass
finally:
self._lock._release_lock()
defoptionxform(self,optionstr):
"""Do not transform options in any way when writing"""
returnoptionstr
def_read(self,fp,fpname):
"""A direct copy of the py2.4 version of the super class's _read method
to assure it uses ordered dicts. Had to change one line to make it work.
Future versions have this fixed, but in fact its quite embarrassing for the
guys not to have done it right in the first place !
Removed big comments to make it more compact.
Made sure it ignores initial whitespace as git uses tabs"""
cursect=None# None, or a dictionary
optname=None
lineno=0
is_multi_line=False
e=None# None, or an exception
defstring_decode(v):
ifv[-1]=='\\':
v=v[:-1]
# end cut trailing escapes to prevent decode error
ifPY3:
returnv.encode(defenc).decode('unicode_escape')
else:
returnv.decode('string_escape')
# end
# end
whileTrue:
# we assume to read binary !
line=fp.readline().decode(defenc)
ifnotline:
break
lineno=lineno+1
# comment or blank line?
ifline.strip()==''orself.re_comment.match(line):
continue
ifline.split(None,1)[0].lower()=='rem'andline[0]in"rR":
# no leading whitespace
continue
# is it a section header?
mo=self.SECTCRE.match(line.strip())
ifnotis_multi_lineandmo:
sectname=mo.group('header').strip()
ifsectnameinself._sections:
cursect=self._sections[sectname]
elifsectname==cp.DEFAULTSECT:
cursect=self._defaults
else:
cursect=self._dict((('__name__',sectname),))
self._sections[sectname]=cursect
self._proxies[sectname]=None
# So sections can't start with a continuation line
optname=None
# no section header in the file?
elifcursectisNone:
raisecp.MissingSectionHeaderError(fpname,lineno,line)
# an option line?
elifnotis_multi_line:
mo=self.OPTCRE.match(line)
ifmo:
# We might just have handled the last line, which could contain a quotation we want to remove
optname,vi,optval=mo.group('option','vi','value')
ifviin ('=',':')and';'inoptvalandnotoptval.strip().startswith('"'):
pos=optval.find(';')
ifpos!=-1andoptval[pos-1].isspace():
optval=optval[:pos]
optval=optval.strip()
ifoptval=='""':
optval=''
# end handle empty string
optname=self.optionxform(optname.rstrip())
iflen(optval)>1andoptval[0]=='"'andoptval[-1]!='"':
is_multi_line=True
optval=string_decode(optval[1:])
# end handle multi-line
cursect[optname]=optval
else:
# check if it's an option with no value - it's just ignored by git
ifnotself.OPTVALUEONLY.match(line):
ifnote:
e=cp.ParsingError(fpname)
e.append(lineno,repr(line))
continue
else:
line=line.rstrip()
ifline.endswith('"'):
is_multi_line=False
line=line[:-1]
# end handle quotations
cursect[optname]+=string_decode(line)
# END parse section or option
# END while reading
# if any parsing errors occurred, raise an exception
ife:
raisee
def_has_includes(self):
returnself._merge_includesandself.has_section('include')
defread(self):
"""Reads the data stored in the files we have been initialized with. It will
ignore files that cannot be read, possibly leaving an empty configuration
:return: Nothing
:raise IOError: if a file cannot be handled"""
ifself._is_initialized:
return
self._is_initialized=True
ifnotisinstance(self._file_or_files, (tuple,list)):
files_to_read= [self._file_or_files]
else:
files_to_read=list(self._file_or_files)
# end assure we have a copy of the paths to handle
seen=set(files_to_read)
num_read_include_files=0
whilefiles_to_read:
file_path=files_to_read.pop(0)
fp=file_path
file_ok=False
ifhasattr(fp,"seek"):
self._read(fp,fp.name)
else:
# assume a path if it is not a file-object
try:
withopen(file_path,'rb')asfp:
file_ok=True
self._read(fp,fp.name)
exceptIOError:
continue
# Read includes and append those that we didn't handle yet
# We expect all paths to be normalized and absolute (and will assure that is the case)
ifself._has_includes():
for_,include_pathinself.items('include'):
ifinclude_path.startswith('~'):
include_path=osp.expanduser(include_path)
ifnotosp.isabs(include_path):
ifnotfile_ok:
continue
# end ignore relative paths if we don't know the configuration file path
assertosp.isabs(file_path),"Need absolute paths to be sure our cycle checks will work"
include_path=osp.join(osp.dirname(file_path),include_path)
# end make include path absolute
include_path=osp.normpath(include_path)
ifinclude_pathinseenornotos.access(include_path,os.R_OK):
continue
seen.add(include_path)
# insert included file to the top to be considered first
files_to_read.insert(0,include_path)
num_read_include_files+=1
# each include path in configuration file
# end handle includes
# END for each file object to read
# If there was no file included, we can safely write back (potentially) the configuration file
# without altering it's meaning
ifnum_read_include_files==0:
self._merge_includes=False
# end
def_write(self,fp):
"""Write an .ini-format representation of the configuration state in
git compatible format"""
defwrite_section(name,section_dict):
fp.write(("[%s]\n"%name).encode(defenc))
for (key,value)insection_dict.items():
ifkey!="__name__":
fp.write(("\t%s = %s\n"% (key,self._value_to_string(value).replace('\n','\n\t'))).encode(defenc))
# END if key is not __name__
# END section writing
ifself._defaults:
write_section(cp.DEFAULTSECT,self._defaults)
forname,valueinself._sections.items():
write_section(name,value)
defitems(self,section_name):
""":return: list((option, value), ...) pairs of all items in the given section"""
return [(k,v)fork,vinsuper(GitConfigParser,self).items(section_name)ifk!='__name__']
@needs_values
defwrite(self):
"""Write changes to our file, if there are changes at all
:raise IOError: if this is a read-only writer instance or if we could not obtain
a file lock"""
self._assure_writable("write")
ifnotself._dirty:
return
ifisinstance(self._file_or_files, (list,tuple)):
raiseAssertionError("Cannot write back if there is not exactly a single file to write to, have %i files"
%len(self._file_or_files))
# end assert multiple files
ifself._has_includes():
log.debug("Skipping write-back of configuration file as include files were merged in."+
"Set merge_includes=False to prevent this.")
return
# end
fp=self._file_or_files
# we have a physical file on disk, so get a lock
is_file_lock=isinstance(fp,string_types+ (FileType, ))
ifis_file_lock:
self._lock._obtain_lock()
ifnothasattr(fp,"seek"):
withopen(self._file_or_files,"wb")asfp:
self._write(fp)
else:
fp.seek(0)
# make sure we do not overwrite into an existing file
ifhasattr(fp,'truncate'):
fp.truncate()
self._write(fp)
def_assure_writable(self,method_name):
ifself.read_only:
raiseIOError("Cannot execute non-constant method %s.%s"% (self,method_name))
defadd_section(self,section):
"""Assures added options will stay in order"""
returnsuper(GitConfigParser,self).add_section(section)
@property
defread_only(self):
""":return: True if this instance may change the configuration file"""
returnself._read_only
defget_value(self,section,option,default=None):
"""
:param default:
If not None, the given default value will be returned in case
the option did not exist
:return: a properly typed value, either int, float or string
:raise TypeError: in case the value could not be understood
Otherwise the exceptions known to the ConfigParser will be raised."""
try:
valuestr=self.get(section,option)
exceptException:
ifdefaultisnotNone:
returndefault
raise
types= (int,float)
fornumtypeintypes:
try:
val=numtype(valuestr)
# truncated value ?
ifval!=float(valuestr):
continue
returnval
except (ValueError,TypeError):
continue
# END for each numeric type
# try boolean values as git uses them
vl=valuestr.lower()
ifvl=='false':
returnFalse
ifvl=='true':
returnTrue
ifnotisinstance(valuestr,string_types):
raiseTypeError("Invalid value type: only int, long, float and str are allowed",valuestr)
returnvaluestr
def_value_to_string(self,value):
ifisinstance(value, (int,float,bool)):
returnstr(value)
returnforce_text(value)
@needs_values
@set_dirty_and_flush_changes
defset_value(self,section,option,value):
"""Sets the given option in section to the given value.
It will create the section if required, and will not throw as opposed to the default
ConfigParser 'set' method.
:param section: Name of the section in which the option resides or should reside
:param option: Name of the options whose value to set
:param value: Value to set the option to. It must be a string or convertible
to a string
:return: this instance"""
ifnotself.has_section(section):
self.add_section(section)
self.set(section,option,self._value_to_string(value))
returnself
defrename_section(self,section,new_name):
"""rename the given section to new_name
:raise ValueError: if section doesn't exit
:raise ValueError: if a section with new_name does already exist
:return: this instance
"""
ifnotself.has_section(section):
raiseValueError("Source section '%s' doesn't exist"%section)
ifself.has_section(new_name):
raiseValueError("Destination section '%s' already exists"%new_name)
super(GitConfigParser,self).add_section(new_name)
fork,vinself.items(section):
self.set(new_name,k,self._value_to_string(v))
# end for each value to copy
# This call writes back the changes, which is why we don't have the respective decorator
self.remove_section(section)
returnself