pyOpenVBA 3.1.0__tar.gz → 3.3.0__tar.gz

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyOpenVBA
-Version: 3.1.0
+Version: 3.3.0
 Summary: Read and write VBA macros inside Excel, Word, and PowerPoint files in pure Python, no dependencies.
 Project-URL: Homepage, https://github.com/WilliamSmithEdward/pyOpenVBA
 Project-URL: Repository, https://github.com/WilliamSmithEdward/pyOpenVBA
@@ -200,7 +200,8 @@ path controls the format:
 ```python
 from pyopenvba import ExcelFile, WordFile, PowerPointFile
 
-# Excel - macro-enabled workbook (.xlsm) or binary workbook (.xlsb)
+# Excel - macro-enabled workbook (.xlsm), binary workbook (.xlsb),
+# or add-in (.xlam)
 with ExcelFile.create_new("new_book.xlsm") as wb:
     wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlsm"\r\nEnd Sub\r\n')
     wb.save()
@@ -209,6 +210,10 @@ with ExcelFile.create_new("new_book.xlsb") as wb:
     wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlsb"\r\nEnd Sub\r\n')
     wb.save()
 
+with ExcelFile.create_new("new_addin.xlam") as wb:
+    wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlam"\r\nEnd Sub\r\n')
+    wb.save()
+
 # Word - macro-enabled document (.docm)
 with WordFile.create_new("new_doc.docm") as doc:
     doc.set_module("Module1", 'Sub Hello()\r\n    MsgBox "docm"\r\nEnd Sub\r\n')
@@ -329,7 +334,7 @@ modules, `.cls` for class modules and code-behind.
 |-----------|------------------------------|:----:|:-----:|:----------:|
 | `.xlsm`   | Macro-enabled workbook       |  yes |  yes  |    yes     |
 | `.xlsb`   | Binary workbook              |  yes |  yes  |    yes     |
-| `.xlam`   | Macro-enabled add-in         |  yes |  yes  |    no      |
+| `.xlam`   | Macro-enabled add-in         |  yes |  yes  |    yes     |
 | `.xls`    | Legacy (Excel 97-2003)       |  yes |  yes  |    no      |
 
 ### Word

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/README.md

@@ -164,7 +164,8 @@ path controls the format:
 ```python
 from pyopenvba import ExcelFile, WordFile, PowerPointFile
 
-# Excel - macro-enabled workbook (.xlsm) or binary workbook (.xlsb)
+# Excel - macro-enabled workbook (.xlsm), binary workbook (.xlsb),
+# or add-in (.xlam)
 with ExcelFile.create_new("new_book.xlsm") as wb:
     wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlsm"\r\nEnd Sub\r\n')
     wb.save()
@@ -173,6 +174,10 @@ with ExcelFile.create_new("new_book.xlsb") as wb:
     wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlsb"\r\nEnd Sub\r\n')
     wb.save()
 
+with ExcelFile.create_new("new_addin.xlam") as wb:
+    wb.set_module("Module1", 'Sub Hello()\r\n    MsgBox "xlam"\r\nEnd Sub\r\n')
+    wb.save()
+
 # Word - macro-enabled document (.docm)
 with WordFile.create_new("new_doc.docm") as doc:
     doc.set_module("Module1", 'Sub Hello()\r\n    MsgBox "docm"\r\nEnd Sub\r\n')
@@ -293,7 +298,7 @@ modules, `.cls` for class modules and code-behind.
 |-----------|------------------------------|:----:|:-----:|:----------:|
 | `.xlsm`   | Macro-enabled workbook       |  yes |  yes  |    yes     |
 | `.xlsb`   | Binary workbook              |  yes |  yes  |    yes     |
-| `.xlam`   | Macro-enabled add-in         |  yes |  yes  |    no      |
+| `.xlam`   | Macro-enabled add-in         |  yes |  yes  |    yes     |
 | `.xls`    | Legacy (Excel 97-2003)       |  yes |  yes  |    no      |
 
 ### Word

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyOpenVBA"
-version = "3.1.0"
+version = "3.3.0"
 description = "Read and write VBA macros inside Excel, Word, and PowerPoint files in pure Python, no dependencies."
 readme = "README.md"
 license = { text = "MIT" }

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/src/pyopenvba/__init__.py

@@ -204,4 +204,4 @@ __all__ = [
     "push_word",
 ]
 
-__version__ = "3.1.0"
+__version__ = "3.3.0"

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/src/pyopenvba/_templates/__init__.py

