forked from wikimedia/pywikibot
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.py
3409 lines (2882 loc) · 131 KB
/
api.py
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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""Interface to Mediawiki's api.php."""
#
# (C) Pywikibot team, 2007-2020
#
# Distributed under the terms of the MIT license.
#
from __future__ import absolute_import, division, unicode_literals
import datetime
import hashlib
import inspect
import json
import os
import pprint
import re
import traceback
try:
from collections.abc import Container, MutableMapping
except ImportError: # Python 2.7
from collections import Container, MutableMapping
from email.mime.nonmultipart import MIMENonMultipart
from warnings import warn
try:
import cPickle as pickle # noqa: N813
except ImportError:
import pickle
import pywikibot
from pywikibot import config, login
from pywikibot.comms import http
from pywikibot.exceptions import (
Server504Error, Server414Error, FatalServerError, NoUsername,
Error, TimeoutError, InvalidTitle, UnsupportedPage
)
from pywikibot.tools import (
deprecated, itergroup, PY2, PYTHON_VERSION,
getargspec, UnicodeType, remove_last_args
)
from pywikibot.tools.formatter import color_format
if not PY2:
from urllib.parse import urlencode, unquote
# Bug: T113120, T228841
# Subclassing necessary to fix bug of the email package in Python 3:
# see https://bugs.python.org/issue19003
# see https://bugs.python.org/issue18886
# The following solution might be removed if the bug is fixed for
# Python versions which are supported by PWB.
from email.generator import BytesGenerator
from email.mime.multipart import MIMEMultipart as MIMEMultipartOrig
from io import BytesIO
class CTEBinaryBytesGenerator(BytesGenerator):
"""Workaround for bug in python 3 email handling of CTE binary."""
def __init__(self, *args, **kwargs):
"""Initializer."""
super(CTEBinaryBytesGenerator, self).__init__(*args, **kwargs)
self._writeBody = self._write_body
def _write_body(self, msg):
if msg['content-transfer-encoding'] == 'binary':
self._fp.write(msg.get_payload(decode=True))
else:
super(CTEBinaryBytesGenerator, self)._handle_text(msg)
class CTEBinaryMIMEMultipart(MIMEMultipartOrig):
"""Workaround for bug in python 3 email handling of CTE binary."""
def as_bytes(self, unixfrom=False, policy=None):
"""Return unmodified binary payload."""
policy = self.policy if policy is None else policy
fp = BytesIO()
g = CTEBinaryBytesGenerator(fp, mangle_from_=False, policy=policy)
g.flatten(self, unixfrom=unixfrom)
return fp.getvalue()
MIMEMultipart = CTEBinaryMIMEMultipart
else:
from urllib import urlencode, unquote
from email.mime.multipart import MIMEMultipart
# Bug: T243710 (Python 2)
# see https://github.com/jxtech/wechatpy/issues/375
from urllib import quote
quote(b'non-empty-string', safe=b'')
_logger = 'data.api'
lagpattern = re.compile(
r'Waiting for [\w.: ]+: (?P<lag>\d+(?:\.\d+)?) seconds? lagged')
class APIError(Error):
"""The wiki site returned an error message."""
def __init__(self, code, info, **kwargs):
"""Save error dict returned by MW API."""
self.code = code
self.info = info
self.other = kwargs
self.unicode = UnicodeType(self.__str__())
def __repr__(self):
"""Return internal representation."""
return '{name}("{code}", "{info}", {other})'.format(
name=self.__class__.__name__, **self.__dict__)
def __str__(self):
"""Return a string representation."""
if self.other:
return '{0}: {1}\n[{2}]'.format(
self.code,
self.info,
';\n '.join(
'{0}: {1}'.format(key, val)
for key, val in self.other.items()))
return '{0}: {1}'.format(self.code, self.info)
class UploadWarning(APIError):
"""Upload failed with a warning message (passed as the argument)."""
def __init__(self, code, message, file_key=None, offset=0):
"""
Create a new UploadWarning instance.
@param filekey: The filekey of the uploaded file to reuse it later. If
no key is known or it is an incomplete file it may be None.
@type filekey: str or None
@param offset: The starting offset for a chunked upload. Is False when
there is no offset.
@type offset: int or bool
"""
super(UploadWarning, self).__init__(code, message)
self.file_key = file_key
self.offset = offset
@property
def message(self):
"""Return warning message."""
return self.info
class APIMWException(APIError):
"""The API site returned an error about a MediaWiki internal exception."""
def __init__(self, mediawiki_exception_class_name, info, **kwargs):
"""Save error dict returned by MW API."""
self.mediawiki_exception_class_name = mediawiki_exception_class_name
code = 'internal_api_error_' + mediawiki_exception_class_name
super(APIMWException, self).__init__(code, info, **kwargs)
class ParamInfo(Container):
"""
API parameter information data object.
Provides cache aware fetching of parameter information.
It does not support the format modules.
"""
paraminfo_keys = frozenset(['modules', 'querymodules', 'formatmodules',
'mainmodule', 'pagesetmodule'])
root_modules = frozenset(['main', 'pageset'])
init_modules = frozenset(['main', 'paraminfo'])
def __init__(self, site, preloaded_modules=None, modules_only_mode=None):
"""
Initializer.
@param preloaded_modules: API modules to preload
@type preloaded_modules: set of string
@param modules_only_mode: use the 'modules' only syntax for API request
@type modules_only_mode: bool or None to only use default, which True
if the site is 1.25wmf4+
"""
self.site = site
# Keys are module names, values are the raw responses from the server.
self._paraminfo = {}
# Cached data.
self._prefixes = {}
self._prefix_map = {}
self._with_limits = None
self._action_modules = frozenset() # top level modules
self._modules = {} # filled in _init() (and enlarged in fetch)
self._limit = None
self.preloaded_modules = self.init_modules
if preloaded_modules:
self.preloaded_modules |= set(preloaded_modules)
self.modules_only_mode = modules_only_mode
if self.modules_only_mode:
self.paraminfo_keys = frozenset(['modules'])
def _add_submodules(self, name, modules):
"""Add the modules to the internal cache or check if equal."""
# The current implementation here doesn't support submodules inside of
# submodules, because that would require to fetch all modules when only
# the names of them were requested
assert '+' not in name
modules = frozenset(modules)
if name == 'main':
# The main module behaves differently as it has no prefix
if self._action_modules:
assert modules == self._action_modules
else:
self._action_modules = modules
elif name in self._modules:
assert modules == self._modules[name]
else:
self._modules[name] = modules
def _init(self):
assert ('query' in self._modules) is ('main' in self._paraminfo)
if 'query' in self._modules:
return
mw_ver = self.site.mw_version
if mw_ver < '1.15':
self._parse_help()
# The paraminfo api deprecated the old request syntax of
# querymodules='info'; to avoid warnings sites with 1.25wmf4+
# must only use 'modules' parameter.
if self.modules_only_mode is None:
self.modules_only_mode = mw_ver >= '1.25wmf4'
if self.modules_only_mode:
self.paraminfo_keys = frozenset(['modules'])
# v1.18 and earlier paraminfo doesn't include modules; must use 'query'
# Assume that by v1.26, it will be desirable to prefetch 'query'
if mw_ver > '1.26' or mw_ver < '1.19':
self.preloaded_modules |= {'query'}
self._fetch(self.preloaded_modules)
# paraminfo 'mainmodule' was added 1.15
assert('main' in self._paraminfo)
main_modules_param = self.parameter('main', 'action')
assert(main_modules_param)
assert('type' in main_modules_param)
assert(isinstance(main_modules_param['type'], list))
assert self._action_modules == set(main_modules_param['type'])
# While deprecated with warning in 1.25, paraminfo param 'querymodules'
# provides a list of all query modules. This will likely be removed
# from the API in the future, in which case the fallback is the use
# the same data available in the paraminfo for query.
query_modules_param = self.parameter('paraminfo', 'querymodules')
assert('limit' in query_modules_param)
self._limit = query_modules_param['limit']
if query_modules_param and 'type' in query_modules_param:
# 1.19+ 'type' is the list of modules; on 1.18, it is 'string'
if isinstance(query_modules_param['type'], list):
self._add_submodules('query', query_modules_param['type'])
if 'query' not in self._modules:
assert 'query' not in self._paraminfo
self._fetch({'query'})
assert 'query' in self._modules
def _emulate_pageset(self):
"""Emulate the pageset module, which existed in MW 1.15-1.24."""
# pageset isn't a module in the new system, so it is emulated, with
# the paraminfo from the query module.
assert('query' in self._paraminfo)
self._paraminfo['pageset'] = {
'name': 'pageset',
'path': 'pageset',
'classname': 'ApiPageSet',
'prefix': '',
'readrights': '',
'helpurls': [],
'parameters': self._paraminfo['query']['parameters']
}
def _parse_help(self):
"""Emulate paraminfo['main'] data using help for mw 1.14."""
# Request need ParamInfo to determine use_get
request = self.site._request(expiry=config.API_config_expiry,
use_get=True,
parameters={'action': 'help'})
result = request.submit()
assert('help' in result)
assert(isinstance(result['help'], dict))
assert('mime' in result['help'])
assert(result['help']['mime'] == 'text/plain')
assert('help' in result['help'])
assert(isinstance(result['help']['help'], UnicodeType))
help_text = result['help']['help']
start = help_text.find('What action you would like to perform')
start = help_text.find('One value: ', start) + len('One value: ')
end = help_text.find('\n', start)
action_modules = help_text[start:end].split(', ')
start = help_text.find('The format of the output')
start = help_text.find('One value: ', start) + len('One value: ')
end = help_text.find('\n', start)
format_modules = help_text[start:end].split(', ')
self._paraminfo['main'] = {
'name': 'main',
'path': 'main',
'classname': 'ApiMain',
'prefix': '',
'readrights': '',
'helpurls': [],
'parameters': [
{
'name': 'action',
'type': action_modules,
'submodules': '',
},
{
'name': 'format',
'type': format_modules,
'submodules': '',
},
],
}
@staticmethod
def _modules_to_set(modules):
"""Return modules as a set.
@type modules: iterable or basestring
@rtype: set
"""
if isinstance(modules, UnicodeType):
return set(modules.split('|'))
return set(modules)
def fetch(self, modules):
"""
Fetch paraminfo for multiple modules.
No exception is raised when paraminfo for a module does not exist.
Use __getitem__ to cause an exception if a module does not exist.
@param modules: API modules to load
@type modules: iterable or str
@rtype: NoneType
"""
if 'main' not in self._paraminfo:
# The first request should be 'paraminfo', so that
# query modules can be prefixed with 'query+'
self._init()
modules = self._modules_to_set(modules)
if self._action_modules:
# The query module may be added before the action modules have been
if 'query' in self._modules:
# It does fetch() while initializing, and this method can't be
# called before it's initialized.
modules = self._normalize_modules(modules)
else:
# We do know the valid action modules and require a subset
assert not modules - self._action_modules - self.root_modules
self._fetch(modules)
def _fetch(self, modules):
"""
Fetch paraminfo for multiple modules without initializing beforehand.
@param modules: API modules to load and which haven't been loaded yet.
@type modules: set
@rtype: NoneType
"""
def module_generator():
"""A generator yielding batches of modules."""
i = itergroup(sorted(modules), self._limit)
for batch in i:
for failed_module in failed_modules:
yield [failed_module]
del failed_modules[:]
yield batch
modules = modules - set(self._paraminfo.keys())
if not modules:
return
assert 'query' in self._modules or 'paraminfo' not in self._paraminfo
# If something went wrong in a batch it can add each module to the
# batch and the generator will on the next iteration yield each module
# separately
failed_modules = []
# This can be further optimised, by grouping them in more stable
# subsets, which are unlikely to change. i.e. first request core
# modules which have been a stable part of the API for a long time.
# Also detecting extension based modules may help.
# Also, when self.modules_only_mode is disabled, both modules and
# querymodules may each be filled with self._limit items, doubling the
# number of modules that may be processed in a single batch.
for module_batch in module_generator():
if self.modules_only_mode and 'pageset' in module_batch:
pywikibot.debug('paraminfo fetch: removed pageset', _logger)
module_batch.remove('pageset')
# If this occurred during initialisation,
# also record it in the preloaded_modules.
# (at least so tests know an extra load was intentional)
if 'query' not in self._paraminfo:
pywikibot.debug('paraminfo batch: added query', _logger)
module_batch.append('query')
self.preloaded_modules |= {'query'}
params = {
'action': 'paraminfo',
}
if self.modules_only_mode:
params['modules'] = module_batch
else:
params['modules'] = [mod for mod in module_batch
if not mod.startswith('query+')
and mod not in self.root_modules]
params['querymodules'] = [mod[6:] for mod in module_batch
if mod.startswith('query+')]
for mod in set(module_batch) & self.root_modules:
params[mod + 'module'] = 1
# Request need ParamInfo to determine use_get
request = self.site._request(expiry=config.API_config_expiry,
use_get=True,
parameters=params)
result = request.submit()
normalized_result = self.normalize_paraminfo(result)
for path in list(normalized_result):
if normalized_result[path] is False:
del normalized_result[path]
# Sometimes the name/path of the module is not actually the name
# which was requested, so we need to manually determine which
# (wrongly named) module uses which actual name. See also T105478
missing_modules = [m for m in module_batch
if m not in normalized_result]
if len(missing_modules) == 1 and len(normalized_result) == 1:
# Okay it's possible to recover
normalized_result = next(iter(normalized_result.values()))
pywikibot.warning('The module "{0[name]}" ("{0[path]}") '
'was returned as path even though "{1}" '
'was requested'.format(normalized_result,
missing_modules[0]))
normalized_result['path'] = missing_modules[0]
normalized_result['name'] = missing_modules[0].rsplit('+')[0]
normalized_result = {missing_modules[0]: normalized_result}
elif len(module_batch) > 1 and missing_modules:
# Rerequest the missing ones separately
pywikibot.log('Inconsitency in batch "{0}"; rerequest '
'separately'.format(missing_modules))
failed_modules.extend(missing_modules)
# Remove all modules which weren't requested, we can't be sure that
# they are valid
for path in list(normalized_result):
if path not in module_batch:
del normalized_result[path]
self._paraminfo.update(normalized_result)
self._generate_submodules(mod['path']
for mod in normalized_result.values())
if 'pageset' in modules and 'pageset' not in self._paraminfo:
self._emulate_pageset()
def _generate_submodules(self, modules):
"""Check and generate submodules for the given modules."""
for module in modules:
parameters = self._paraminfo[module].get('parameters', [])
submodules = set()
# Advanced submodule into added to MW API in df80f1ea
if self.site.mw_version >= '1.26wmf9':
# This is supplying submodules even if they aren't submodules
# of the given module so skip those
for param in parameters:
if ((module == 'main' and param['name'] == 'format')
or 'submodules' not in param):
continue
for submodule in param['submodules'].values():
if '+' in submodule:
parent, child = submodule.rsplit('+', 1)
else:
parent = 'main'
child = submodule
if parent == module:
submodules.add(child)
else:
# Boolean submodule info added to MW API in afa153ae
if self.site.mw_version < '1.24wmf18':
if module == 'main':
params = {'action'}
elif module == 'query':
params = {'prop', 'list', 'meta'}
else:
params = set()
for param in parameters:
if param['name'] in params:
param['submodules'] = ''
for param in parameters:
# Do not add format modules
if ('submodules' in param
and (module != 'main'
or param['name'] != 'format')):
submodules |= set(param['type'])
if submodules:
self._add_submodules(module, submodules)
if module == 'query':
# Previously also modules from generator were used as query
# modules, but verify that those are just a subset of the
# prop/list/meta modules. There is no sanity check as this
# needs to be revisited if query has no generator parameter
for param in parameters:
if param['name'] == 'generator':
break
assert param['name'] == 'generator' and \
submodules >= set(param['type'])
def _normalize_modules(self, modules):
"""Add query+ to any query module name not also in action modules."""
# Users will supply the wrong type, and expect it to work.
modules = self._modules_to_set(modules)
assert(self._action_modules)
return {'query+' + mod
if '+' not in mod and mod in self.query_modules
and mod not in self._action_modules
else mod
for mod in modules}
def normalize_modules(self, modules):
"""
Convert the modules into module paths.
Add query+ to any query module name not also in action modules.
@return: The modules converted into a module paths
@rtype: set
"""
self._init()
return self._normalize_modules(modules)
@classmethod
def normalize_paraminfo(cls, data):
"""
Convert both old and new API JSON into a new-ish data structure.
For duplicate paths, the value will be False.
"""
result_data = {}
for paraminfo_key, modules_data in data['paraminfo'].items():
if not modules_data:
continue
if paraminfo_key[:-len('module')] in cls.root_modules:
modules_data = [modules_data]
elif not paraminfo_key.endswith('modules'):
continue
for mod_data in modules_data:
if 'missing' in mod_data:
continue
name = mod_data.get('name')
php_class = mod_data.get('classname')
if not name and php_class:
if php_class == 'ApiMain':
name = 'main'
elif php_class == 'ApiPageSet':
name = 'pageset'
else:
pywikibot.warning('Unknown paraminfo module "{0}"'
.format(php_class))
name = '<unknown>:' + php_class
mod_data['name'] = name
if 'path' not in mod_data:
# query modules often contain 'ApiQuery' and have a suffix.
# 'ApiQuery' alone is the action 'query'
if ('querytype' in mod_data
or php_class and len(php_class) > 8
and 'ApiQuery' in php_class):
mod_data['path'] = 'query+' + name
else:
mod_data['path'] = name
path = mod_data['path']
if path in result_data:
# Only warn first time
if result_data[path] is not False:
pywikibot.warning('Path "{0}" is ambiguous.'
.format(path))
else:
pywikibot.log('Found another path "{0}"'.format(path))
result_data[path] = False
else:
result_data[path] = mod_data
return result_data
def __getitem__(self, key):
"""
Return a paraminfo module for the module path, caching it.
Use the module path, such as 'query+x', to obtain the paraminfo for
submodule 'x' in the query module.
If the key does not include a '+' and is not present in the top level
of the API, it will fallback to looking for the key 'query+x'.
"""
self.fetch({key})
if key in self._paraminfo:
return self._paraminfo[key]
elif '+' not in key:
return self._paraminfo['query+' + key]
else:
raise KeyError(key)
def __contains__(self, key):
"""Return whether the key is valid."""
try:
self[key]
return True
except KeyError:
return False
def __len__(self):
"""Return number of cached modules."""
return len(self._paraminfo)
def parameter(self, module, param_name):
"""
Get details about one modules parameter.
Returns None if the parameter does not exist.
@param module: API module name
@type module: str
@param param_name: parameter name in the module
@type param_name: str
@return: metadata that describes how the parameter may be used
@rtype: dict or None
"""
# TODO: the 'description' field of each parameter is not in the default
# output of v1.25, and can't removed from previous API versions.
# There should be an option to remove this verbose data from the cached
# version, for earlier versions of the API, and/or extract any useful
# data and discard the entire received paraminfo structure. There are
# also params which are common to many modules, such as those provided
# by the ApiPageSet php class: titles, pageids, redirects, etc.
try:
module = self[module]
except KeyError:
raise ValueError("paraminfo for '%s' not loaded" % module)
try:
params = module['parameters']
except KeyError:
pywikibot.warning("module '{}' has no parameters".format(module))
return None
param_data = [param for param in params
if param['name'] == param_name]
if not param_data:
return None
assert(len(param_data) == 1)
return param_data[0]
@property
@deprecated('submodules() or module_paths', since='20150715')
def modules(self):
"""
Set of all main and query modules without path prefixes.
Modules with the same names will be only added once (e.g. 'tokens' from
the action modules and query modules).
@return: module names
@rtype: set of str
"""
return self.action_modules | self.query_modules
@property
def module_paths(self):
"""Set of all modules using their paths."""
return self._module_set(True)
# As soon as modules() is removed, module_paths and _module_set can be
# combined, so don't add any code between these two methods.
def _module_set(self, path):
# Load the submodules of all action modules available
self.fetch(self.action_modules)
modules = set(self.action_modules)
for parent_module in self._modules:
submodules = self.submodules(parent_module, path)
assert not submodules & modules or not path
modules |= submodules
return modules
@property
def action_modules(self):
"""Set of all action modules."""
self._init()
return self._action_modules
@property
def query_modules(self):
"""Set of all query module names without query+ path prefix."""
return self.submodules('query')
def submodules(self, name, path=False):
"""
Set of all submodules.
@param name: The name of the parent module.
@type name: str
@param path: Whether the path and not the name is returned.
@type path: bool
@return: The names or paths of the submodules.
@rtype: set
"""
if name not in self._modules:
self.fetch([name])
submodules = self._modules[name]
if path:
submodules = self._prefix_submodules(submodules, name)
return submodules
@staticmethod
def _prefix_submodules(modules, prefix):
"""Prefix submodules with path."""
return {'{0}+{1}'.format(prefix, mod) for mod in modules}
@property
@deprecated('prefix_map', since='20150715')
def prefixes(self):
"""
Mapping of module to its prefix for all modules with a prefix.
This loads paraminfo for all modules.
"""
if not self._prefixes:
self._prefixes = self.module_attribute_map('prefix')
return self._prefixes
@property
def prefix_map(self):
"""
Mapping of module to its prefix for all modules with a prefix.
This loads paraminfo for all modules.
"""
if not self._prefix_map:
self._prefix_map = {module: prefix
for module, prefix
in self.attributes('prefix').items()
if prefix}
return self._prefix_map.copy()
def attributes(self, attribute, modules=None):
"""
Mapping of modules with an attribute to the attribute value.
It will include all modules which have that attribute set, also if that
attribute is empty or set to False.
@param attribute: attribute name
@type attribute: basestring
@param modules: modules to include. If None (default), it'll load all
modules including all submodules using the paths.
@type modules: set or None
@rtype: dict using modules as keys
"""
if modules is None:
modules = self.module_paths
self.fetch(modules)
return {mod: self[mod][attribute]
for mod in modules if attribute in self[mod]}
@deprecated('attributes', since='20150715')
def module_attribute_map(self, attribute, modules=None):
"""
Mapping of modules with an attribute to the attribute value.
@param attribute: attribute name
@type attribute: basestring
@param modules: modules to include. If None (default) it'll load all
action and query modules using the module names. It only uses the
path for query modules which have the same name as an action
module.
@type modules: set
@rtype: dict using modules as keys
"""
if modules is None:
modules = self.modules | self._prefix_submodules(
self.query_modules & self.action_modules, 'query')
self.fetch(modules)
return {mod: self[mod][attribute]
for mod in modules if self[mod][attribute]}
@property
@deprecated('parameter()', since='20150905')
def query_modules_with_limits(self):
"""Set of all query modules which have limits."""
if not self._with_limits:
self.fetch(self.submodules('query', True))
self._with_limits = frozenset(
mod for mod in self.query_modules
if self.parameter('query+' + mod, 'limit'))
return self._with_limits
class OptionSet(MutableMapping):
"""
A class to store a set of options which can be either enabled or not.
If it is instantiated with the associated site, module and parameter it
will only allow valid names as options. If instantiated 'lazy loaded' it
won't checks if the names are valid until the site has been set (which
isn't required, but recommended). The site can only be set once if it's not
None and after setting it, any site (even None) will fail.
"""
def __init__(self, site=None, module=None, param=None, dict=None):
"""
Initializer.
If a site is given, the module and param must be given too.
@param site: The associated site
@type site: piwikibot.site.APISite
@param module: The module name which is used by paraminfo. (Ignored
when site is None)
@type module: str
@param param: The parameter name inside the module. That parameter must
have a 'type' entry. (Ignored when site is None)
@type param: str
@param dict: The initializing dict which is used for L{from_dict}.
@type dict: dict
"""
self._site_set = False
self._enabled = set()
self._disabled = set()
self._set_site(site, module, param)
if dict:
self.from_dict(dict)
def _set_site(self, site, module, param, clear_invalid=False):
"""
Set the site and valid names.
As soon as the site has been not None, any subsequent calls will fail,
unless there had been invalid names and a KeyError was thrown.
@param site: The associated site
@type site: pywikibot.site.APISite
@param module: The module name which is used by paraminfo.
@type module: str
@param param: The parameter name inside the module. That parameter must
have a 'type' entry.
@type param: str
@param clear_invalid: Instead of throwing a KeyError, invalid names are
silently removed from the options (disabled by default).
@type clear_invalid: bool
"""
if self._site_set:
raise TypeError('The site can not be set multiple times.')
# If the entries written to this are valid, it will never be
# overwritten
self._valid_enable = set()
self._valid_disable = set()
if site is None:
return
for type in site._paraminfo.parameter(module, param)['type']:
if type[0] == '!':
self._valid_disable.add(type[1:])
else:
self._valid_enable.add(type)
if clear_invalid:
self._enabled &= self._valid_enable
self._disabled &= self._valid_disable
else:
invalid_names = ((self._enabled - self._valid_enable)
| (self._disabled - self._valid_disable))
if invalid_names:
raise KeyError('OptionSet already contains invalid name(s) '
'"{0}"'.format('", "'.join(invalid_names)))
self._site_set = True
def from_dict(self, dict):
"""
Load options from the dict.
The options are not cleared before. If changes have been made
previously, but only the dict values should be applied it needs to be
cleared first.
@param dict: A dictionary containing for each entry either the value
False, True or None. The names must be valid depending on whether
they enable or disable the option. All names with the value None
can be in either of the list.
@type dict: dict (keys are strings, values are bool/None)
"""
enabled = set()
disabled = set()
removed = set()
for name, value in dict.items():
if value is True:
enabled.add(name)
elif value is False:
disabled.add(name)
elif value is None:
removed.add(name)
else:
raise ValueError('Dict contains invalid value "{0}"'.format(
value))
invalid_names = (
(enabled - self._valid_enable) | (disabled - self._valid_disable)
| (removed - self._valid_enable - self._valid_disable)
)
if invalid_names and self._site_set:
raise ValueError('Dict contains invalid name(s) "{0}"'.format(
'", "'.join(invalid_names)))
self._enabled = enabled | (self._enabled - disabled - removed)
self._disabled = disabled | (self._disabled - enabled - removed)
def clear(self):
"""Clear all enabled and disabled options."""
self._enabled.clear()
self._disabled.clear()
def __setitem__(self, name, value):
"""Set option to enabled, disabled or neither."""
if value is True:
if self._site_set and name not in self._valid_enable:
raise KeyError('Invalid name "{0}"'.format(name))
self._enabled.add(name)
self._disabled.discard(name)
elif value is False:
if self._site_set and name not in self._valid_disable:
raise KeyError('Invalid name "{0}"'.format(name))
self._disabled.add(name)
self._enabled.discard(name)
elif value is None:
if self._site_set and (name not in self._valid_enable
or name not in self._valid_disable):
raise KeyError('Invalid name "{0}"'.format(name))
self._enabled.discard(name)
self._disabled.discard(name)
else:
raise ValueError('Invalid value "{0}"'.format(value))