-
Notifications
You must be signed in to change notification settings - Fork 793
/
genpy.py
1401 lines (1284 loc) · 54.4 KB
/
genpy.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
"""genpy.py - The worker for makepy. See makepy.py for more details
This code was moved simply to speed Python in normal circumstances. As the makepy.py
is normally run from the command line, it reparses the code each time. Now makepy
is nothing more than the command line handler and public interface.
The makepy command line etc handling is also getting large enough in its own right!
"""
# NOTE - now supports a "demand" mechanism - the top-level is a package, and
# each class etc can be made individually.
# This should eventually become the default.
# Then the old non-package technique should be removed.
# There should be no b/w compat issues, and will just help clean the code.
# This will be done once the new "demand" mechanism gets a good workout.
import os
import sys
import time
import pythoncom
import win32com
from . import build
error = "makepy.error"
makepy_version = "0.5.01" # Written to generated file.
GEN_FULL = "full"
GEN_DEMAND_BASE = "demand(base)"
GEN_DEMAND_CHILD = "demand(child)"
# This map is used purely for the users benefit -it shows the
# raw, underlying type of Alias/Enums, etc. The COM implementation
# does not use this map at runtime - all Alias/Enum have already
# been translated.
mapVTToTypeString = {
pythoncom.VT_I2: "int",
pythoncom.VT_I4: "int",
pythoncom.VT_R4: "float",
pythoncom.VT_R8: "float",
pythoncom.VT_BSTR: "str",
pythoncom.VT_BOOL: "int",
pythoncom.VT_VARIANT: "type",
pythoncom.VT_I1: "int",
pythoncom.VT_UI1: "int",
pythoncom.VT_UI2: "int",
pythoncom.VT_UI4: "int",
pythoncom.VT_I8: "int",
pythoncom.VT_UI8: "int",
pythoncom.VT_INT: "int",
pythoncom.VT_DATE: "datetime.date",
pythoncom.VT_UINT: "int",
}
# Given a propget function's arg desc, return the default parameters for all
# params bar the first. Eg, then Python does a:
# object.Property = "foo"
# Python can only pass the "foo" value. If the property has
# multiple args, and the rest have default values, this allows
# Python to correctly pass those defaults.
def MakeDefaultArgsForPropertyPut(argsDesc):
ret = []
for desc in argsDesc[1:]:
default = build.MakeDefaultArgRepr(desc)
if default is None:
break
ret.append(default)
return tuple(ret)
def MakeMapLineEntry(dispid, wFlags, retType, argTypes, user, resultCLSID):
# Strip the default value
argTypes = tuple([what[:2] for what in argTypes])
return '(%s, %d, %s, %s, "%s", %s)' % (
dispid,
wFlags,
retType[:2],
argTypes,
user,
resultCLSID,
)
def MakeEventMethodName(eventName):
if eventName[:2] == "On":
return eventName
else:
return "On" + eventName
def WriteSinkEventMap(obj, stream):
print("\t_dispid_to_func_ = {", file=stream)
for name, entry in (
list(obj.propMapGet.items())
+ list(obj.propMapPut.items())
+ list(obj.mapFuncs.items())
):
fdesc = entry.desc
print(
'\t\t%9d : "%s",' % (fdesc.memid, MakeEventMethodName(entry.names[0])),
file=stream,
)
print("\t\t}", file=stream)
# MI is used to join my writable helpers, and the OLE
# classes.
class WritableItem:
def __lt__(self, other):
if self.order == other.order:
return self.doc < other.doc
return self.order < other.order
def __repr__(self):
return "OleItem: doc=%s, order=%d" % (repr(self.doc), self.order)
class RecordItem(build.OleItem, WritableItem):
order = 9
typename = "RECORD"
def __init__(self, typeInfo, typeAttr, doc=None, bForUser=1):
## sys.stderr.write("Record %s: size %s\n" % (doc,typeAttr.cbSizeInstance))
## sys.stderr.write(" cVars = %s\n" % (typeAttr.cVars,))
## for i in range(typeAttr.cVars):
## vdesc = typeInfo.GetVarDesc(i)
## sys.stderr.write(" Var %d has value %s, type %d, desc=%s\n" % (i, vdesc.value, vdesc.varkind, vdesc.elemdescVar))
## sys.stderr.write(" Doc is %s\n" % (typeInfo.GetDocumentation(vdesc.memid),))
build.OleItem.__init__(self, doc)
self.clsid = typeAttr[0]
def WriteClass(self, generator):
pass
# Given an enum, write all aliases for it.
# (no longer necessary for new style code, but still used for old code.
def WriteAliasesForItem(item, aliasItems, stream):
for alias in aliasItems.values():
if item.doc and alias.aliasDoc and (alias.aliasDoc[0] == item.doc[0]):
alias.WriteAliasItem(aliasItems, stream)
class AliasItem(build.OleItem, WritableItem):
order = 2
typename = "ALIAS"
def __init__(self, typeinfo, attr, doc=None, bForUser=1):
build.OleItem.__init__(self, doc)
ai = attr[14]
self.attr = attr
# XXX - This is a hack - why tuples? Need to resolve?
if isinstance(ai, tuple) and isinstance(ai[1], int):
href = ai[1]
alinfo = typeinfo.GetRefTypeInfo(href)
self.aliasDoc = alinfo.GetDocumentation(-1)
self.aliasAttr = alinfo.GetTypeAttr()
else:
self.aliasDoc = None
self.aliasAttr = None
def WriteAliasItem(self, aliasDict, stream):
# we could have been written as part of an alias dependency
if self.bWritten:
return
if self.aliasDoc:
depName = self.aliasDoc[0]
if depName in aliasDict:
aliasDict[depName].WriteAliasItem(aliasDict, stream)
print(self.doc[0] + " = " + depName, file=stream)
else:
ai = self.attr[14]
if isinstance(ai, int):
try:
typeStr = mapVTToTypeString[ai]
print("# %s=%s" % (self.doc[0], typeStr), file=stream)
except KeyError:
print(
self.doc[0] + " = None # Can't convert alias info " + str(ai),
file=stream,
)
print(file=stream)
self.bWritten = 1
class EnumerationItem(build.OleItem, WritableItem):
order = 1
typename = "ENUMERATION"
def __init__(self, typeinfo, attr, doc=None, bForUser=1):
build.OleItem.__init__(self, doc)
self.clsid = attr[0]
self.mapVars = {}
typeFlags = attr[11]
self.hidden = (
typeFlags & pythoncom.TYPEFLAG_FHIDDEN
or typeFlags & pythoncom.TYPEFLAG_FRESTRICTED
)
for j in range(attr[7]):
vdesc = typeinfo.GetVarDesc(j)
name = typeinfo.GetNames(vdesc[0])[0]
self.mapVars[name] = build.MapEntry(vdesc)
## def WriteEnumerationHeaders(self, aliasItems, stream):
## enumName = self.doc[0]
## print >> stream "%s=constants # Compatibility with previous versions." % (enumName)
## WriteAliasesForItem(self, aliasItems)
def WriteEnumerationItems(self, stream):
num = 0
enumName = self.doc[0]
# Write in name alpha order
names = list(self.mapVars.keys())
names.sort()
for name in names:
entry = self.mapVars[name]
vdesc = entry.desc
if vdesc[4] == pythoncom.VAR_CONST:
val = vdesc[1]
use = repr(val)
# Make sure the repr of the value is valid python syntax
# still could cause an error on import if it contains a module or type name
# not available in the global namespace
try:
compile(use, "<makepy>", "eval")
except SyntaxError:
# At least add the repr as a string, so it can be investigated further
# Sanitize it, in case the repr contains its own quotes. (??? line breaks too ???)
use = use.replace('"', "'")
use = (
'"'
+ use
+ '"'
+ " # This VARIANT type cannot be converted automatically"
)
print(
"\t%-30s=%-10s # from enum %s"
% (build.MakePublicAttributeName(name, True), use, enumName),
file=stream,
)
num += 1
return num
class VTableItem(build.VTableItem, WritableItem):
order = 4
def WriteClass(self, generator):
self.WriteVTableMap(generator)
self.bWritten = 1
def WriteVTableMap(self, generator):
stream = generator.file
print(
"%s_vtables_dispatch_ = %d" % (self.python_name, self.bIsDispatch),
file=stream,
)
print("%s_vtables_ = [" % (self.python_name,), file=stream)
for v in self.vtableFuncs:
names, dispid, desc = v
assert desc.desckind == pythoncom.DESCKIND_FUNCDESC
arg_reprs = []
# more hoops so we don't generate huge lines.
item_num = 0
print("\t((", end=" ", file=stream)
for name in names:
print(repr(name), ",", end=" ", file=stream)
item_num = item_num + 1
if item_num % 5 == 0:
print("\n\t\t\t", end=" ", file=stream)
print(
"), %d, (%r, %r, [" % (dispid, desc.memid, desc.scodeArray),
end=" ",
file=stream,
)
for arg in desc.args:
item_num = item_num + 1
if item_num % 5 == 0:
print("\n\t\t\t", end=" ", file=stream)
defval = build.MakeDefaultArgRepr(arg)
if arg[3] is None:
arg3_repr = None
else:
arg3_repr = repr(arg[3])
print(
repr((arg[0], arg[1], defval, arg3_repr)), ",", end=" ", file=stream
)
print("],", end=" ", file=stream)
print(repr(desc.funckind), ",", end=" ", file=stream)
print(repr(desc.invkind), ",", end=" ", file=stream)
print(repr(desc.callconv), ",", end=" ", file=stream)
print(repr(desc.cParamsOpt), ",", end=" ", file=stream)
print(repr(desc.oVft), ",", end=" ", file=stream)
print(repr(desc.rettype), ",", end=" ", file=stream)
print(repr(desc.wFuncFlags), ",", end=" ", file=stream)
print(")),", file=stream)
print("]", file=stream)
print(file=stream)
class DispatchItem(build.DispatchItem, WritableItem):
order = 3
def __init__(self, typeinfo, attr, doc=None):
build.DispatchItem.__init__(self, typeinfo, attr, doc)
self.type_attr = attr
self.coclass_clsid = None
def WriteClass(self, generator):
if (
not self.bIsDispatch
and not self.type_attr.typekind == pythoncom.TKIND_DISPATCH
):
return
# This is pretty screwey - now we have vtable support we
# should probably rethink this (ie, maybe write both sides for sinks, etc)
if self.bIsSink:
self.WriteEventSinkClassHeader(generator)
self.WriteCallbackClassBody(generator)
else:
self.WriteClassHeader(generator)
self.WriteClassBody(generator)
print(file=generator.file)
self.bWritten = 1
def WriteClassHeader(self, generator):
generator.checkWriteDispatchBaseClass()
doc = self.doc
stream = generator.file
print("class " + self.python_name + "(DispatchBaseClass):", file=stream)
if doc[1]:
print("\t" + build._makeDocString(doc[1]), file=stream)
try:
progId = pythoncom.ProgIDFromCLSID(self.clsid)
print(
"\t# This class is creatable by the name '%s'" % (progId), file=stream
)
except pythoncom.com_error:
pass
print("\tCLSID = " + repr(self.clsid), file=stream)
if self.coclass_clsid is None:
print("\tcoclass_clsid = None", file=stream)
else:
print("\tcoclass_clsid = " + repr(self.coclass_clsid), file=stream)
print(file=stream)
self.bWritten = 1
def WriteEventSinkClassHeader(self, generator):
generator.checkWriteEventBaseClass()
doc = self.doc
stream = generator.file
print("class " + self.python_name + ":", file=stream)
if doc[1]:
print("\t" + build._makeDocString(doc[1]), file=stream)
try:
progId = pythoncom.ProgIDFromCLSID(self.clsid)
print(
"\t# This class is creatable by the name '%s'" % (progId), file=stream
)
except pythoncom.com_error:
pass
print("\tCLSID = CLSID_Sink = " + repr(self.clsid), file=stream)
if self.coclass_clsid is None:
print("\tcoclass_clsid = None", file=stream)
else:
print("\tcoclass_clsid = " + repr(self.coclass_clsid), file=stream)
print("\t_public_methods_ = [] # For COM Server support", file=stream)
WriteSinkEventMap(self, stream)
print(file=stream)
print("\tdef __init__(self, oobj = None):", file=stream)
print("\t\tif oobj is None:", file=stream)
print("\t\t\tself._olecp = None", file=stream)
print("\t\telse:", file=stream)
print("\t\t\timport win32com.server.util", file=stream)
print(
"\t\t\tfrom win32com.server.policy import EventHandlerPolicy", file=stream
)
print(
"\t\t\tcpc=oobj._oleobj_.QueryInterface(pythoncom.IID_IConnectionPointContainer)",
file=stream,
)
print("\t\t\tcp=cpc.FindConnectionPoint(self.CLSID_Sink)", file=stream)
print(
"\t\t\tcookie=cp.Advise(win32com.server.util.wrap(self, usePolicy=EventHandlerPolicy))",
file=stream,
)
print("\t\t\tself._olecp,self._olecp_cookie = cp,cookie", file=stream)
print("\tdef __del__(self):", file=stream)
print("\t\ttry:", file=stream)
print("\t\t\tself.close()", file=stream)
print("\t\texcept pythoncom.com_error:", file=stream)
print("\t\t\tpass", file=stream)
print("\tdef close(self):", file=stream)
print("\t\tif self._olecp is not None:", file=stream)
print(
"\t\t\tcp,cookie,self._olecp,self._olecp_cookie = self._olecp,self._olecp_cookie,None,None",
file=stream,
)
print("\t\t\tcp.Unadvise(cookie)", file=stream)
print("\tdef _query_interface_(self, iid):", file=stream)
print("\t\timport win32com.server.util", file=stream)
print(
"\t\tif iid==self.CLSID_Sink: return win32com.server.util.wrap(self)",
file=stream,
)
print(file=stream)
self.bWritten = 1
def WriteCallbackClassBody(self, generator):
stream = generator.file
print("\t# Event Handlers", file=stream)
print(
"\t# If you create handlers, they should have the following prototypes:",
file=stream,
)
for name, entry in (
list(self.propMapGet.items())
+ list(self.propMapPut.items())
+ list(self.mapFuncs.items())
):
fdesc = entry.desc
methName = MakeEventMethodName(entry.names[0])
print(
"#\tdef "
+ methName
+ "(self"
+ build.BuildCallList(
fdesc,
entry.names,
"defaultNamedOptArg",
"defaultNamedNotOptArg",
"defaultUnnamedArg",
"pythoncom.Missing",
is_comment=True,
)
+ "):",
file=stream,
)
if entry.doc and entry.doc[1]:
print("#\t\t" + build._makeDocString(entry.doc[1]), file=stream)
print(file=stream)
self.bWritten = 1
def WriteClassBody(self, generator):
stream = generator.file
# Write in alpha order.
names = list(self.mapFuncs.keys())
names.sort()
specialItems = {
"count": None,
"item": None,
"value": None,
"_newenum": None,
} # If found, will end up with (entry, invoke_tupe)
itemCount = None
for name in names:
entry = self.mapFuncs[name]
assert entry.desc.desckind == pythoncom.DESCKIND_FUNCDESC
# skip [restricted] methods, unless it is the
# enumerator (which, being part of the "system",
# we know about and can use)
dispid = entry.desc.memid
if (
entry.desc.wFuncFlags & pythoncom.FUNCFLAG_FRESTRICTED
and dispid != pythoncom.DISPID_NEWENUM
):
continue
# If not accessible via IDispatch, then we can't use it here.
if entry.desc.funckind != pythoncom.FUNC_DISPATCH:
continue
if dispid == pythoncom.DISPID_VALUE:
lkey = "value"
elif dispid == pythoncom.DISPID_NEWENUM:
specialItems["_newenum"] = (entry, entry.desc.invkind, None)
continue # Dont build this one now!
else:
lkey = name.lower()
if (
lkey in specialItems and specialItems[lkey] is None
): # remember if a special one.
specialItems[lkey] = (entry, entry.desc.invkind, None)
if generator.bBuildHidden or not entry.hidden:
if entry.GetResultName():
print("\t# Result is of type " + entry.GetResultName(), file=stream)
if entry.wasProperty:
print(
"\t# The method %s is actually a property, but must be used as a method to correctly pass the arguments"
% name,
file=stream,
)
ret = self.MakeFuncMethod(entry, build.MakePublicAttributeName(name))
for line in ret:
print(line, file=stream)
print("\t_prop_map_get_ = {", file=stream)
names = list(self.propMap.keys())
names.sort()
for key in names:
entry = self.propMap[key]
if generator.bBuildHidden or not entry.hidden:
resultName = entry.GetResultName()
if resultName:
print(
"\t\t# Property '%s' is an object of type '%s'"
% (key, resultName),
file=stream,
)
lkey = key.lower()
details = entry.desc
resultDesc = details[2]
argDesc = ()
mapEntry = MakeMapLineEntry(
details.memid,
pythoncom.DISPATCH_PROPERTYGET,
resultDesc,
argDesc,
key,
entry.GetResultCLSIDStr(),
)
if details.memid == pythoncom.DISPID_VALUE:
lkey = "value"
elif details.memid == pythoncom.DISPID_NEWENUM:
lkey = "_newenum"
else:
lkey = key.lower()
if (
lkey in specialItems and specialItems[lkey] is None
): # remember if a special one.
specialItems[lkey] = (
entry,
pythoncom.DISPATCH_PROPERTYGET,
mapEntry,
)
# All special methods, except _newenum, are written
# "normally". This is a mess!
if details.memid == pythoncom.DISPID_NEWENUM:
continue
print(
'\t\t"%s": %s,' % (build.MakePublicAttributeName(key), mapEntry),
file=stream,
)
names = list(self.propMapGet.keys())
names.sort()
for key in names:
entry = self.propMapGet[key]
if generator.bBuildHidden or not entry.hidden:
if entry.GetResultName():
print(
"\t\t# Method '%s' returns object of type '%s'"
% (key, entry.GetResultName()),
file=stream,
)
details = entry.desc
assert details.desckind == pythoncom.DESCKIND_FUNCDESC
lkey = key.lower()
argDesc = details[2]
resultDesc = details[8]
mapEntry = MakeMapLineEntry(
details[0],
pythoncom.DISPATCH_PROPERTYGET,
resultDesc,
argDesc,
key,
entry.GetResultCLSIDStr(),
)
if details.memid == pythoncom.DISPID_VALUE:
lkey = "value"
elif details.memid == pythoncom.DISPID_NEWENUM:
lkey = "_newenum"
else:
lkey = key.lower()
if (
lkey in specialItems and specialItems[lkey] is None
): # remember if a special one.
specialItems[lkey] = (
entry,
pythoncom.DISPATCH_PROPERTYGET,
mapEntry,
)
# All special methods, except _newenum, are written
# "normally". This is a mess!
if details.memid == pythoncom.DISPID_NEWENUM:
continue
print(
'\t\t"%s": %s,' % (build.MakePublicAttributeName(key), mapEntry),
file=stream,
)
print("\t}", file=stream)
print("\t_prop_map_put_ = {", file=stream)
# These are "Invoke" args
names = list(self.propMap.keys())
names.sort()
for key in names:
entry = self.propMap[key]
if generator.bBuildHidden or not entry.hidden:
lkey = key.lower()
details = entry.desc
# If default arg is None, write an empty tuple
defArgDesc = build.MakeDefaultArgRepr(details[2])
if defArgDesc is None:
defArgDesc = ""
else:
defArgDesc = defArgDesc + ","
print(
'\t\t"%s" : ((%s, LCID, %d, 0),(%s)),'
% (
build.MakePublicAttributeName(key),
details[0],
pythoncom.DISPATCH_PROPERTYPUT,
defArgDesc,
),
file=stream,
)
names = list(self.propMapPut.keys())
names.sort()
for key in names:
entry = self.propMapPut[key]
if generator.bBuildHidden or not entry.hidden:
details = entry.desc
defArgDesc = MakeDefaultArgsForPropertyPut(details[2])
print(
'\t\t"%s": ((%s, LCID, %d, 0),%s),'
% (
build.MakePublicAttributeName(key),
details[0],
details[4],
defArgDesc,
),
file=stream,
)
print("\t}", file=stream)
if specialItems["value"]:
entry, invoketype, propArgs = specialItems["value"]
if propArgs is None:
typename = "method"
ret = self.MakeFuncMethod(entry, "__call__")
else:
typename = "property"
ret = [
"\tdef __call__(self):\n\t\treturn self._ApplyTypes_(*%s)"
% propArgs
]
print(
"\t# Default %s for this class is '%s'" % (typename, entry.names[0]),
file=stream,
)
for line in ret:
print(line, file=stream)
print("\tdef __str__(self, *args):", file=stream)
print("\t\treturn str(self.__call__(*args))", file=stream)
print("\tdef __int__(self, *args):", file=stream)
print("\t\treturn int(self.__call__(*args))", file=stream)
# _NewEnum (DISPID_NEWENUM) does not appear in typelib for many office objects,
# but it can still be retrieved at runtime, so always create __iter__.
# Also, some of those same objects use 1-based indexing, causing the old-style
# __getitem__ iteration to fail for index 0 where the dynamic iteration succeeds.
if specialItems["_newenum"]:
enumEntry, invoketype, propArgs = specialItems["_newenum"]
assert enumEntry.desc.desckind == pythoncom.DESCKIND_FUNCDESC
invkind = enumEntry.desc.invkind
# ??? Wouldn't this be the resultCLSID for the iterator itself, rather than the resultCLSID
# for the result of each Next() call, which is what it's used for ???
resultCLSID = enumEntry.GetResultCLSIDStr()
else:
invkind = pythoncom.DISPATCH_METHOD | pythoncom.DISPATCH_PROPERTYGET
resultCLSID = "None"
# If we dont have a good CLSID for the enum result, assume it is the same as the Item() method.
if resultCLSID == "None" and "Item" in self.mapFuncs:
resultCLSID = self.mapFuncs["Item"].GetResultCLSIDStr()
print("\tdef __iter__(self):", file=stream)
print('\t\t"Return a Python iterator for this object"', file=stream)
print("\t\ttry:", file=stream)
print(
"\t\t\tob = self._oleobj_.InvokeTypes(%d,LCID,%d,(13, 10),())"
% (pythoncom.DISPID_NEWENUM, invkind),
file=stream,
)
print("\t\texcept pythoncom.error:", file=stream)
print(
'\t\t\traise TypeError("This object does not support enumeration")',
file=stream,
)
# Iterator is wrapped as PyIEnumVariant, and each result of __next__ is Dispatch'ed if necessary
print(
"\t\treturn win32com.client.util.Iterator(ob, %s)" % resultCLSID,
file=stream,
)
if specialItems["item"]:
entry, invoketype, propArgs = specialItems["item"]
resultCLSID = entry.GetResultCLSIDStr()
print(
"\t#This class has Item property/method which allows indexed access with the object[key] syntax.",
file=stream,
)
print(
"\t#Some objects will accept a string or other type of key in addition to integers.",
file=stream,
)
print(
"\t#Note that many Office objects do not use zero-based indexing.",
file=stream,
)
print("\tdef __getitem__(self, key):", file=stream)
print(
'\t\treturn self._get_good_object_(self._oleobj_.Invoke(*(%d, LCID, %d, 1, key)), "Item", %s)'
% (entry.desc.memid, invoketype, resultCLSID),
file=stream,
)
if specialItems["count"]:
entry, invoketype, propArgs = specialItems["count"]
if propArgs is None:
typename = "method"
ret = self.MakeFuncMethod(entry, "__len__")
else:
typename = "property"
ret = [
"\tdef __len__(self):\n\t\treturn self._ApplyTypes_(*%s)" % propArgs
]
print(
"\t#This class has Count() %s - allow len(ob) to provide this"
% (typename),
file=stream,
)
for line in ret:
print(line, file=stream)
# Also include a __bool__
print(
"\t#This class has a __len__ - this is needed so 'if object:' always returns TRUE.",
file=stream,
)
print("\tdef __bool__(self):", file=stream)
print("\t\treturn True", file=stream)
class CoClassItem(build.OleItem, WritableItem):
order = 5
typename = "COCLASS"
def __init__(self, typeinfo, attr, doc=None, sources=[], interfaces=[], bForUser=1):
build.OleItem.__init__(self, doc)
self.clsid = attr[0]
self.sources = sources
self.interfaces = interfaces
self.bIsDispatch = 1 # Pretend it is so it is written to the class map.
def WriteClass(self, generator):
generator.checkWriteCoClassBaseClass()
doc = self.doc
stream = generator.file
if generator.generate_type == GEN_DEMAND_CHILD:
# Some special imports we must setup.
referenced_items = []
for ref, flag in self.sources:
referenced_items.append(ref)
for ref, flag in self.interfaces:
referenced_items.append(ref)
print("import sys", file=stream)
for ref in referenced_items:
print(
"__import__('%s.%s')" % (generator.base_mod_name, ref.python_name),
file=stream,
)
print(
"%s = sys.modules['%s.%s'].%s"
% (
ref.python_name,
generator.base_mod_name,
ref.python_name,
ref.python_name,
),
file=stream,
)
# And pretend we have written it - the name is now available as if we had!
ref.bWritten = 1
try:
progId = pythoncom.ProgIDFromCLSID(self.clsid)
print("# This CoClass is known by the name '%s'" % (progId), file=stream)
except pythoncom.com_error:
pass
print(
"class %s(CoClassBaseClass): # A CoClass" % (self.python_name), file=stream
)
if doc and doc[1]:
print("\t# " + doc[1], file=stream)
print("\tCLSID = %r" % (self.clsid,), file=stream)
print("\tcoclass_sources = [", file=stream)
defItem = None
for item, flag in self.sources:
if flag & pythoncom.IMPLTYPEFLAG_FDEFAULT:
defItem = item
# If we have written a Python class, reference the name -
# otherwise just the IID.
if item.bWritten:
key = item.python_name
else:
key = repr(str(item.clsid)) # really the iid.
print("\t\t%s," % (key), file=stream)
print("\t]", file=stream)
if defItem:
if defItem.bWritten:
defName = defItem.python_name
else:
defName = repr(str(defItem.clsid)) # really the iid.
print("\tdefault_source = %s" % (defName,), file=stream)
print("\tcoclass_interfaces = [", file=stream)
defItem = None
for item, flag in self.interfaces:
if flag & pythoncom.IMPLTYPEFLAG_FDEFAULT: # and dual:
defItem = item
# If we have written a class, reference its name, otherwise the IID
if item.bWritten:
key = item.python_name
else:
key = repr(str(item.clsid)) # really the iid.
print("\t\t%s," % (key,), file=stream)
print("\t]", file=stream)
if defItem:
if defItem.bWritten:
defName = defItem.python_name
else:
defName = repr(str(defItem.clsid)) # really the iid.
print("\tdefault_interface = %s" % (defName,), file=stream)
self.bWritten = 1
print(file=stream)
class GeneratorProgress:
def __init__(self):
pass
def Starting(self, tlb_desc):
"""Called when the process starts."""
self.tlb_desc = tlb_desc
def Finished(self):
"""Called when the process is complete."""
def SetDescription(self, desc, maxticks=None):
"""We are entering a major step. If maxticks, then this
is how many ticks we expect to make until finished
"""
def Tick(self, desc=None):
"""Minor progress step. Can provide new description if necessary"""
def VerboseProgress(self, desc):
"""Verbose/Debugging output."""
def LogWarning(self, desc):
"""If a warning is generated"""
def LogBeginGenerate(self, filename):
pass
def Close(self):
pass
class Generator:
def __init__(
self,
typelib,
sourceFilename,
progressObject,
bBuildHidden=1,
bUnicodeToString=None,
):
assert bUnicodeToString is None, "this is deprecated and will go away"
self.bHaveWrittenDispatchBaseClass = 0
self.bHaveWrittenCoClassBaseClass = 0
self.bHaveWrittenEventBaseClass = 0
self.typelib = typelib
self.sourceFilename = sourceFilename
self.bBuildHidden = bBuildHidden
self.progress = progressObject
# These 2 are later additions and most of the code still 'print's...
self.file = None
def CollectOleItemInfosFromType(self):
ret = []
for i in range(self.typelib.GetTypeInfoCount()):
info = self.typelib.GetTypeInfo(i)
infotype = self.typelib.GetTypeInfoType(i)
doc = self.typelib.GetDocumentation(i)
attr = info.GetTypeAttr()
ret.append((info, infotype, doc, attr))
return ret
def _Build_CoClass(self, type_info_tuple):
info, infotype, doc, attr = type_info_tuple
# find the source and dispinterfaces for the coclass
child_infos = []
for j in range(attr[8]):
flags = info.GetImplTypeFlags(j)
try:
refType = info.GetRefTypeInfo(info.GetRefTypeOfImplType(j))
except pythoncom.com_error:
# Can't load a dependent typelib?
continue
refAttr = refType.GetTypeAttr()
child_infos.append(
(
info,
refAttr.typekind,
refType,
refType.GetDocumentation(-1),
refAttr,
flags,
)
)
# Done generating children - now the CoClass itself.
newItem = CoClassItem(info, attr, doc)
return newItem, child_infos
def _Build_CoClassChildren(self, coclass, coclass_info, oleItems, vtableItems):
sources = {}
interfaces = {}
for info, info_type, refType, doc, refAttr, flags in coclass_info:
# sys.stderr.write("Attr typeflags for coclass referenced object %s=%d (%d), typekind=%d\n" % (name, refAttr.wTypeFlags, refAttr.wTypeFlags & pythoncom.TYPEFLAG_FDUAL,refAttr.typekind))
if refAttr.typekind == pythoncom.TKIND_DISPATCH or (
refAttr.typekind == pythoncom.TKIND_INTERFACE
and refAttr[11] & pythoncom.TYPEFLAG_FDISPATCHABLE
):
clsid = refAttr[0]
if clsid in oleItems:
dispItem = oleItems[clsid]
else:
dispItem = DispatchItem(refType, refAttr, doc)
oleItems[dispItem.clsid] = dispItem
dispItem.coclass_clsid = coclass.clsid
if flags & pythoncom.IMPLTYPEFLAG_FSOURCE:
dispItem.bIsSink = 1
sources[dispItem.clsid] = (dispItem, flags)
else:
interfaces[dispItem.clsid] = (dispItem, flags)
# If dual interface, make do that too.
if clsid not in vtableItems and refAttr[11] & pythoncom.TYPEFLAG_FDUAL:
refType = refType.GetRefTypeInfo(refType.GetRefTypeOfImplType(-1))
refAttr = refType.GetTypeAttr()
assert (
refAttr.typekind == pythoncom.TKIND_INTERFACE
), "must be interface bynow!"
vtableItem = VTableItem(refType, refAttr, doc)
vtableItems[clsid] = vtableItem
coclass.sources = list(sources.values())
coclass.interfaces = list(interfaces.values())
def _Build_Interface(self, type_info_tuple):
info, infotype, doc, attr = type_info_tuple
oleItem = vtableItem = None
if infotype == pythoncom.TKIND_DISPATCH or (
infotype == pythoncom.TKIND_INTERFACE
and attr[11] & pythoncom.TYPEFLAG_FDISPATCHABLE
):
oleItem = DispatchItem(info, attr, doc)
# If this DISPATCH interface dual, then build that too.
if attr.wTypeFlags & pythoncom.TYPEFLAG_FDUAL:
# Get the vtable interface
refhtype = info.GetRefTypeOfImplType(-1)
info = info.GetRefTypeInfo(refhtype)
attr = info.GetTypeAttr()
infotype = pythoncom.TKIND_INTERFACE
else:
infotype = None
assert infotype in [
None,
pythoncom.TKIND_INTERFACE,
], "Must be a real interface at this point"
if infotype == pythoncom.TKIND_INTERFACE:
vtableItem = VTableItem(info, attr, doc)
return oleItem, vtableItem
def BuildOleItemsFromType(self):
assert (
self.bBuildHidden
), "This code doesnt look at the hidden flag - I thought everyone set it true!?!?!"
oleItems = {}
enumItems = {}
recordItems = {}
vtableItems = {}
for type_info_tuple in self.CollectOleItemInfosFromType():
info, infotype, doc, attr = type_info_tuple
clsid = attr[0]