@@ -1161,3 +1161,171 @@ _EMPTY_XLSB_B85 = (
 
 EMPTY_XLSB_BYTES: bytes = zlib.decompress(base64.b85decode(_EMPTY_XLSB_B85))
 # --- end XLSB template ---
+
+# --- XLAM template (generated by bake_xlam_template.py) ---
+# Source bytes: 8400 | zlib: 7791 | base85: 9739
+_EMPTY_XLAM_B85 = (
+    "c-nn=1yEhf(k>9(-Q8V7aJS$R+%-5GC%A9i-"
+    "Gh4w9&AH!LU7j&!9755*gVcX_3HeG|Gu|Yt(mD=>+4n3Gu=J?wVL7^SX?M5D8!eC3hLp#PMi"
+    "fa6qFb&6co<OjDZxu$=%Ay-9*#d*~-m`{gb0ZZOV5Q5-"
+    "v>O*?a$pv^txU$v0JM?@0B19Na!*aMm;E@m<I65KWJ*6tBV3Vq#);Eh6}W&M54KyUAVcJay@"
+    "~J$8G?l|r`#q?g@yCr&1=b8Mx9VQA@(f07Rva)5Hj05@=@M6T2aN_F~Qa&f>G@b!j?z}$I5o"
+    "(kPBBsx6+v(VEc2hRiH6l&XQnm*QDF=sR{`J5byBy@T0B&EwIXMm;$yn_5xs4RVJv1wydr?F"
+    "guXKRSnPWS%YHv%)fl-"
+    "$oEajWE8%h9&&H2$ovqT7F>&4j&;oNFGs`t&V&J|bxaN(_#FqiPE@Y-"
+    "QQ4^(S#XCPGLUkwi>#fH%1Vnx=6sq9%>2=9I{3y3BZ<qwh3E2nc(d24*D9DpVqxh3r^T+%dS"
+    "?BoJX7?a?S@;z&;UOWsYa{ebl!C0*oTA#llO30Q@2hFN$RFcZ`egKfh!MAz8kFUdGNH#}!<O"
+    "jh5h{cBB{wK!>xUq(tWP*5l@y@{)pgBu6?Uv2I5cZD}xnD84N8$w}iUe*Q@(%C06Ve8WK2!t"
+    "sIPK&fS$rUTD1Q<mq&3`tY_6h*NrPJMwIibB@w063DY>e@;H8G*U42X*dLX~E8dZ+Zf^EOP!"
+    ">Al^<&-|(sUD=H2?9c?6K3)5EIo6Nc;-yLbF6a<S0X4R`ZD^dVDEL9;m34E-"
+    "8uVJxhm%@hXDi?5dy8L+?K{rSK#KlOxcIAn#O*fMCI=lR#b1VG1ZpBX!PW3AyG)AA@0obreg"
+    "~Dy<c!K3OgM5m(<!D+zTdsfuj?0>ycbh#QhK!cm_U(Su9I}I5)wnPFADu{rO5p{edF^63W^X"
+    "33JT+8=92@57r@ot900KY&n8Vb0Ia;j9Red93t{?MODm*0ASIy~EkG&jlo&Ta!^7wou~E-"
+    "j(c-Zn-mf7rfoM<2W1BdVKl$AXwTdB`1Q6OGk+)43IZD1~=Y;KKTGn{Gf(dE<IYkQNsQZC?>"
+    "78(xs$m~S3^=f3wfWF&tp&rh!m3zGmuLnqy)-"
+    "6zLCK_v3;@)3(%0fC=Fo3$b}#2=@fc{UEVZ&Y*5k!N^P_@2B$e%0iVP`toLcDQ;=mlB<0*1<"
+    "rxW!5JU1ZlExR%TBqd|u^)s?Lu~%4G4e^lr+w!|wbNdk~eoO*XWYiyTLa7N+e~3yGM?OeZ=;"
+    "Kz+oeUb{I(DhvN8BT|AbQV)NOYx0vkg!T@b}^T@MRbkYUsp?-6$x-"
+    "^6OnXD`}I<MkB}|p}ISXafd!?pQs^cprcAu%BjHxW>DoyP_B>#TB!LG+(@QVxqo$>pkiE3?s"
+    "f=l=^7r&SDy4sSKFq`{49J$ooZ$LP7!fH)Dt9O?;;FkGFyEzs<7Yjgn^mr*XLuKj#q~f1)Lm"
+    "g2|a&b5kr{_tOgS0H^ptn-N_v0Ey~YDhlG+q035grDUqAMTq)UEU|Qx)GAqUFED<kFuOc`p9"
+    "<Hi<?;E$q97$`Nn6=kt2(Mhmv~Pe5d6vMVIsJy+&4A-B<1WEBHMdzGdZO#8=DChC&dxd-"
+    "zmY!pu-vK?+>5b)cV@_LSPP%@lFbt#OAq5G3|VVx$0@CpwCQm3Yx3VVH^{=oK2*8a^qh?04x"
+    "32*L>u#jJN6-"
+    ")I=Vit=x0I_4i<QHt$!lVGCBB)xwNvXkK}C%H7Fho8#3al1xytG9Kr=`XC9H}cVNk6mF4BqQ"
+    ";HY;-"
+    "XiAn`@7%tN1ssRC`?hD=whO4rrxYAYQY=Fx8?D1*xAcjLZj2Hp50GBNbIJSf9qf3efU_Zdrp"
+    "~sf(Gtax~%_JPbu0d|ITxd%hQi!Dt9{)o1&Qin$dM;)y0}tnVV0HPAI+G+ZyC%zdV+8fVW^V"
+    "JtIh1aJTOB_H^yq%?F3_oBWXExbq`(cI~#c;9je>Abmky#)9>Iz>oABue-MKDUV#)y$3lyzA"
+    "3TM<1;D5qd=1Tr=Aaz{>PSBuDM~<f}_?p`4$8M?y@);gGApOXL@$NeDVW#I@*!pW_5yKZ@f<"
+    "UpRve~pTSULV+X{dOdftJdq?jL9ufX+ron%ZS?*p&<uAUA_-"
+    "`})+kO2{WBuEeB}=IEabn8cykGsEE#jhqDOsVyhgc~T)(dTDot(LxKWw4k>MI@do+Uh5MyL3"
+    "h;JIsnRVUQTJR*q=4o)ULw8ylfrBLg)wg^}_Xrn}`mJCjlle({}6QmC+ni<j97{6wPKZ9Y}*"
+    "EpmowVWwj$W>1;`~9VG-"
+    "{V)TIg77jOS??l@TD(N0^euhCEO!@3B!d}%BuRIXNM0nx}mC;qQbzpp^3S&5vWDe^#dgviH+"
+    "Zd5-)ED=*}yp5^($}Fsxk03%`~0F$}PIMcQ86*6N;4=w)??S$6U!WoD-mU5JspJ+8@iOZ&*V"
+    "(Q<k$4FUlT!rpZkDF0SifRiGq|0MwT{^i^L@oR22R#xtA9RKOK{?b|Aj3Qu#6BTOXA?OJq*h"
+    "}ovE|yUyhgBDYB-"
+    "&%eD9P3!l8!ienxF6*jKZQQNSQ&+7mY18mEQF2%wyDeN>BzUg<sw?`JOqgQsD8vE$TE#fJ2E"
+    "%pL=*S68$uzK#UFD((8-FpPGeQ7gFN04r=*a2Q?Ie4-sVxjxyRPXXXtazXW57P-"
+    "WVcFW%<S>odM#DEvynRZ*4N&pXm3yQLaAp#4c^khjXsT6r|VS$}a26hnKU@~K&?_F^aqW~Sj"
+    "&6`EeXW0F)sT)1VIRo9pvKyJ@b5@N?tTS6z7mOyt9C}I)_5zb<eG^X_>Nr}UWsk7tn@nY_t$"
+    "~LTdBqLdiROVRx-QiHLLl+@-"
+    "ckIGrypu3>s0fN5Tyn=A<2zt&&#ApQHhV`=Tb|SX)ev@niCdm7fPh$_6EzDpd8bH|cnpds1}"
+    "`Ea5f!c*k9;+d>(cxogiRrVE&_GY8PF=-"
+    "VRliuorqpKqIE)Vm~1_&P}2{(65Iccr?vJ8eThFG3I)L=b%<9mYS8Wd*3|a&p#G;MR)V~W^P"
+    "I2E-0{u2;aWVV*RbJ>9|($&zOs3%-"
+    "V58QrP_p|)KFjSeV;trxncuD{d?uFO`9Zs!$Uz~QU87PdRcjQ8!JbvzuW&T`icHT!d43&h+z"
+    "Mja{siM)&Rn#tGrRLbUc2H{;|_w`<8VI+lx_y@_>lsJIuiDtYR>X?UZ8hx+`KdyiE{n+n)qI"
+    "%9wXgG|1`=tjq2n8L}KdxDQ5P9h~_--jd(lvL0+ARHy3dM56q(G3~%0U6FiiiB;xeDpsIOBC"
+    ">*wZ37#oj=N}2dyEkuco!4lOpB9BZJ&nC98dWbhpDmn<A*RL1qoqOqN3_lRzg*YXoT3IvB*B"
+    "&G8cvH{4MuvCQ~~DTn*gC349b%YWwt@rUbr02H4U_g(R=AFq7@Fq(QaC{pqpisAfVeCnIR2V"
+    "|yhUPZ22=TLaiIQY`Yt`1{73A&eZnsNpxO#DFS@g0XxgyU4)Sc_+0XPThhh%LB6bwy4wes92"
+    "f^To9*p)2zl&d%)0vH(d)nGdo(#gHdbgmi@KC!}UX6;lliHWKF}Cn?3#$)j<$Y=ku>=a32OK"
+    "U=d*Z367av$oKZza`K9v*f<zF<X}g%edgp!kgh$1mC)NV>_&*JT!?+sK(n!>9a%IjVqPDagQ"
+    "$R;S<6|%+-}4Jh>uy+LvERjWFIRdYwBn~q(-l1DwKaD7(e6Lc~~rrE{AA$T*QLwYt%-"
+    "r7)EN%{guL6{DgSB0|4^Aysze~>kha)C<hon&k25ap+@VJ6W<a%dzc8ksS|rzzTX2w9-"
+    "pkc`L<-"
+    "pp07E&y&q1%fy14%mQS0bttS3=YZQSG2^^w4JqV<`9=E9F?{!tDnmxufK9@mH=7Qt76rt=<-"
+    "|Hg7Z%ES<|2`m&MB<ZfM=^0$qQUvyx1*?hB-"
+    "5LLO%kM<tobINTNW5gQhrHGQ7xKB7dIAqX+`FR?rcTu+k~?*!mX$ltxPY6G;NuW^%>h-"
+    "I;rX6Y>`e9etC${K0suE$~uIt<cg~W7!=2zwb}MIg?tkiu|^rj8p#GE;BSUT#Fa%+%tD6r7T"
+    "%mYDsp!a!;FcFml>Eko5VnglQJB`i@_U#G7>x($!U*GMWvK$?N>YE4+ERi7oad-"
+    "8NZEflAXxVqe~|6F{2oE`ey~vOiBFHdqZy79zly~#*hOcS^!T-"
+    "FgfZCO6>MY%at1`!!BHMVB>ZfTW}_bV!;x6*wU}(16v0=|GO{oo80s1*GQ7EU#KL9eIQ9l6W"
+    "ky1pZF!-"
+    "281bryixD<$5wEWEGydwF?Cs+=zN3CJ;f&ud>GDag3Ed^^a6Y;IkHA_Ei9P*WqTFb(#-"
+    "P#`i+s+)ZtzYKIuU%H5V<Mbql=Zt!owp_K*uX=gC@u*gm0$kMOWr1V2%~dYCJ;@=Wr~rzZm#"
+    "WDJPCQT%6|`X*N^y)={n%mMi@d*0`d;0phBgE_aGtMS6l27?{a-Y1OtcNV(SJklu-"
+    ")4QOiyKYuT^pl;3kX_K{HVzwz1>9H*&~_eh#mI8-"
+    "{XrB(X*k>v$DLa9iiYs}6fRB?akS>z#~;a9>K!d@p)mp#_AxwnEUYOpu-"
+    "v$dUx=yjOAmB)iEx5X77-"
+    "k)@9nel8!9?u_MA=~dXu2qPP`tgOw5^M)>XWGNt(Fp^y@27hTB@P)Jc>Grnn>bTh^7svX}BI"
+    "_DMAVtWs!9)yRaK+DQa_SOpM7vtq$WsFRn6bVr@$$=xUNT-"
+    "o{p53W|c@NJc)9or75?M69+5l=k9E;SD;iFOyl#j#Fj{{8K31tf@b2J;?YDsxtls8EjKpluD"
+    "zvSotVE;Qk2%Yw;%OwWkXH(MGGb48W}Rn{RRl;~1BVdcVmia!5%6E@#}MfPmXGCmsm+YM)7H"
+    "I7@KRgDqjk3$ZFB))7c7$WVwZmJk{D}!xh;MTCchY8mL_PE@a)g5M@#oBG2>$>`-"
+    "0%E=?x`wjpkPEg%N|jR($sus|FdC^GlVV!SOIv4W;7KU=ayedCS{}(pP)U4Te9Mq{<Mm@fv-"
+    "xM0pGCvbjT1k8z<rcj$~=#veO4)%pz!He>IyU+wlS%Qej^Hmj_MXY7FI3$v!!=A-O`1m#c-"
+    "_hQ&RhcY^mGFu`DNU__d>o)X_#7KW$Us5k=%sP~@t6u9e1_D9Cl>k2?t|#X6ab+<5By0XV8M"
+    "o&b8CSmiO}BrQEBZc3fGVK@+?ZW^zGDzCD!G|PxtlXsIr$%nZP`6(7#HUacwRnovoa&Jh*=A"
+    "TFT;x#*=xO_1iUU(4Ll>u}V8?nyva9gOPvA_YtAC8;iaR&)K1p6XTuRWT2V>UF6%+^JfQCE9"
+    "W8lL?Y!o-h<dB6euYUv8*vx^;cDxbO@%#*EKA$}`sY<-MI3O-"
+    "OmsB<_{2wvO#B%F6|T+Bo4MeJz3!3W<rUomx{3|ybhYZ@Bgn4`z6=0?Z>E!O<l3Vf9Zt6nos"
+    "r@x#dbzXub+TQ`v&E4C<%I&YvSegd5U*W`jN%$Tp!q&<3zMRlWXxnBJBO4Gkg?2Hw<VGGwB&"
+    "E(SEk27{GPp<%y<5)MclWwqz43cbwUC!=I#i1zOMt0rj`;1165F5lAaMQ<8|2_ir3EG8F_dq"
+    "6=*BY%6p@#{BNTkOzLQLqM$mlgt!`n4&709}QMPTTsSdGPKRcr8?YH$u^-g-"
+    "J=+v=?1T>Uv_%U~@?kOV8uf11f)7056&FM;hKjgy&SMA=|JF*(c8~31>*T9gCJHiP1vQGP&%"
+    "&8YO3}y|gG8ZS>604stxLVr)b$OFrb2{U~cyJjAy1cIAN^tc+IA(r{$%8g$;#Muo1ej8jd_s"
+    "ZqyD}M6xVcjJbf*Z5TzcZMR7EA+)4CgchUbZ4j8jVIR9j_NgTV+NYrT<@fJ{_3Qmjbv#^+Re"
+    "NRAH9MTJV;{0hWWJM#M2nuttHwpll;hZ^sZ(647eJ8-"
+    "kIm(VkNPc*)cOXLhoOThsysWq{+Z6Xhhas+hAeB|op13oy~0Dat$b&_z#N;m_OF-viBRZ>(r"
+    "`GHbDRGkf9x9_LKpIfUmAs}{BREd3v4KfqPZV=JC;6N3U#k0YXFKycelm3M$_ai91lPI^CUv"
+    "fyXOq=nhQJxUK$0xUwG+(PzoPw>=2t%^@99W)am~?xlAiehWS|dzH)r&-"
+    "d!^9^OW*Yn$yr1^Ogur#C_A=0c>ujQ9>0VaY%3A|(73x0Wk2MT%|CnAGaMc_CMGJcJxJK^WL"
+    "fhwHrz2C@Q;CjVk!nOZPbjVnvd)nRcz*iiRp_6-eXb1Ls_2Y%N!@iIR=%ueW#-"
+    "9cy>xfUNL$LfK8^#(#B!1kSi5oHW=K+4d*n{GwFa3zWYG5l#E{-XXePn`-"
+    "oS;k@^1MEFGKp5Q{LYj*wfrh%@ts0W#P_lZtHZCeFng}AsaIB^2D~_3`^ujEaXK$(T+a2lM6"
+    "9&&RE4@m<+R2mR-jFk$bBvd~9fG!Wb*dZ8m-"
+    "JIYl=@fx=<ty2hS2N@Y3!os{r$8Je>2Qb}dbJ6qqyK+{k6`4iuR;Sn{(8M;pzyCJJLr<V}Or"
+    "@-->yY(wEN65p3*y$}o>!y|PYE4aX+c-UR@N$Co-pQhqHZz{tGO8x=t%k(%Vemwd*r>BqY>^"
+    ">ZfA=uv^(yi0sLw(6;tbt)>fa>Hc=E^2b_<~D(q<_oy3HCSo5~#7<ZZXWJZR~=FBR<++=nBx"
+    "qScmS9)SSgW1cH}6_W&XZEuCx7WNGGxo@Kg)uqI~Q8bLXQZB~oxY*L~u|3&-"
+    "L??Sj)I#veBkpzraL9eahZ@w}O0nH*qrb|x0-"
+    "FboQ+c?LVe>sse%;yy3R&vR){$L$i@5N0@PBAVIMr^PS8NtE&!vFj3)J!OeRy<3*#Cid@6eH"
+    "%liSD@DmRBC#|`(>l$nq?XI!1QHM*Rht@=unapR`D_@hGdW4x=1dTIrCawKhE6Ek_iyky5J{"
+    "fTz!r-{eAo|PwWd+wBsFRk(8AInO-X0ke4EuDt#WOytdxKr-"
+    "R^NE<UmtuA`MWrqaSt%X{qurqA_<8KT6+im!W$I;)rPM30vF@t)Znt>NwIw^^xsHLa4)gb`l"
+    "#N0mLty*;XQbKgTZjE;^~2{-tt&A>$LnlQX~bu-"
+    "D!vcNj&iq(>U3CIy|7)NIN}pmYpt6LKjoW_5_{gYhYQ}d)@9x`ght*qz;1E&slT@J&9>1RUq"
+    "QN8M>{yNqvP~!GH`hAxk%G-"
+    "?~?oH=+%9KKlSxDs?GX+aOtJYe)q+q`otmr^Gc54mWj!hnXqV-"
+    "4{~i)ITg#O;W}=J{?2UR@Z-"
+    "H%Chw&98??9oX@1j%;y!8V^&YK?GE$JIbG+lB9DQ@7i`>kI@hNcxGJ16RtNgNJnNNdVAIw#L"
+    "OfT3XQFol7B6XN?F^}KI*!+;aGC$(DqbPP~28u$v*lY=H2xQS{u(UR)?YwK~><UBEW4*|vfz"
+    "8}q;yXV!E9%Y$w_ztRnfV#l0l_qY)aBeiDg;yh3K`R-"
+    "UH$!^oapVlw9L)_IE=hQ;R3k#TFBlk-O0BD5#mh2xkfF>L_*eMpAE&^O;HPkvvTh9>-"
+    "m3<a0`^-$Ho_=^O-O!?!{H)(-"
+    "*S1u&vf6pQ6a6MiPT64rRTT_K#TX$<AFrxKA;5KcAQbB{}m(b4sI($Cz<zhya(EZIwk@4Jym"
+    "9a^*ZSJVM`{1^wUiP>U#`#-"
+    "X3hARy#)fWSUxjD!bE<+mYyDSLq=q(7C7nLb8ad&Akz^v20x7~l(MT%Dj$aK6iPYcSc79~GR"
+    "NXt_uaufLEJP>AK|f;3W>XBsBg(AlaEQ7p(kw}ad&(L_nrN+W&fwINe8RSxf!ed|t{jZi8<1"
+    "lgLl9rxG!O}5JxNswwGS>KMI>kG$6())xqQRKFFd-"
+    "2!jHv!$nR<?VIX?gjhIqpuW!aHx4D0o_bL+(@xIDXKBF@Rpi8_R0k*CSsp<~=8qYjuuJY3x("
+    "sECw?N&0@m)@KItu1WD2KGR|aXE=u?Nm!;wHF`$|yS*a)?4}tJWr#}?BRpqO&99VKYlr*0@8"
+    "|tJvQ<v>;eoI%I0VXYi^OVLTU;@^%vsp5EJgf4rVkXcS*$?eBk?Iz8N^@NG5FTHQlLrsGsv?"
+    ">i_cuo7o!(e>{TNRRWmy;ur1)cfYU9VZ)tou?ZYkb8_{!ntBf4*iwQ$uXNDfuQ-HlWkwhm53"
+    "mCw}E?v*FW)jv=*t16dRw3o@bceRJZKmyqC6i!t=kAT=m2T=#-"
+    "Ha{_Qsv=+@LC=dpS`DFtL@T)?*#jGeSt;}9L4j?`NwaOb)cAA0zZ7&88Pc3-"
+    "i%R>DXvk4m6bg#yXs~1sPIJVZHF?ozZ=`zymHrspzT>eX$GAQ6<taTzWAAPb>RwK0HCPi>8o"
+    ">4qHIMm2>vIjCQgl05)mo)WYwS_>O&K$k$RRq{Xy)9&R)3swl|@9T;ou@3G6~L&mGkzU^TbU"
+    "9A$;V}=$&o|JQI1G2iYH`!Bi_kAd{Pxax8dB-`dmI+V~(RyHnb-sm&HN4Ycz%M{dG5DGm>_S"
+    "I?aF)jsTc*yY$%R{>8ks}~%rgnqqw&<uo|T0nu=;K4=zhcj^y&5$2QCzM~y7ya?%;^EM~8z_"
+    "ieFnQ|}i@_6qIPX0m5b7Bx{#110IW(?YGoz`iz+xTNsb<($lyrU>(!BrYd99leo(nG=DD#Nx"
+    "QnN&+iZv0g)DPz<^7Xqv#DeDQi2tdS@Z}V|gUc?p@QxwQ2Fo}xNhBv2`WQ;E@(Y0on(!8Rw<"
+    "4<ulu?h97u$irMs<)bl`r|?*8CbuSg?OjOptC4HkV?JYkv^`BwG{QF#@(Y_9rBMC{kFB@kX}"
+    "a9^y4RQT7SQHbLlw;>7z1@cqv`8=Sw9IrsY&`C(9nmV*KO3zN)Zg$022Wnu*5H^vC-"
+    "Q1NXZ@f~1>AV3uFTT|>zS97e)Q;1x6bA0!Pwiv|x;f!W`MSKTk;Q19@V=tV1#`i+h*~9!D%q"
+    ";;HFOl5Yjl%-qYW3HNG%nf5zLyghc!uzRL3iUgEhsHzU`ArBOt|lS%uXwZHcBAhG9M_W-"
+    "+Z_`@CCdl%y34vQ!~eW2TxJLi}!;k1e<de*|r7G$6#y*NkP(5meUGN(*^^2?C_x@S?EV?gbs"
+    "l0mXV6KR-"
+    "0b!l({KpN<H=sIQSz~Bf3)c+@Q~x`EU)`eCU>81%@4w$O0`137_aRtdb;lzXI1!t(~LJCwPM"
+    "p*M^g8LwNK&D{jN%o4_OkK}ovH*#^B2GD16=D^yO|NVa+ce%SV{|9Qi4b=kCg>#v|g4d)*sU"
+    "v2!m(iP;(QcBZZbbiH@bQGCWvDYM$ApLTACV`-&4n-"
+    "p%MV6o?lSk(!U+o`w^U8ThM7t=^GcjpfDqS-94~w-w>0DYDin8Ce)(<mf85638v<Kc?-"
+    "Bbj=(z2O65@z6wma$&wP|W|SWiw~z|Inbx-"
+    "<@7)P~h2{dvxGwT<#Y}ptv>{EsM|MS19?FM*5k0H9cJE`L8#BLLK`(I`VyJ0wI)QiJGlOTaE"
+    "bG0;u7-b*@PgUv=A^nfv?BPcL$YBb6EBhM>atgZpbiw?)@TG_;=LdJDJW;T2h1vI-5nZ-"
+    "Lr`RPJ$goV-BW@B`ZVs@!n0<qUY3(Q4uDq)DzY>>s22e7GNmlt&93^^3@E_s<vQC=2Iq2)i1"
+    "AWbjX;OJQMn)?$Jv#v@khCzIqoAljj>@ifD-L({kj$KDE-"
+    "Eu>UGyjhV<Gh5#+Y}>huGPu!9Zr8v<OdaY63q<%_$tHRM99^XrCL#-psFZ--KT5n%DanoeK*"
+    "cj|&jlY5;?*mm;#`TQWB^t|yvXF49RNE}yweyv0Tt&g%#HB2EK3n|S>n~zx+sm~Q@c(2<i43"
+    "j{tL?sxY;@0S|m72FVQ9?ROgF7>rX*-"
+    "_r1GTnP0;D`q6|i{+ZwZn=!cNqRv}%{jrAW?tb*1LQN4G1{do8T|WN5R}eJRe=jD#7Vx^(`H"
+    "z59=zmo{Ujtv)1OEY5!u+r5;A`;fD#brwHTeHu&EmD3*W~>_a)J^5-"
+    "&Fo<DX)p(f28;#{a0G}wSd=&@;?G{F<+(4uc5C~lz*T`IR7PKc@2N<6#s!Ull&JK`5OM(+W&"
+    "zklKyYoS5t(8|LZOC%kBU2LlN@7KK?(+6cj@"
+)
+
+EMPTY_XLAM_BYTES: bytes = zlib.decompress(base64.b85decode(_EMPTY_XLAM_B85))
+# --- end XLAM template ---

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/src/pyopenvba/excel.py

@@ -55,10 +55,11 @@ class ExcelFile(VBAHostFile):
         VBA project (``ThisWorkbook``, ``Sheet1``, and a bare ``Module1``)
         and return an open :class:`ExcelFile` for it.
 
-        Supported extensions: ``.xlsm`` (default) and ``.xlsb``.
+        Supported extensions: ``.xlsm`` (default), ``.xlsb``, and
+        ``.xlam`` (Excel add-in).
 
         The bytes are decoded from a baked-in template captured from a
-        freshly Excel-authored workbook, so the resulting file opens
+        freshly Excel-authored file, so the resulting file opens
         cleanly in Excel without any "found a problem" repair prompt.
 
         ``path`` is overwritten if it already exists.
@@ -68,6 +69,9 @@ class ExcelFile(VBAHostFile):
         if suffix == ".xlsb":
             from pyopenvba._templates import EMPTY_XLSB_BYTES
             template = EMPTY_XLSB_BYTES
+        elif suffix == ".xlam":
+            from pyopenvba._templates import EMPTY_XLAM_BYTES
+            template = EMPTY_XLAM_BYTES
         else:
             from pyopenvba._templates import EMPTY_XLSM_BYTES
             template = EMPTY_XLSM_BYTES

{pyopenvba-3.1.0 → pyopenvba-3.3.0}/src/pyopenvba/vba.py

@@ -25,7 +25,7 @@ Critical implementation traps (guide section 31)
 from __future__ import annotations
 
 import struct
-from collections.abc import Iterable
+from collections.abc import Callable, Iterable
 from dataclasses import dataclass, field
 from enum import Enum
 from typing import TYPE_CHECKING
@@ -58,7 +58,9 @@ def copy_token_help(decompressed_current: int, decompressed_chunk_start: int) ->
     return length_mask, offset_mask, bit_count
 
 
-def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
+def decompress(
+    data: bytes, *, stream_name: str = "<unknown>", max_bytes: int | None = None
+) -> bytes:
     """
     Decompress a VBA stream using the MS-OVBA compression algorithm.
 
@@ -81,6 +83,36 @@ def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
     ``stream_name`` is purely contextual: it is embedded in any
     :class:`VBAProjectError` raised here so callers can identify which
     CFB stream a malformed chunk came from.
+
+    ``max_bytes``, when given, stops decompression at the first chunk
+    boundary at or beyond that many output bytes and returns the
+    chunk-aligned prefix.  Copy tokens never reference across chunk
+    boundaries (this decoder enforces it), so the prefix is
+    byte-identical to the same range of a full decompression.  Useful
+    for reading a module's ``Attribute VB_*`` header without paying for
+    the whole stream.
+    """
+    out, _ = _decompress(data, stream_name=stream_name, max_bytes=max_bytes)
+    return out
+
+
+def _decompress(
+    data: bytes, *, stream_name: str, max_bytes: int | None
+) -> tuple[bytes, bool]:
+    """Core decoder behind :func:`decompress`.
+
+    Returns ``(decompressed, consumed_all)`` where ``consumed_all`` is
+    True when the entire compressed input was processed — i.e. the
+    returned bytes are the complete decompression, not a prefix.
+
+    Performance shape (measured; see issue #5): output is produced with
+    slice operations wherever the spec allows — non-overlapping copy
+    tokens move as one slice, runs of literal tokens within a flag byte
+    extend once — and the copy-token masks are recomputed only when the
+    chunk-local output size crosses a power of two, since
+    :func:`copy_token_help` depends on nothing else.  Overlapping
+    copies (offset < length) keep the spec's byte-at-a-time semantics,
+    which are load-bearing there.
     """
 
     def _err(msg: str, offset: int) -> VBAProjectError:
@@ -92,13 +124,17 @@ def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
         raise _err("Invalid compressed stream: missing 0x01 signature byte.", 0)
 
     pos = 1
+    n = len(data)
     out = bytearray()
 
-    while pos < len(data):
-        if pos + 2 > len(data):
+    while pos < n:
+        if max_bytes is not None and len(out) >= max_bytes:
+            return bytes(out), False
+
+        if pos + 2 > n:
             raise _err("Truncated compressed stream: missing chunk header.", pos)
 
-        header = int(struct.unpack_from("<H", data, pos)[0])
+        header = data[pos] | data[pos + 1] << 8
         chunk_data_size = (header & 0x0FFF) + 1   # data bytes after the header
         chunk_signature = (header >> 12) & 0x7
         chunk_flag = (header >> 15) & 0x1
@@ -113,10 +149,10 @@ def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
             )
 
         chunk_end = pos + chunk_data_size
