From 878affabe4434168ec8cdc2e4810e704b114a38b Mon Sep 17 00:00:00 2001
From: John McNamara <jmcnamara@cpan.org>
Date: Mon, 9 Oct 2023 17:35:53 +0100
Subject: [PATCH] table: fix escaping of future funtions

Issue #1015
---
 xlsxwriter/test/comparison/test_table35.py    |  59 ++++++++++++++++++
 .../test/comparison/xlsx_files/table35.xlsx   | Bin 0 -> 7308 bytes
 xlsxwriter/worksheet.py                       |   7 ++-
 3 files changed, 64 insertions(+), 2 deletions(-)
 create mode 100644 xlsxwriter/test/comparison/test_table35.py
 create mode 100644 xlsxwriter/test/comparison/xlsx_files/table35.xlsx

diff --git a/xlsxwriter/test/comparison/test_table35.py b/xlsxwriter/test/comparison/test_table35.py
new file mode 100644
index 000000000..c049b5d00
--- /dev/null
+++ b/xlsxwriter/test/comparison/test_table35.py
@@ -0,0 +1,59 @@
+###############################################################################
+#
+# Tests for XlsxWriter.
+#
+# SPDX-License-Identifier: BSD-2-Clause
+# Copyright (c), 2013-2023, John McNamara, jmcnamara@cpan.org
+#
+
+from ..excel_comparison_test import ExcelComparisonTest
+from ...workbook import Workbook
+
+
+class TestCompareXLSXFiles(ExcelComparisonTest):
+    """
+    Test file created by XlsxWriter against a file created by Excel.
+
+    """
+
+    def setUp(self):
+        self.set_filename("table35.xlsx")
+
+        self.ignore_files = [
+            "xl/calcChain.xml",
+            "[Content_Types].xml",
+            "xl/_rels/workbook.xml.rels",
+        ]
+
+    def test_create_file(self):
+        """Test the creation of a simple XlsxWriter file with tables."""
+
+        workbook = Workbook(self.got_filename)
+        worksheet = workbook.add_worksheet()
+        format1 = workbook.add_format({"num_format": "0.0000"})
+
+        data = [
+            ["Foo", 1234, 0, 4321],
+            ["Bar", 1256, 0, 4320],
+            ["Baz", 2234, 0, 4332],
+            ["Bop", 1324, 0, 4333],
+        ]
+
+        worksheet.set_column("C:F", 10.288)
+
+        worksheet.add_table(
+            "C2:F6",
+            {
+                "data": data,
+                "columns": [
+                    {},
+                    {},
+                    {},
+                    {"formula": "BASE(0,2)", "format": format1},
+                ],
+            },
+        )
+
+        workbook.close()
+
+        self.assertExcelEqual()
diff --git a/xlsxwriter/test/comparison/xlsx_files/table35.xlsx b/xlsxwriter/test/comparison/xlsx_files/table35.xlsx
new file mode 100644
index 0000000000000000000000000000000000000000..db0d298d9a9f0478ea8ddb6c12b524f061c89afd
GIT binary patch
literal 7308
zcma)AbzD?yv>m#;8;Ox-Xz3J@k{VK)A*4e>N=oS%20^4-2?0r^yOAyhC6#dK2H$Xf
zzbjtveZD`wbLRXp>zr?|Z|}AD(ojJ`B?SNgm;kM`yLzqSlLQbX03aR>03ZR-0*vIH
zojf2;9;P}zE)aKP9&bknunragrQr?>BwUFF^3WRxfP{L0_{U!$r7$)1b`W9Mk<y17
zyX34+28^Mpo|<M@No*J?vx&f0mPYioRkb$IOC?5InL%K#)qDfI(^VqX!9LLeq_N__
z^JGSb#Wray$#`|q|1xbpDwIhdughSd6aTJi*OXrF$q+NEgd;lzB>GZTS&Ma2=J}p&
zy>^|3{PJ8mjD8&Z8Jjaki1^F27+Xtf8Uj9gNed)<lEgx8>G_*jwn{8xjpgPm$PFS%
z!9D)<6{j?;l7##j4njJ*8BY3)%W<Ivd*Yu!M|~<J95KDPa(+RnU@dVWoS{T3f6w`q
zrzvG@9ATRkWj-wJz<9;<M>QRUoDvYJeqEkV-#>Q?Jt+9D^nv<iOOYK`Qsc2>F9xa_
zt3`>L=kC@gZ7ie%Bish|mutAD4e#7K(p%?IstV|qF>%PZ`pee<rFImV-|at`@^;q>
z)3p##=;EyDHU>JD8GLM9p$^~#&OB?PxL6JxxG}fqagL?&H)8<64ZzJ?Q60XB_!FT3
z0E7s}teh=1+?-w9dCgs1{-z61FhqQ{{y|qdRMvh8K^Hvif<W;|!BhVku~iaubF}>#
zI<&?HOy8YT$s(woxId-m8NN~FYnVAdAdw*z$Kr%vIw%%y+rVkSH*A2ee%4p#-%IZm
zXg$RxuT`csDb6-S6#ub@LC=E3|FIG}NQDSrWs)$Ab*+fTmTYKjI{)sLWieZl>#)Bu
z4W9k$1w)q(3ZKiU_MjH9#$X#|k9tIZ?4?N6?%TEY!jF7;66{X$<%*ojf$Z>@SbBf8
z8F&af=dlNy)_d}OBS8;X{iiW4hw935<<?4Fa@p<SCv_+jypFl53hZKro>{%!xP!ii
zbHNZ^?CfrKgTfrm*y&zR4s=HpE!ePBlLd+l+wnB*^0@fKY9SZ8JaMw3R4|KwM4f;Y
z62p2-<UYZog|Y;w9BZj&jk9Sd{oX0Gao16UhdVxQ{k7}sV@l6}Qp}-^28T$;Tqd2b
z=v@!v@LZGYa<(pt73(E+Y=)0y15fT1Qt(7|O59s;SzF8al<8~`0Qi-}kbGF17=lCt
zWCW4dNwjo!gZzm_f2gTSJBYM%0j*iS*Y`!<?b@&!lqAV;l-9^aBPDo^#okkv*{!)3
zlcjSm$0@!;7a!eud)JI+6c@~lbHPEjavG@0U*2kNAUEnpc}Fs>)xYv7CL^`Qz#r`2
zD85e#tO~O!#?xPT9EE&W6sQ^`JWunaf`lgi18Zw`aNVe`8$*U?3?4<MAKoq2Wpb76
zhSiKEdde3G;fFnj(Mo%eIV24nTy7<edGk~azx_w$qs9)DFp@%t^P!g88?v+?ji#cz
z$~K@pG$l8rJK_C>$>tMvnir+0S^TfjNXYA^YW&7&l9m$X0vn!*H{*Jl2x%;A9cDBi
z_%*+G<{j6>YzwetfYokZW*cVlvkJ!aaskI8RrMA1h0nfpXB;pDxk)dZTBLTuI;^xt
zqS4qIMQ_jpR^rdj1z^%YNw}(g8h+}n>xfFIiXZ_8L4v6p#KE1H=j!@*&5Qn*ng<<J
zM&ToT3=f7AuFenE1cwXGsSrIPc}V~QzLDMpl0Y?Uot+6uIji?S@g+WYZlbboe14HP
z&$bd25(EK<<e1IiWeaRK1nPeX>I-iD+!2IJ%hp~{-()B~5~>yHCf!kj&1!|xsMIhe
zHkTo>8p#~CJLa~_w(?wzZX|X(!DQl~R9%|tJuTnF5S5a6Eo!y2!rRb6M{)hxO8*1W
zWrZkHs<7yn%zU7Gr|DzIZ4$a@*r!$f>u$--YvUQHbl4C2BgpxZ)>-6dHfm!n&-B|)
z1eVg?4+io)wa)(3ldjiB*&Mw;f+xuEGhBx0clG*n+^OXdXZ8^yT%?F_c{}iWm|HkN
z+<)Bo{yw(FcUd4ci1m-+^DyD(vF%9=<}ns|5?do*7#4K;Y4y$h7an-a_wG7<Jls+<
zN&v4diJp91UjATJF%{{Dy_PS;P8Y|d9Lmm>Z2e-iRxQ9^KH?6D7AC}$kMa2{len}B
zp%jeKeD)Zo8-9?+XR0F?!Z2f);-Y0(h!o;sv}%9z@tHE_cx0!hpe1!)w!-c<7c06)
zo&T5#HED8_u8TKSiaLzlxNFZ(5z7#D#dOQbc*Yo$euOIs-I0e3+bg=VB<^k1tC6n6
zHeqyav3!(3%G{%_W@~XEJ^v27HNO?GFy(7J78Iqez3KkWr3hM4j^^XwBL(_CTruB;
z;?d}D@X0ue5wPF$^6xF7bd91qm*T_J1j;3<c5xf<0h?Axu5<f0`Q~~L`m<hPqczD^
zhT@OtVg@)1;2A^7oh3y_694#3oS%GL34ygu{TnF+AEXFA2!8P4<?Lo};p}YxHx>V(
z12G9|_u4_YPvA=DPuaXC397@u_BU_HYzD_u&WQ?sqvlr2VacCs?*6JH<&?HLRl(5c
zsk@=g+j~?0X4Na(%5Zk130t1=>>T)9;R|u)G@D3)mt;EoxUpp$8^sevTRZX_%(9Q&
z$hI0pAf)vLAsO{y!dct-6E!yU`H~7l`eq*<0-BOFsk?8F3uJ!@)0q7Z@|cT6r}q%p
z&pJo5kmZj%G`<;~d+>^k*fTi>Q(!gh;L8~cd&0oU9Uh78NNctO%s^~U&{0Ud?6RwR
z?x}CDp31E%hxmY~No%or&cV?t%=B#gn`R!;^0Lq|6SlJM$O5X2Ly2PK&RZ+Kt^QB*
zm`qmPx2QU@_sAN#M{l*{n(luMaA$d7_>FrRD?lflW<Rc;8x82$o)`g&6H*nfQ^VA@
zOkL@9TTgMEGW|(|C?YN9O&*P6At;bXbWoH(X>hlNKs?-e|GNE54JSlexc#0Q=`a=N
zG!S7oJn58<E7S0$F^S1bU72xf3ZbXUnq%D+yKUwANHjC^cbfgX%V#P><zL|J4lD@l
z?WMT7xjWEQVmO9E*&7YLVUM|V*q4R#7n)b#(i#?A$*j(>P}n89ymRH$YiP)5TmgDH
zs(@1B=<KXhZwmVZ+j@f{d=`$RQSMsXb#8%lbdy6_$9BKrD1-j6JozX2m&vrRUMV1P
zf;SE0J(Y5@Ka-!Raf`{n$s;YQM<K!kD?496=(V4*`mZn`<6Bn&pE=WK1+~dV;AM5t
zIpmJ#lEB}u)N34a3B$9$39)A{zUvAAKOJVQsqSP+z+u<1Jms}Rs}au1Tj_>%>C3`u
zx*YXOrm2c&GjHB8wF}>{FR5EG$e9Q-bM|WpkA0_((NB5L;MN-Vqlz5y1F1dY8ZRvM
z*#{-Y#t$|sR!twA=;I7g%f||+f^bNpk=wCUL1xFT3i=rCoAsQZ#GtI;!;NVjx1Fy`
z?WZwELxC^K*ZCKNxzbp1?pTe4a!DlI-U+>WGF2uYgx+SZ#A@N7E?e^%&M~O`l5e%c
zWgx-yE+f8Eei%7WnS2=9`CY9`5#{|3x8LVSoOw6!bTC)A%h*TSs}Ago-v)$nPqRfa
zA6QKsFFy7pztl|9I_z!HZ0~jclwohLl<hf+A8Nxpq7t<C8s29P`tEdR>HHiLc&$sg
z5~!lI1Hc=EK(QjSocXt-^+T?H9<X19s}a$#|DyoM3|C;cfe6t*8E@0IZ2?O|!UeaO
z<n&$=xD-qYPXlj6SS-vx#wVwxg$G>1>vA5cGyBF9%u-{C4nI!NteGfCcCk}`Az4m1
zQgzEvp4b{&BWVNdT0msU5hnYt1!@r-dPC8Rkf|sLi2Ff|pZ#k|Ca7TKs4e@g`8|sl
z5b@8=cx)8FVk4|3CwH^K%`Xgdp6R+CRqIj-5z^}6;Zq63;Z22XL3>B5B+C*(jD2!k
z8JyQr?W*D}ViH;PAz~qe3IO2!h=;p}4?=<dRPWNY)$Bij2pcJO8A87q_^7?D>h#19
z3X`Koo{@W9$?A)C3L5n`IGXaZsyCs*w%Z61dX##!>LbWQ|5`CIYF}2=X!L?7S7Ejb
z3-S&cAWa9C)+Byx)LQ+fGA|c*zvAtg1}bH>pSTJZDyswASE{V<ZThxDqub@~jaA;G
zV$QcdO?q+do464%_1ZqOnF*pQ<0{1#Pst6Ep%&4XVZc!s-32pxduOrqN{R-VR2n}a
zfPh=A1He^7P7o#yvd=f`U1EBq3PjY!?*aV#QbNO56bqtnmVvjxs76jOdXls|W~Wu6
z!)zPpI^y7zXSOnSjg&oh$ggtN0HbrvPCc}lUG)7%4))OJyYs!@Bp8lPy2;E9%bm6w
zTI}x!J_>#%*H0e*3G5ZiS(ni%53m6dMtTjo(Xj>!tO6i3FAt0w))}@G&t}V<fKf*l
z$%J@==Fqz@ikfv*W;tiho2`1QjrT=1eePeT-t%7A*nxnm_q*--R%guK41)!POZ7E~
z3ybo26H4^j4zdK<&YlWq71TM=M4bhuT|^Kq6rneCHM?07;bG3~%C_5ya((5#1cp%$
ztg&u@jcErAYL7+nhc7{74Hu^qygzI2)q$8NU7<@tBuEEhUCly>mc-KB!BXDV+|KDw
zXX1A3;8iw+UbS(DPTJoiVFi+y{>c81<IB_-XJ8J5{=Q4HzGv3x)&(>stx-3Do(ZIz
z#nh<Kh{Rlj)(hcpJdC&OQ>)@avFCe0`*UhGRU&%DbP=O6B`vEBRa%u5l!AJ$vK+n4
z1zGM1cF!7E#z~AiXd5KPA2Q3cKW-9WVyBE_ynh1NwMo;Jcs=c>d3kh3@ay)z7O>V;
zB4kCI=Erb;)p6NE93elhKUL*FRDR1qEpASMvWa<zL9wYemPCB8EVWd4CNIo$Zo<iM
ze5vF4^jNgy<bYLeefD8^Xee7a4zUP6X3@Cv{l3=*Y{5(iyxXVDz1{-z)^oQ>t3_Ed
zcJ=}SkLlKSlg^0bpDHNzE!C{tFEI%3kYX6QWouN6ae>2)b2n^>$XWvEXs?*}5VFxu
zz_X-A1`TJ-idz9X8D(qr7C5Rf)KoO|kPx>w@=*}!mXiia5+7q8D-M)RJx~*G6RgpQ
zW;XM+mne{u4T0rX3)#$DZj*67cRE(3J$|l`&eR?YR6k|5sq9A;>nL#yN+Xh{jz8;@
z!&N~OnbqY!(?6Vq_{w(Zpp`044NIXJ%YstJ1;mJODMHm3KGs#e`D8kL@_O-6qe<-=
z*D(aJd1m(VP4L4r?m~gJmqEMz;Q5cKdhY$+F@ct7%_Cnu8e)i>DmvbA9_yBVb(&J~
z_KG;tJ%BrSy&EK+H(Gqbd3>24Q()9(lNCSWT^X#tR3AQo%)h#sN;Hq`ZJz;9ft5n^
z)ESCj-H+Oq<T(ZO1V@p@B&4!hMf<lrbQL5eEkxc1w$7&e^(S*0z2su?mnE5~kx~cg
zbP(_E&cyL%O3EUZRKWKBaVu{(0Rz4C@r;Z&UU!iC@!}cp<>jIF{!}8|MB=nBI$7-U
zC{yZeYl?SJCLbj;@ZvbGFfKE2?<7-Ng1@B}jedO_DJEP&q?c%RjcD4MQ0B>^18E51
z7%>_?k{#esM<01U&D^@}q0)?x7pfqDWP5$z<nC06hANp5;Pq2Yth#>D4Ht94wMQH(
zA~w_*)}Jk2EgkYn3HE-=z;tv@l>us#^gAgjKlsKME{w0FN~#Rs!McH7`40B%{H=<A
zD=P!1M{*8+fnqZ57meo;Wh0o2`~vKl**quKNBHY5))vk3`29+3m;<U@Se*4c92p$6
zR6<=uV+kVV*lNo31EHpFbvlG!AA@2aF*D^ytUgOg8gGovCZTF?>bKUUVkb>ci5CH_
ziMc(!_x46Caqf^H{=>~XZpiGBBlLQTtlsr<qe2}>-ASLD<Riq43>FGxZPnxVhjd7d
z-;D<{Q)f;_Q-wL5H&G3Lp4+zNPwMC;zaMtSAUsbe5p#sOe0tV&)&y^g@~?gMY-+2f
zAKiY#-L;GN6)m(IR)Hd9x%_0n@C|DI9slV8a;gyv;61rIu8t&^pq3dS;`{z`U~j@j
z)Q(%vLuJTIP$GzVKC_sCcZXsVNu!4k8&0SQ-|KJfYBqg*Kl}toc!neXZI)u6nX!3{
ziZgJaH^^SuUE+-(T*t0vRjmj;bS$xXtYj_ch9!tOcN{Jn;-fz#sleaCtku!ON4+RG
z>0z`nVKSEIC^)Y=D<(VISx>gu;2y5!$f|t!K(w;1LGDgglHL*5@=~5-j5##8pA9L1
z-%%z7&2?@UY~IHib&}V*TIKN|2|ZbXMeY?HS9==AJE6db#JmTueVx{y?(wy}kC`0H
z8F9Om=iW@rW?kaj0e23$8GKmMzTF{vOH58)nCy&l-*a!1S`%wH`qb}6mfT0CoxUVf
zoz`AG!P^hbo`u$Zxy#LcC@S&J<V$?1;K3&LN7FG_muTu@<GX^q=Qx)3mN2>^Gh9N-
ze9_sOI*l7od0?UAa2!fneuFHE;7TR19GCy+v~^|tWPi@J1d)11oijn1V7Wr=Y(}el
zWS&jI&$XvAU%M;b&NL|EOg#5e!pEY?o0wDGs@1p!2Zk~8f9TDcDOjgQzo_-zb>#$R
zj&+CRGahlh2`?7%-_k7KvF1qI(KHe<x_>koFb;G%mibB{=)~bylje-!$B+|8PQn_j
z(D0t4&$&VrHQgxHmAyF7E86f$7MKXWM=K>{Bf^p9|F&+*tHx%#+Usrc)&y~Nb%<(>
z;mJ}20X%4v?iQQcbLh!j-kHnz=FoS3fYc$>W8>PuebxR&m6;KqB9u)U;q+1eP`4jF
z-}N!?k6m9WbnpSfq78+IHHA$3a*JPN!+J!kNZlOAF!YzJSuIo)XD^SpIEmM95vmeM
zMNm};Fl?5INE>rDu_<h%2Q&4{#*Z~smT7KR_%`~W5>Xk4m3rlwWnsS9J$-PY$n8cQ
z*>$LyM@m6Pxq5lGuL$oUrNBa>igYyrof|YeL2_MEm_^U$lCfP7rSFYuMJZ{hBlz(&
zp5(>NxvA=j{lx>DJF&bvJ<be=BZRKlo$m=bDNET1?j_{w#3!5Us<gSJ=9Bcu(hnLu
znPa75B5<7jg6TT$e&7`~NrS7?=&rOToS!o54mwh4vvoLlBfFu_n0tV6V|b|P9PL*z
z{SsjwS&fLM($&cPzs;kqxf{ev+r!Py$>xteq~rUM2grPcXz#tUzZ0%DT30jOhGLSP
z2cIIDd#$4j3(O6aOb7UnVQ7wb`|`B6Je+f<AHa%Y0TM*{prF58;Taie|Lp$#6kkzL
zivk0<za4@+x6SX)^kAJk;;G5Q5Bi*raiV=`ck*WaTzfU`x$baUwoc!TEAlDtFEE&+
zB?+?gVLH&rRE0I&{9x?n0u3H3Uo!8ja?uTW^WCGrf9?D*P4B3|rl~MapZ@Dnkaq*L
zR3%heLj?($9_7F6eo90*002Zh0C_=Izy8(yNBd#^|6`W84*a_-eI2+Gf&aTljX?bu
zfBK)OzuKhNQN0j3@i*#E)AY}<zZ-woVb2kh#V<DCpLhSeHFh146CLm$Mi~P6$|(Co
zTz@rrt|Pz0_zU@ZEdcBMdH=s#7S}=Lu>J=97Xt%<eq~_%AD{gD)OsB~9p|6u|1rb<
zIqJWUgV$eFiu>1#t`CQQj?C`^#dXLg{J$XoF<$)tP=D>?ucM|D{Dt~^SN~_=-xcCI
va2nZP!2hWi|Gx<TS~IWXuap0X@b4A$zrGv|kqK90J02hckz`vGS5N-~)5*h;

literal 0
HcmV?d00001

diff --git a/xlsxwriter/worksheet.py b/xlsxwriter/worksheet.py
index f5e9cedbf..38ca25553 100644
--- a/xlsxwriter/worksheet.py
+++ b/xlsxwriter/worksheet.py
@@ -836,7 +836,7 @@ def write_dynamic_array_formula(
 
     # Utility method to strip equal sign and array braces from a formula and
     # also expand out future and dynamic array formulas.
-    def _prepare_formula(self, formula):
+    def _prepare_formula(self, formula, expand_future_functions=False):
         # Remove array formula braces and the leading =.
         if formula.startswith("{"):
             formula = formula[1:]
@@ -880,7 +880,7 @@ def _prepare_formula(self, formula):
         formula = re.sub(r"\bWRAPROWS\(", "_xlfn.WRAPROWS(", formula)
         formula = re.sub(r"\bXLOOKUP\(", "_xlfn.XLOOKUP(", formula)
 
-        if not self.use_future_functions:
+        if not self.use_future_functions and not expand_future_functions:
             return formula
 
         formula = re.sub(r"\bACOTH\(", "_xlfn.ACOTH(", formula)
@@ -3403,6 +3403,9 @@ def add_table(self, first_row, first_col, last_row, last_col, options=None):
                         # Convert Excel 2010 "@" ref to 2007 "#This Row".
                         formula = formula.replace("@", "[#This Row],")
 
+                        # Escape any future functions.
+                        formula = self._prepare_formula(formula, True)
+
                         col_data["formula"] = formula
                         # We write the formulas below after the table data.