-        if chunk_end > len(data):
+        if chunk_end > n:
             raise _err(
                 f"Truncated chunk: header announces {chunk_data_size} bytes "
-                f"but only {len(data) - pos} remain.",
+                f"but only {n - pos} remain.",
                 header_offset,
             )
         decompressed_chunk_start = len(out)
@@ -129,32 +165,42 @@ def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
                     f"got {chunk_data_size}.",
                     header_offset,
                 )
-            if pos + 4096 > len(data):
+            if pos + 4096 > n:
                 raise _err("Truncated raw chunk.", pos)
             out.extend(data[pos: pos + 4096])
             pos += 4096
         else:
-            # Token-compressed chunk.
+            # Token-compressed chunk.  Masks depend only on the
+            # chunk-local output offset; recompute at power-of-two
+            # crossings instead of per token.
+            length_mask, offset_mask, bit_count = copy_token_help(
+                len(out), decompressed_chunk_start
+            )
+            next_threshold = (1 << bit_count) + 1
+
             while pos < chunk_end:
-                if pos >= len(data):
+                if pos >= n:
                     break
-                flag_byte = int(data[pos])
+                flag_byte = data[pos]
                 pos += 1
 
-                for bit in range(8):
-                    if pos >= chunk_end or pos >= len(data):
+                bit = 0
+                while bit < 8:
+                    if pos >= chunk_end or pos >= n:
                         break
 
                     if (flag_byte >> bit) & 1:
                         # Copy token — back-reference into already-decompressed output.
-                        if pos + 2 > len(data):
+                        if pos + 2 > n:
                             raise _err("Truncated copy token.", pos)
-                        token = int(struct.unpack_from("<H", data, pos)[0])
+                        token = data[pos] | data[pos + 1] << 8
                         pos += 2
 
-                        length_mask, offset_mask, bit_count = copy_token_help(
-                            len(out), decompressed_chunk_start
-                        )
+                        if len(out) - decompressed_chunk_start >= next_threshold:
+                            length_mask, offset_mask, bit_count = copy_token_help(
+                                len(out), decompressed_chunk_start
+                            )
+                            next_threshold = (1 << bit_count) + 1
                         length = (token & length_mask) + 3
                         offset = ((token & offset_mask) >> (16 - bit_count)) + 1
 
@@ -171,16 +217,29 @@ def decompress(data: bytes, *, stream_name: str = "<unknown>") -> bytes:
                                 pos - 2,
                             )
 
-                        # Byte-by-byte copy; overlap is intentional and required by spec.
-                        for _ in range(length):
-                            out.append(out[copy_src])
-                            copy_src += 1
+                        if offset >= length:
+                            # Source range is fully materialized: one slice.
+                            out += out[copy_src: copy_src + length]
+                        else:
+                            # Overlapping copy; byte-at-a-time is required
+                            # by spec semantics (the pattern repeats).
+                            for _ in range(length):
+                                out.append(out[copy_src])
+                                copy_src += 1
+                        bit += 1
                     else:
-                        # Literal token.
-                        out.append(int(data[pos]))
-                        pos += 1
+                        # Run of literal tokens: consecutive clear bits in
+                        # this flag byte copy verbatim as one slice.
+                        run_start = pos
+                        while (bit < 8
+                               and not ((flag_byte >> bit) & 1)
+                               and pos < chunk_end
+                               and pos < n):
+                            pos += 1
+                            bit += 1
+                        out += data[run_start:pos]
 
-    return bytes(out)
+    return bytes(out), True
 
 
 def compress(data: bytes) -> bytes:
@@ -678,35 +737,101 @@ class _DirInfo:
 # Public data model
 # ---------------------------------------------------------------------------
 
-@dataclass
 class VBAModule:
-    """A parsed VBA module with its source code."""
-    name: str
-    stream_name: str
-    source: str
-    kind: VBAModuleKind = VBAModuleKind.standard
-    text_offset: int = 0
-    is_read_only: bool = False
-    is_private: bool = False
-    # Dir-stream sub-records preserved for round-trip serialization.
-    name_unicode: str = ""
-    stream_name_unicode: str = ""
-    doc_string: str = ""
-    doc_string_unicode: str = ""
-    help_context: int = 0
-    cookie: int = 0
-    # Original bytes 0..text_offset of the module stream (performance cache
-    # / version-dependent prefix).  Preserved across write-back so that
-    # Office's cache invalidation logic operates the same way as it would
-    # for an untouched stream.
-    prefix_bytes: bytes = field(default=b"", repr=False)
-    # Whether the source has been edited and needs to be recompressed on save.
-    dirty: bool = field(default=False, repr=False)
-    # Cached attribute header captured at parse time so a body-only source
-    # replacement (the VBE-style edit surface) can re-prepend the required
-    # ``Attribute VB_*`` / ``VERSION ... CLASS`` block.  Re-derived on demand
-    # when missing via ``split_attribute_header(self.source)``.
-    attribute_header: str = field(default="", repr=False)
+    """A parsed VBA module with its source code.
+
+    ``source`` may be materialized lazily: modules produced by
+    :func:`parse_vba_project` defer the MS-OVBA decompression of their
+    stream until the first ``.source`` access (issue #5 — decompression
+    is 88-96% of the cost of opening a project, and callers that only
+    want names, kinds, or one module out of many should not pay for all
+    of it).  Constructing a module with an explicit ``source`` string is
+    fully eager and behaves exactly as before.  One consequence of
+    laziness: a corrupt chunk past the first one raises
+    :class:`VBAProjectError` at first access rather than at parse time.
+    """
+
+    def __init__(
+        self,
+        name: str,
+        stream_name: str,
+        source: str = "",
+        kind: VBAModuleKind = VBAModuleKind.standard,
+        text_offset: int = 0,
+        is_read_only: bool = False,
+        is_private: bool = False,
+        # Dir-stream sub-records preserved for round-trip serialization.
+        name_unicode: str = "",
+        stream_name_unicode: str = "",
+        doc_string: str = "",
+        doc_string_unicode: str = "",
+        help_context: int = 0,
+        cookie: int = 0,
+        # Original bytes 0..text_offset of the module stream (performance
+        # cache / version-dependent prefix).  Preserved across write-back
+        # so that Office's cache invalidation logic operates the same way
+        # as it would for an untouched stream.
+        prefix_bytes: bytes = b"",
+        # Whether the source has been edited and needs recompression on save.
+        dirty: bool = False,
+        # Cached attribute header captured at parse time so a body-only
+        # source replacement (the VBE-style edit surface) can re-prepend
+        # the required ``Attribute VB_*`` block.  Re-derived on demand when
+        # missing via ``split_attribute_header(self.source)``.
+        attribute_header: str = "",
+        source_loader: Callable[[], str] | None = None,
+    ) -> None:
+        self.name = name
+        self.stream_name = stream_name
+        self.kind = kind
+        self.text_offset = text_offset
+        self.is_read_only = is_read_only
+        self.is_private = is_private
+        self.name_unicode = name_unicode
+        self.stream_name_unicode = stream_name_unicode
+        self.doc_string = doc_string
+        self.doc_string_unicode = doc_string_unicode
+        self.help_context = help_context
+        self.cookie = cookie
+        self.prefix_bytes = prefix_bytes
+        self.dirty = dirty
+        self.attribute_header = attribute_header
+        if source_loader is not None:
+            self._source: str | None = None
+            self._source_loader: Callable[[], str] | None = source_loader
+        else:
+            self._source = source
+            self._source_loader = None
+
+    def __repr__(self) -> str:
+        return (
+            f"VBAModule(name={self.name!r}, stream_name={self.stream_name!r}, "
+            f"kind={self.kind!r}, text_offset={self.text_offset}, "
+            f"source_loaded={self._source is not None})"
+        )
+
+    @property
+    def source_loaded(self) -> bool:
+        """True once the source text is materialized in memory."""
+        return self._source is not None
+
+    @property
+    def source(self) -> str:
+        """The module's full source text (header plus body).
+
+        Materializes lazily on first access for parsed modules.
+        """
+        if self._source is None:
+            loader = self._source_loader
+            assert loader is not None, "lazy module lost its loader"
+            self._source = loader()
+            self._source_loader = None
+        return self._source
+
+    @source.setter
+    def source(self, value: str) -> None:
+        self._source = value
+        self._source_loader = None
 
     @property
     def body(self) -> str:
@@ -1470,12 +1595,31 @@ def _project_section_end(lines: list[str]) -> int:
 # Public factory
 # ---------------------------------------------------------------------------
 
+def _make_source_loader(
+    compressed: bytes, encoding: str, stream_name: str
+) -> Callable[[], str]:
+    """Build the deferred decompress-and-decode thunk for a lazy module."""
+    def _load() -> str:
+        return decompress(compressed, stream_name=stream_name).decode(
+            encoding, errors="replace"
+        )
+    return _load
+
+
 def parse_vba_project(cfb: CFB) -> VBAProject:
     """
-    Extract and decompress all VBA module sources from a parsed CFB.
+    Extract all VBA module metadata from a parsed CFB.
 
     The CFB must be the vbaProject.bin from an xlsm/xlsb, or the whole
     file for an xls workbook.
+
+    Module source text is loaded lazily: only the first compressed
+    chunk of each module stream is decompressed here (enough for the
+    ``Attribute VB_*`` header, and for single-chunk modules it is
+    already the whole source).  The remaining chunks decompress on the
+    first ``VBAModule.source`` access.  Stream lookup and MODULEOFFSET
+    bounds checks stay eager so structural corruption still surfaces at
+    parse time.
     """
     try:
         dir_compressed = cfb.get_stream_in_storage("VBA", "dir")
@@ -1510,17 +1654,47 @@ def parse_vba_project(cfb: CFB) -> VBAProject:
                 f"{len(stream_compressed)} for module {info.name!r}."
             )
 
-        compressed_source = stream_compressed[info.text_offset:]
-        source_bytes = decompress(
-            compressed_source, stream_name=f"VBA/{stream_name}"
+        compressed_source = bytes(stream_compressed[info.text_offset:])
+        ovba_name = f"VBA/{stream_name}"
+
+        # Decompress just the first chunk.  For single-chunk modules
+        # (decompressed size <= 4096) this is the complete source and
+        # the module is materialized eagerly with zero extra work.
+        prefix_raw, consumed_all = _decompress(
+            compressed_source, stream_name=ovba_name, max_bytes=1
         )
-        source = source_bytes.decode(encoding, errors="replace")
-        header, _ = split_attribute_header(source)
+        prefix_text = prefix_raw.decode(encoding, errors="replace")
+
+        source: str | None
+        loader: Callable[[], str] | None
+        if consumed_all:
+            source = prefix_text
+            header, _ = split_attribute_header(prefix_text)
+            loader = None
+        else:
+            header, body_prefix = split_attribute_header(prefix_text)
+            if header and body_prefix:
+                # Header fits inside the first chunk (the normal case);
+                # defer the rest of the stream.
+                source = None
+                loader = _make_source_loader(
+                    compressed_source, encoding, ovba_name
+                )
+            else:
+                # Either no attribute header at all, or the header runs
+                # to the chunk boundary and may be truncated.  Both are
+                # abnormal; fall back to eager full decompression so
+                # attribute_header is always derived from complete text.
+                source = decompress(
+                    compressed_source, stream_name=ovba_name
+                ).decode(encoding, errors="replace")
+                header, _ = split_attribute_header(source)
+                loader = None
 
         modules.append(VBAModule(
             name=info.name,
             stream_name=stream_name,
-            source=source,
+            source=source if source is not None else "",
             kind=info.module_kind,
             text_offset=info.text_offset,
             is_read_only=info.is_read_only,
@@ -1531,8 +1705,9 @@ def parse_vba_project(cfb: CFB) -> VBAProject:
             doc_string_unicode=info.doc_string_unicode,
             help_context=info.help_context,
             cookie=info.cookie,
-            prefix_bytes=stream_compressed[: info.text_offset],
+            prefix_bytes=bytes(stream_compressed[: info.text_offset]),
             attribute_header=header,
+            source_loader=loader,
         ))
 
     project = VBAProject(modules=modules, code_page=code_page)