From cabf9fa5fc671d83cbdd50c2505152978660c36c Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Mon, 24 Aug 2026 14:40:27 +0200 Subject: [PATCH 1/3] [ADD] edi_party_helper_oca --- edi_party_helper_oca/README.rst | 1 + edi_party_helper_oca/__init__.py | 1 + edi_party_helper_oca/__manifest__.py | 20 +++ edi_party_helper_oca/models/__init__.py | 2 + .../models/edi_exchange_type.py | 15 ++ .../models/edi_party_helper.py | 24 +++ edi_party_helper_oca/pyproject.toml | 3 + edi_party_helper_oca/readme/CONFIGURE.md | 6 + edi_party_helper_oca/readme/CONTRIBUTORS.md | 1 + edi_party_helper_oca/readme/DESCRIPTION.md | 7 + edi_party_helper_oca/readme/USAGE.md | 18 +++ .../static/description/icon.png | Bin 0 -> 9455 bytes edi_party_helper_oca/tests/__init__.py | 2 + edi_party_helper_oca/tests/common.py | 87 ++++++++++ .../tests/test_party_helper.py | 151 ++++++++++++++++++ .../tests/test_party_helper_model.py | 30 ++++ edi_party_helper_oca/utils.py | 94 +++++++++++ .../views/edi_exchange_type_views.xml | 14 ++ 18 files changed, 476 insertions(+) create mode 100644 edi_party_helper_oca/README.rst create mode 100644 edi_party_helper_oca/__init__.py create mode 100644 edi_party_helper_oca/__manifest__.py create mode 100644 edi_party_helper_oca/models/__init__.py create mode 100644 edi_party_helper_oca/models/edi_exchange_type.py create mode 100644 edi_party_helper_oca/models/edi_party_helper.py create mode 100644 edi_party_helper_oca/pyproject.toml create mode 100644 edi_party_helper_oca/readme/CONFIGURE.md create mode 100644 edi_party_helper_oca/readme/CONTRIBUTORS.md create mode 100644 edi_party_helper_oca/readme/DESCRIPTION.md create mode 100644 edi_party_helper_oca/readme/USAGE.md create mode 100644 edi_party_helper_oca/static/description/icon.png create mode 100644 edi_party_helper_oca/tests/__init__.py create mode 100644 edi_party_helper_oca/tests/common.py create mode 100644 edi_party_helper_oca/tests/test_party_helper.py create mode 100644 edi_party_helper_oca/tests/test_party_helper_model.py create mode 100644 edi_party_helper_oca/utils.py create mode 100644 edi_party_helper_oca/views/edi_exchange_type_views.xml diff --git a/edi_party_helper_oca/README.rst b/edi_party_helper_oca/README.rst new file mode 100644 index 000000000..aab07cbf9 --- /dev/null +++ b/edi_party_helper_oca/README.rst @@ -0,0 +1 @@ +bot please :) diff --git a/edi_party_helper_oca/__init__.py b/edi_party_helper_oca/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/edi_party_helper_oca/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/edi_party_helper_oca/__manifest__.py b/edi_party_helper_oca/__manifest__.py new file mode 100644 index 000000000..337a9bbfc --- /dev/null +++ b/edi_party_helper_oca/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "EDI Party helper", + "summary": """ + Retrieve party information for EDI exchanges, without any component + dependency. + """, + "version": "18.0.1.0.0", + "development_status": "Alpha", + "license": "AGPL-3", + "website": "https://github.com/OCA/edi-framework", + "author": "Camptocamp, Odoo Community Association (OCA)", + "maintainers": ["simahawk"], + "depends": ["edi_core_oca", "partner_identification"], + "data": [ + "views/edi_exchange_type_views.xml", + ], +} diff --git a/edi_party_helper_oca/models/__init__.py b/edi_party_helper_oca/models/__init__.py new file mode 100644 index 000000000..0eac27201 --- /dev/null +++ b/edi_party_helper_oca/models/__init__.py @@ -0,0 +1,2 @@ +from . import edi_exchange_type +from . import edi_party_helper diff --git a/edi_party_helper_oca/models/edi_exchange_type.py b/edi_party_helper_oca/models/edi_exchange_type.py new file mode 100644 index 000000000..669be755d --- /dev/null +++ b/edi_party_helper_oca/models/edi_exchange_type.py @@ -0,0 +1,15 @@ +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class EDIExchangeType(models.Model): + _inherit = "edi.exchange.type" + + id_category_ids = fields.Many2many( + string="ID categories", + comodel_name="res.partner.id_category", + help="Allowed ID categories to be used to generate parties information.", + ) diff --git a/edi_party_helper_oca/models/edi_party_helper.py b/edi_party_helper_oca/models/edi_party_helper.py new file mode 100644 index 000000000..814691d24 --- /dev/null +++ b/edi_party_helper_oca/models/edi_party_helper.py @@ -0,0 +1,24 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + +from ..utils import EDIParty + + +class EDIPartyHelper(models.AbstractModel): + """Provide partner data for exchanges, without any component dependency.""" + + _name = "edi.party.helper" + _description = "EDI Party Helper" + + def get_party(self, exchange_record, partner, **kw): + """Return the party for `partner` on `exchange_record`. + + :param exchange_record: an `edi.exchange.record` record + :param partner: a `res.partner` record + :param kw: forwarded to `EDIParty` (eg. `name_field`, `lang_code`) + :return: `EDIParty` + """ + return EDIParty(exchange_record=exchange_record, partner=partner, **kw) diff --git a/edi_party_helper_oca/pyproject.toml b/edi_party_helper_oca/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/edi_party_helper_oca/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/edi_party_helper_oca/readme/CONFIGURE.md b/edi_party_helper_oca/readme/CONFIGURE.md new file mode 100644 index 000000000..619baca8a --- /dev/null +++ b/edi_party_helper_oca/readme/CONFIGURE.md @@ -0,0 +1,6 @@ +## ID numbers selection + +On the exchange type form, find the field "ID categories" and set the +categories allowed for that exchange type. + +If not set, *all the IDs* of the partner will be exposed. diff --git a/edi_party_helper_oca/readme/CONTRIBUTORS.md b/edi_party_helper_oca/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..2b66303ae --- /dev/null +++ b/edi_party_helper_oca/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Simone Orsi \<\> diff --git a/edi_party_helper_oca/readme/DESCRIPTION.md b/edi_party_helper_oca/readme/DESCRIPTION.md new file mode 100644 index 000000000..fac36335a --- /dev/null +++ b/edi_party_helper_oca/readme/DESCRIPTION.md @@ -0,0 +1,7 @@ +Technical module to retrieve party information for EDI exchanges. + +It's based on partner_identification so that the party information will +include allowed ID numbers for a given exchange. + +You can configure which ID number categories are allowed on the exchange +type. diff --git a/edi_party_helper_oca/readme/USAGE.md b/edi_party_helper_oca/readme/USAGE.md new file mode 100644 index 000000000..738da5865 --- /dev/null +++ b/edi_party_helper_oca/readme/USAGE.md @@ -0,0 +1,18 @@ +Via the `edi.party.helper` abstract model: + + party = self.env["edi.party.helper"].get_party(exchange_record, partner) + +Or directly, with no ORM registry lookup involved: + + from odoo.addons.edi_party_helper_oca.utils import EDIParty + + party = EDIParty(exchange_record=exchange_record, partner=partner) + +Both return an `EDIParty` instance: the party data (`name`, `identifiers`, +`endpoint`, `lang`) is exposed directly as attributes, alongside `partner`. +It also behaves like a read-only dict of those same keys (`party["name"]`, +`dict(party)`, equality against a plain dict), for backward compatibility +with code expecting the old `DotDict`-based party data. + +Both accept the same optional keyword arguments: `name_field` (defaults to +`"name"`) and `lang_code` (a language code overriding the partner's own). diff --git a/edi_party_helper_oca/static/description/icon.png b/edi_party_helper_oca/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/edi_party_helper_oca/tests/__init__.py b/edi_party_helper_oca/tests/__init__.py new file mode 100644 index 000000000..95a6f190f --- /dev/null +++ b/edi_party_helper_oca/tests/__init__.py @@ -0,0 +1,2 @@ +from . import test_party_helper +from . import test_party_helper_model diff --git a/edi_party_helper_oca/tests/common.py b/edi_party_helper_oca/tests/common.py new file mode 100644 index 000000000..f1b1b321f --- /dev/null +++ b/edi_party_helper_oca/tests/common.py @@ -0,0 +1,87 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.tests.common import TransactionCase + +from odoo.addons.edi_core_oca.tests.common import EDIBackendTestMixin + + +class PartyHelperCommonTestCase(TransactionCase, EDIBackendTestMixin): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls._setup_env() + cls._setup_records() + cls.cat_model = cls.env["res.partner.id_category"] + cls.all_cat = cls.cat_model.browse() + for i in range(1, 4): + rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) + cls.all_cat += rec + setattr(cls, f"category{i}", rec) + + parent = cls.env["res.partner"].create( + { + "name": "ACME inc", + "is_company": True, + } + ) + + for i in range(1, 4): + rec = cls.env["res.partner"].create( + { + "name": f"Test Partner {i}", + "parent_id": parent.id, + "id_numbers": [ + ( + 0, + 0, + { + "name": f"{cat.code}-p{i}", + "category_id": cat.id, + }, + ) + for cat in cls.all_cat[i - 1 :] + ], + } + ) + setattr(cls, f"partner{i}", rec) + + # No need for special file name gen + cls.exc_type = cls._create_exchange_type( + name="ID output test", + code="id_out_test", + direction="output", + ) + cls.exc_record = cls.backend.create_record("id_out_test", {}) + + def _expected_lang(self, partner): + if not partner.lang: + return False + lang = self.env["res.lang"]._get_data(code=partner.lang) + if not lang: + return False + return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + + def _make_expected_data( + self, partner, number, allowed_codes=None, name_field="name", **kw + ): + data = { + "name": partner[name_field], + "identifiers": [ + {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, + {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, + {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, + ], + "endpoint": {}, + "lang": self._expected_lang(partner), + "partner": partner, + } + data.update(kw) + if allowed_codes: + data["identifiers"] = [ + x + for x in data["identifiers"] + if x["attrs"]["schemeID"] in allowed_codes + ] + return data diff --git a/edi_party_helper_oca/tests/test_party_helper.py b/edi_party_helper_oca/tests/test_party_helper.py new file mode 100644 index 000000000..dc3f93df2 --- /dev/null +++ b/edi_party_helper_oca/tests/test_party_helper.py @@ -0,0 +1,151 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from ..utils import EDIParty +from .common import PartyHelperCommonTestCase + + +class PartyDataHelperTestCase(PartyHelperCommonTestCase): + def _get_party(self, partner, **kw): + return EDIParty(exchange_record=self.exc_record, partner=partner, **kw) + + def test_lookup(self): + party = self._get_party(self.partner1) + self.assertEqual(party.partner, self.partner1) + self.assertFalse(party.allowed_id_categories) + + def test_data(self): + expected = ( + (self.partner1, self._make_expected_data(self.partner1, 1)), + ( + self.partner2, + self._make_expected_data( + self.partner2, 2, allowed_codes=["cat2", "cat3"] + ), + ), + ( + self.partner3, + self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_fullname_override(self): + # `name` is the default `name_field` since it doesn't embed + # multi-company/disambiguation suffixes the way `display_name` does; + # `display_name` is still available by explicit override. + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, name_field="display_name"), + ), + ( + self.partner2, + self._make_expected_data( + self.partner2, + 2, + allowed_codes=["cat2", "cat3"], + name_field="display_name", + ), + ), + ( + self.partner3, + self._make_expected_data( + self.partner3, 3, allowed_codes=["cat3"], name_field="display_name" + ), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner, name_field="display_name") + self.assertEqual(party, expected_data) + + def test_lang(self): + # No lang set on the partner -> `lang` is falsy. + self.partner1.lang = False + party = self._get_party(self.partner1) + self.assertFalse(party.lang) + # Partner's own lang is used by default. + self.partner1.lang = "en_US" + party = self._get_party(self.partner1) + self.assertEqual( + party.lang, + {"name": "English (US)", "code": "en_US", "short": "en"}, + ) + # Explicit `lang_code` takes precedence over the partner's own lang. + self.partner2.lang = False + party = self._get_party(self.partner2, lang_code="en_US") + self.assertEqual( + party.lang, + {"name": "English (US)", "code": "en_US", "short": "en"}, + ) + + def test_partner_in_party_data(self): + party = self._get_party(self.partner1) + self.assertEqual(party.partner, self.partner1) + + def test_mapping_access(self): + # `EDIParty` behaves like a read-only dict too, for backward + # compatibility with the old `DotDict`-based party data. + party = self._get_party(self.partner1) + self.assertEqual(party["name"], party.name) + self.assertEqual(party["partner"], self.partner1) + self.assertEqual( + set(party.keys()), set(self._make_expected_data(self.partner1, 1)) + ) + self.assertEqual(dict(party), self._make_expected_data(self.partner1, 1)) + with self.assertRaises(KeyError): + party["allowed_id_categories"] # pylint: disable=pointless-statement + + def test_data_limited_1(self): + self.exc_type.id_category_ids = self.category1 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat1"]), + ), + (self.partner2, self._make_expected_data(self.partner2, 2, identifiers=[])), + (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_limited_2(self): + self.exc_type.id_category_ids = self.category2 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat2"]), + ), + ( + self.partner2, + self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]), + ), + (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_limited_3(self): + self.exc_type.id_category_ids = self.category3 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat3"]), + ), + ( + self.partner2, + self._make_expected_data(self.partner2, 2, allowed_codes=["cat3"]), + ), + ( + self.partner3, + self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) diff --git a/edi_party_helper_oca/tests/test_party_helper_model.py b/edi_party_helper_oca/tests/test_party_helper_model.py new file mode 100644 index 000000000..ef0fa918c --- /dev/null +++ b/edi_party_helper_oca/tests/test_party_helper_model.py @@ -0,0 +1,30 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from .common import PartyHelperCommonTestCase + +# Business logic is tested against `EDIParty` directly in +# `test_party_helper.py`. This suite only exercises the `edi.party.helper` +# abstract model wiring on top of it. + + +class PartyHelperModelTestCase(PartyHelperCommonTestCase): + def _get_party(self, partner, **kw): + return self.env["edi.party.helper"].get_party(self.exc_record, partner, **kw) + + def test_data(self): + expected = self._make_expected_data(self.partner1, 1) + party = self._get_party(self.partner1) + self.assertEqual(party, expected) + + def test_data_name_field_override(self): + expected = self._make_expected_data(self.partner1, 1, name_field="display_name") + party = self._get_party(self.partner1, name_field="display_name") + self.assertEqual(party, expected) + + def test_data_limited(self): + self.exc_type.id_category_ids = self.category2 + expected = self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]) + party = self._get_party(self.partner2) + self.assertEqual(party, expected) diff --git a/edi_party_helper_oca/utils.py b/edi_party_helper_oca/utils.py new file mode 100644 index 000000000..302159009 --- /dev/null +++ b/edi_party_helper_oca/utils.py @@ -0,0 +1,94 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from collections.abc import Mapping +from dataclasses import dataclass + +from odoo.tools import DotDict + + +@dataclass(eq=False) +class EDIParty(Mapping): + """Party information for an EDI exchange. + + The instance itself *is* the party: `name`, `identifiers`, `endpoint` + and `lang` are computed on init and exposed as plain attributes, + alongside `partner`. It also behaves like a read-only mapping of those + (eg: ``party["name"]``, ``dict(party)``, equality against a plain dict) + for backward compatibility with code expecting the old + ``DotDict``-based party data. + """ + + exchange_record: object + partner: object + name_field: str = "name" + lang_code: str | bool = False + #: constructor/config attributes, not part of the party data itself: + #: excluded from the Mapping interface (dict-like access / equality). + _non_party_attrs = frozenset( + {"exchange_record", "name_field", "lang_code", "allowed_id_categories"} + ) + + def __post_init__(self): + self.allowed_id_categories = self.exchange_record.type_id.id_category_ids + # NB: for UBL this should probably replace + # `base.ubl._ubl_get_party_identification` which does nothing today. + self.name = self._get_name() + self.identifiers = self._get_identifiers() + self.endpoint = self._get_endpoint() + self.lang = self._get_lang() + + @property + def env(self): + return self.exchange_record.env + + def _party_data_keys(self): + return [k for k in vars(self) if k not in self._non_party_attrs] + + def __getitem__(self, key): + if key in self._non_party_attrs or key not in vars(self): + raise KeyError(key) + return getattr(self, key) + + def __iter__(self): + return iter(self._party_data_keys()) + + def __len__(self): + return len(self._party_data_keys()) + + def _get_name(self): + return self.partner[self.name_field] + + def _get_endpoint(self): + return {} + + def _get_identifiers(self): + identifiers = self.partner.id_numbers.filtered( + lambda x: self._filter_id_number(x) + ) + return [self._get_identity(x) for x in identifiers] + + def _filter_id_number(self, id_number): + if self.allowed_id_categories: + return id_number.category_id in self.allowed_id_categories + return True + + def _get_identity(self, id_number): + return DotDict( + attrs={ + "schemeID": id_number.category_id.code, + }, + value=id_number.name, + ) + + def _get_lang(self): + lang_code = self.lang_code or self.partner.lang + if not lang_code: + return False + lang = self.env["res.lang"]._get_data(code=lang_code) + if not lang: + return False + return DotDict( + {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + ) diff --git a/edi_party_helper_oca/views/edi_exchange_type_views.xml b/edi_party_helper_oca/views/edi_exchange_type_views.xml new file mode 100644 index 000000000..2b8f121e9 --- /dev/null +++ b/edi_party_helper_oca/views/edi_exchange_type_views.xml @@ -0,0 +1,14 @@ + + + + edi.exchange.type + + + + + + + + + + From ca52ac532976ec1f8412b7c079177ed7693cab51 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Mon, 24 Aug 2026 14:42:06 +0200 Subject: [PATCH 2/3] [REF] edi_party_data_oca: use edi_party_helper_oca --- edi_party_data_oca/__init__.py | 1 - edi_party_data_oca/__manifest__.py | 5 +- edi_party_data_oca/components/common.py | 73 ++---- edi_party_data_oca/models/__init__.py | 1 - .../models/edi_exchange_type.py | 15 -- edi_party_data_oca/readme/CONFIGURE.md | 5 +- edi_party_data_oca/readme/DESCRIPTION.md | 9 +- edi_party_data_oca/readme/USAGE.md | 3 + edi_party_data_oca/tests/common.py | 84 +++++++ edi_party_data_oca/tests/test_party_data.py | 216 ++---------------- .../views/edi_exchange_type_views.xml | 14 -- 11 files changed, 136 insertions(+), 290 deletions(-) delete mode 100644 edi_party_data_oca/models/__init__.py delete mode 100644 edi_party_data_oca/models/edi_exchange_type.py create mode 100644 edi_party_data_oca/tests/common.py delete mode 100644 edi_party_data_oca/views/edi_exchange_type_views.xml diff --git a/edi_party_data_oca/__init__.py b/edi_party_data_oca/__init__.py index f24d3e242..1377f57f5 100644 --- a/edi_party_data_oca/__init__.py +++ b/edi_party_data_oca/__init__.py @@ -1,2 +1 @@ from . import components -from . import models diff --git a/edi_party_data_oca/__manifest__.py b/edi_party_data_oca/__manifest__.py index db324b74a..b3fe7f8ec 100644 --- a/edi_party_data_oca/__manifest__.py +++ b/edi_party_data_oca/__manifest__.py @@ -12,8 +12,5 @@ "website": "https://github.com/OCA/edi-framework", "author": "Camptocamp, Odoo Community Association (OCA)", "maintainers": ["simahawk"], - "depends": ["edi_component_oca", "partner_identification"], - "data": [ - "views/edi_exchange_type_views.xml", - ], + "depends": ["edi_component_oca", "edi_party_helper_oca"], } diff --git a/edi_party_data_oca/components/common.py b/edi_party_data_oca/components/common.py index ad088a690..4e808e10c 100644 --- a/edi_party_data_oca/components/common.py +++ b/edi_party_data_oca/components/common.py @@ -2,13 +2,19 @@ # @author: Simone Orsi # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -from odoo.tools import DotDict - from odoo.addons.component.core import AbstractComponent class EDIExchangePartyDataMixin(AbstractComponent): - """Abstract component mixin provide partner data for exchanges.""" + """Abstract component mixin provide partner data for exchanges. + + .. deprecated:: + Business logic lives in the `edi_party_helper_oca` module, which has + no component dependency: `EDIParty` (plain dataclass) or the + `edi.party.helper` abstract model. This component only wraps it for + backward compatibility and will be dropped once its usages are + ported over. + """ _name = "edi.party.data.mixin" _inherit = "edi.component.mixin" @@ -25,59 +31,20 @@ def _get_partner(self): # based on current partner (eg: pick the parent). return self.work.partner + def _get_party(self): + return self.env["edi.party.helper"].get_party( + self.exchange_record, + self.partner, + name_field=getattr(self.work, "party_data_name_field", "name"), + lang_code=getattr(self.work, "lang", False), + ) + def get_party(self): """Return party information. Requires a res.partner to be passed via work context. - :return: odoo.tools.DotDict + :return: `EDIParty` (behaves like a read-only dict too, for + backward compatibility with the old ``DotDict``-based return) """ - return self._party_from_partner() - - def _party_from_partner(self, **kw): - # NB: for UBL this should probably replace - # `base.ubl._ubl_get_party_identification` which does nothing today. - party = DotDict( - name=self._get_name(), - identifiers=self._get_identifiers(), - endpoint=self._get_endpoint(), - lang=self._get_lang(), - partner=self.partner, - ) - party.update(kw) - return party - - def _get_name(self): - name_field = getattr(self.work, "party_data_name_field", "name") - return self.partner[name_field] - - def _get_endpoint(self): - return {} - - def _get_identifiers(self): - identifiers = self.partner.id_numbers.filtered( - lambda x: self._filter_id_number(x) - ) - return [self._get_indentity(x) for x in identifiers] - - def _filter_id_number(self, id_number): - if self.allowed_id_categories: - return id_number.category_id in self.allowed_id_categories - return True - - def _get_indentity(self, id_number): - return DotDict( - attrs={ - "schemeID": id_number.category_id.code, - }, - value=id_number.name, - ) - - def _get_lang(self): - lang_code = getattr(self.work, "lang", False) or self.partner.lang - if not lang_code: - return False - lang = self.env["res.lang"]._get_data(code=lang_code) - if not lang: - return False - return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + return self._get_party() diff --git a/edi_party_data_oca/models/__init__.py b/edi_party_data_oca/models/__init__.py deleted file mode 100644 index 719704f71..000000000 --- a/edi_party_data_oca/models/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from . import edi_exchange_type diff --git a/edi_party_data_oca/models/edi_exchange_type.py b/edi_party_data_oca/models/edi_exchange_type.py deleted file mode 100644 index 669be755d..000000000 --- a/edi_party_data_oca/models/edi_exchange_type.py +++ /dev/null @@ -1,15 +0,0 @@ -# Copyright 2022 Camptocamp SA -# @author Simone Orsi -# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). - -from odoo import fields, models - - -class EDIExchangeType(models.Model): - _inherit = "edi.exchange.type" - - id_category_ids = fields.Many2many( - string="ID categories", - comodel_name="res.partner.id_category", - help="Allowed ID categories to be used to generate parties information.", - ) diff --git a/edi_party_data_oca/readme/CONFIGURE.md b/edi_party_data_oca/readme/CONFIGURE.md index cde50ad1d..ed7071d24 100644 --- a/edi_party_data_oca/readme/CONFIGURE.md +++ b/edi_party_data_oca/readme/CONFIGURE.md @@ -1,9 +1,6 @@ ## ID numbers selection -On the exchange type form, find the field "ID categories" and set the -categories allowed for that exchange type. - -If not set, *all the IDs* of the partner will be exposed. +See `edi_party_helper_oca`'s configuration. ## Name field diff --git a/edi_party_data_oca/readme/DESCRIPTION.md b/edi_party_data_oca/readme/DESCRIPTION.md index 7bc4f6988..d55954476 100644 --- a/edi_party_data_oca/readme/DESCRIPTION.md +++ b/edi_party_data_oca/readme/DESCRIPTION.md @@ -4,8 +4,7 @@ of an exchange. This module provides default component and a mixin to be used for registering new components for specific backends. -It's based on partner_identification so that the party information will -include allowed ID numbers for a given exchange. - -You can configure which ID number categories are allowed on the exchange -type. +**Deprecated**: the actual party data lookup logic has moved to +`edi_party_helper_oca`, which has no dependency on the `component` +framework. This module now only wraps it in a component for backward +compatibility and will be removed once its usages are ported over. diff --git a/edi_party_data_oca/readme/USAGE.md b/edi_party_data_oca/readme/USAGE.md index b2c95694c..35c339292 100644 --- a/edi_party_data_oca/readme/USAGE.md +++ b/edi_party_data_oca/readme/USAGE.md @@ -5,3 +5,6 @@ An handy util method is to retrive the component: component = get_party_data_component(exchange_record, partner) data = component.get_party() + +**Deprecated**: prefer `edi_party_helper_oca`'s `edi.party.helper` model or +its `EDIParty` class directly, they don't require any component lookup. diff --git a/edi_party_data_oca/tests/common.py b/edi_party_data_oca/tests/common.py new file mode 100644 index 000000000..9a423f967 --- /dev/null +++ b/edi_party_data_oca/tests/common.py @@ -0,0 +1,84 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.addons.edi_component_oca.tests.common import EDIBackendCommonComponentTestCase + + +class PartyDataCommonTestCase(EDIBackendCommonComponentTestCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.backend = cls.env.ref("edi_core_oca.demo_edi_backend") + cls.cat_model = cls.env["res.partner.id_category"] + cls.all_cat = cls.cat_model.browse() + for i in range(1, 4): + rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) + cls.all_cat += rec + setattr(cls, f"category{i}", rec) + + parent = cls.env["res.partner"].create( + { + "name": "ACME inc", + "is_company": True, + } + ) + + for i in range(1, 4): + rec = cls.env["res.partner"].create( + { + "name": f"Test Partner {i}", + "parent_id": parent.id, + "id_numbers": [ + ( + 0, + 0, + { + "name": f"{cat.code}-p{i}", + "category_id": cat.id, + }, + ) + for cat in cls.all_cat[i - 1 :] + ], + } + ) + setattr(cls, f"partner{i}", rec) + + # No need for special file name gen + cls.exc_type = cls._create_exchange_type( + name="ID output test", + code="id_out_test", + direction="output", + ) + cls.exc_record = cls.backend.create_record("id_out_test", {}) + + def _expected_lang(self, partner): + if not partner.lang: + return False + lang = self.env["res.lang"]._get_data(code=partner.lang) + if not lang: + return False + return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + + def _make_expected_data( + self, partner, number, allowed_codes=None, name_field="name", **kw + ): + data = { + "name": partner[name_field], + "identifiers": [ + {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, + {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, + {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, + ], + "endpoint": {}, + "lang": self._expected_lang(partner), + "partner": partner, + } + data.update(kw) + if allowed_codes: + data["identifiers"] = [ + x + for x in data["identifiers"] + if x["attrs"]["schemeID"] in allowed_codes + ] + return data diff --git a/edi_party_data_oca/tests/test_party_data.py b/edi_party_data_oca/tests/test_party_data.py index 7d1484cd5..c115773fa 100644 --- a/edi_party_data_oca/tests/test_party_data.py +++ b/edi_party_data_oca/tests/test_party_data.py @@ -2,161 +2,45 @@ # @author: Simone Orsi # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -from odoo.addons.edi_component_oca.tests.common import EDIBackendCommonComponentTestCase - from ..utils import get_party_data_component +from .common import PartyDataCommonTestCase +# Business logic is tested against the component-independent helper in +# `test_party_helper.py`. This suite only exercises the component wiring +# (work context plumbing, hooks) on top of it. -class PartyDataTestCase(EDIBackendCommonComponentTestCase): - @classmethod - def setUpClass(cls): - super().setUpClass() - cls.backend = cls.env.ref("edi_core_oca.demo_edi_backend") - cls.cat_model = cls.env["res.partner.id_category"] - cls.all_cat = cls.cat_model.browse() - for i in range(1, 4): - rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) - cls.all_cat += rec - setattr(cls, f"category{i}", rec) - - parent = cls.env["res.partner"].create( - { - "name": "ACME inc", - "is_company": True, - } - ) - - for i in range(1, 4): - rec = cls.env["res.partner"].create( - { - "name": f"Test Partner {i}", - "parent_id": parent.id, - "id_numbers": [ - ( - 0, - 0, - { - "name": f"{cat.code}-p{i}", - "category_id": cat.id, - }, - ) - for cat in cls.all_cat[i - 1 :] - ], - } - ) - setattr(cls, f"partner{i}", rec) - - # No need for special file name gen - cls.exc_type = cls._create_exchange_type( - name="ID output test", - code="id_out_test", - direction="output", - ) - cls.exc_record = cls.backend.create_record("id_out_test", {}) +class PartyDataTestCase(PartyDataCommonTestCase): def _get_provider(self, partner, **kw): return get_party_data_component(self.exc_record, partner, **kw) - def _expected_lang(self, partner): - if not partner.lang: - return False - lang = self.env["res.lang"]._get_data(code=partner.lang) - if not lang: - return False - return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} - - def _make_expected_data( - self, partner, number, allowed_codes=None, name_field="name", **kw - ): - data = { - "name": partner[name_field], - "identifiers": [ - {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, - {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, - {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, - ], - "endpoint": {}, - "lang": self._expected_lang(partner), - "partner": partner, - } - data.update(kw) - if allowed_codes: - data["identifiers"] = [ - x - for x in data["identifiers"] - if x["attrs"]["schemeID"] in allowed_codes - ] - return data - def test_lookup(self): provider = self._get_provider(self.partner1) self.assertEqual(provider.partner, self.partner1) self.assertFalse(provider.allowed_id_categories) def test_data(self): - expected = ( - (self.partner1, self._make_expected_data(self.partner1, 1)), - ( - self.partner2, - self._make_expected_data( - self.partner2, 2, allowed_codes=["cat2", "cat3"] - ), - ), - ( - self.partner3, - self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) + expected = self._make_expected_data(self.partner1, 1) + provider = self._get_provider(self.partner1) + self.assertEqual(provider.get_party(), expected) - def test_data_fullname_override(self): - # `name` is the default `party_data_name_field` since it doesn't embed - # multi-company/disambiguation suffixes the way `display_name` does; - # `display_name` is still available by explicit override. - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, name_field="display_name"), - ), - ( - self.partner2, - self._make_expected_data( - self.partner2, - 2, - allowed_codes=["cat2", "cat3"], - name_field="display_name", - ), - ), - ( - self.partner3, - self._make_expected_data( - self.partner3, 3, allowed_codes=["cat3"], name_field="display_name" - ), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider( - partner, work_ctx={"party_data_name_field": "display_name"} - ) - res = provider.get_party() - self.assertEqual(res, expected_data) + def test_data_limited(self): + self.exc_type.id_category_ids = self.category2 + expected = self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]) + provider = self._get_provider(self.partner2) + self.assertEqual(provider.get_party(), expected) - def test_lang(self): - # No lang set on the partner -> no `lang` key rendered. - self.partner1.lang = False - provider = self._get_provider(self.partner1) - self.assertFalse(provider.get_party()["lang"]) - # Partner's own lang is used by default. - self.partner1.lang = "en_US" - provider = self._get_provider(self.partner1) - self.assertEqual( - provider.get_party()["lang"], - {"name": "English (US)", "code": "en_US", "short": "en"}, + def test_data_name_field_override(self): + # `party_data_name_field` on the work context is forwarded to the + # party's `name_field`. + expected = self._make_expected_data(self.partner1, 1, name_field="display_name") + provider = self._get_provider( + self.partner1, work_ctx={"party_data_name_field": "display_name"} ) - # `work_ctx["lang"]` takes precedence over the partner's own lang. + self.assertEqual(provider.get_party(), expected) + + def test_lang_override_via_work_ctx(self): + # `lang` on the work context is forwarded to the party's `lang_code`. self.partner2.lang = False provider = self._get_provider(self.partner2, work_ctx={"lang": "en_US"}) self.assertEqual( @@ -167,57 +51,3 @@ def test_lang(self): def test_partner_in_party_data(self): provider = self._get_provider(self.partner1) self.assertEqual(provider.get_party()["partner"], self.partner1) - - def test_data_limited_1(self): - self.exc_type.id_category_ids = self.category1 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat1"]), - ), - (self.partner2, self._make_expected_data(self.partner2, 2, identifiers=[])), - (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) - - def test_data_limited_2(self): - self.exc_type.id_category_ids = self.category2 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat2"]), - ), - ( - self.partner2, - self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]), - ), - (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) - - def test_data_limited_3(self): - self.exc_type.id_category_ids = self.category3 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat3"]), - ), - ( - self.partner2, - self._make_expected_data(self.partner2, 2, allowed_codes=["cat3"]), - ), - ( - self.partner3, - self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) diff --git a/edi_party_data_oca/views/edi_exchange_type_views.xml b/edi_party_data_oca/views/edi_exchange_type_views.xml deleted file mode 100644 index 2b8f121e9..000000000 --- a/edi_party_data_oca/views/edi_exchange_type_views.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - edi.exchange.type - - - - - - - - - - From 21c280d61bfc131cfd4d8fee90a1153f29d2d8d8 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Mon, 24 Aug 2026 14:42:30 +0200 Subject: [PATCH 3/3] *party_data*: deprecate modules --- edi_exchange_template_party_data/README.rst | 7 +++++++ edi_exchange_template_party_data/__init__.py | 1 + edi_exchange_template_party_data/__manifest__.py | 2 +- edi_exchange_template_party_data/hooks.py | 13 +++++++++++++ .../readme/DESCRIPTION.md | 7 +++++++ edi_party_data_oca/README.rst | 11 ++++++----- edi_party_data_oca/__init__.py | 1 + edi_party_data_oca/__manifest__.py | 1 + edi_party_data_oca/hooks.py | 13 +++++++++++++ edi_party_data_oca/readme/DESCRIPTION.md | 4 +++- 10 files changed, 53 insertions(+), 7 deletions(-) create mode 100644 edi_exchange_template_party_data/hooks.py create mode 100644 edi_party_data_oca/hooks.py diff --git a/edi_exchange_template_party_data/README.rst b/edi_exchange_template_party_data/README.rst index b52a821b9..b58485146 100644 --- a/edi_exchange_template_party_data/README.rst +++ b/edi_exchange_template_party_data/README.rst @@ -37,6 +37,13 @@ Glue module betweeb edi_exchange_template and edi_party_data. Exposes a get_party_data function to the rendering context of the template. This way you can retrieve party data on the fly. +**Deprecated**: `edi_party_data_oca` (and this glue module) are superseded +by `edi_party_helper_oca`, which has no dependency on the `component` +framework. Use its `edi.party.helper` model (or the `EDIParty` class +directly) instead of the `get_party_data` render context shortcut. A +deprecation notice is logged on server startup while this module is +installed. It is also no longer auto-installed. + .. IMPORTANT:: This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. diff --git a/edi_exchange_template_party_data/__init__.py b/edi_exchange_template_party_data/__init__.py index 0650744f6..5bf67492b 100644 --- a/edi_exchange_template_party_data/__init__.py +++ b/edi_exchange_template_party_data/__init__.py @@ -1 +1,2 @@ from . import models +from .hooks import post_load_hook diff --git a/edi_exchange_template_party_data/__manifest__.py b/edi_exchange_template_party_data/__manifest__.py index 20c19a138..8c0eeaea3 100644 --- a/edi_exchange_template_party_data/__manifest__.py +++ b/edi_exchange_template_party_data/__manifest__.py @@ -11,5 +11,5 @@ "maintainers": ["simahawk"], "website": "https://github.com/OCA/edi-framework", "depends": ["edi_exchange_template_oca", "edi_party_data_oca"], - "auto_install": True, + "post_load_hook": "post_load_hook", } diff --git a/edi_exchange_template_party_data/hooks.py b/edi_exchange_template_party_data/hooks.py new file mode 100644 index 000000000..ca1fa368f --- /dev/null +++ b/edi_exchange_template_party_data/hooks.py @@ -0,0 +1,13 @@ +import logging + +_logger = logging.getLogger(__name__) + + +def post_load_hook(): + _logger.info( + "`edi_exchange_template_party_data` is deprecated and will be removed. " + "`edi_party_data_oca` (and this glue module) are superseded by " + "`edi_party_helper_oca`: use its `edi.party.helper` model (or the " + "`EDIParty` class directly) instead of the `get_party_data` render " + "context shortcut." + ) diff --git a/edi_exchange_template_party_data/readme/DESCRIPTION.md b/edi_exchange_template_party_data/readme/DESCRIPTION.md index d308ac97f..fe7c15aa5 100644 --- a/edi_exchange_template_party_data/readme/DESCRIPTION.md +++ b/edi_exchange_template_party_data/readme/DESCRIPTION.md @@ -2,3 +2,10 @@ Glue module betweeb edi_exchange_template and edi_party_data. Exposes a get_party_data function to the rendering context of the template. This way you can retrieve party data on the fly. + +**Deprecated**: `edi_party_data_oca` (and this glue module) are superseded +by `edi_party_helper_oca`, which has no dependency on the `component` +framework. Use its `edi.party.helper` model (or the `EDIParty` class +directly) instead of the `get_party_data` render context shortcut. A +deprecation notice is logged on server startup while this module is +installed. It is also no longer auto-installed. diff --git a/edi_party_data_oca/README.rst b/edi_party_data_oca/README.rst index 7ce4a726b..a126b2b66 100644 --- a/edi_party_data_oca/README.rst +++ b/edi_party_data_oca/README.rst @@ -38,11 +38,12 @@ of an exchange. This module provides default component and a mixin to be used for registering new components for specific backends. -It's based on partner_identification so that the party information will -include allowed ID numbers for a given exchange. - -You can configure which ID number categories are allowed on the exchange -type. +**Deprecated**: the actual party data lookup logic has moved to +`edi_party_helper_oca`, which has no dependency on the `component` +framework. This module now only wraps it in a component for backward +compatibility and will be removed once its usages are ported over. A +deprecation notice is logged on server startup while this module is +installed. .. IMPORTANT:: This is an alpha version, the data model and design can change at any time without warning. diff --git a/edi_party_data_oca/__init__.py b/edi_party_data_oca/__init__.py index 1377f57f5..d891f65b2 100644 --- a/edi_party_data_oca/__init__.py +++ b/edi_party_data_oca/__init__.py @@ -1 +1,2 @@ from . import components +from .hooks import post_load_hook diff --git a/edi_party_data_oca/__manifest__.py b/edi_party_data_oca/__manifest__.py index b3fe7f8ec..12f847b8d 100644 --- a/edi_party_data_oca/__manifest__.py +++ b/edi_party_data_oca/__manifest__.py @@ -13,4 +13,5 @@ "author": "Camptocamp, Odoo Community Association (OCA)", "maintainers": ["simahawk"], "depends": ["edi_component_oca", "edi_party_helper_oca"], + "post_load_hook": "post_load_hook", } diff --git a/edi_party_data_oca/hooks.py b/edi_party_data_oca/hooks.py new file mode 100644 index 000000000..5903417d7 --- /dev/null +++ b/edi_party_data_oca/hooks.py @@ -0,0 +1,13 @@ +import logging + +_logger = logging.getLogger(__name__) + + +def post_load_hook(): + _logger.info( + "`edi_party_data_oca` is deprecated and will be removed. Its " + "`edi.party.data.mixin` component is superseded by " + "`edi_party_helper_oca`: use its `edi.party.helper` model (or the " + "`EDIParty` class directly) instead, they don't require any " + "component lookup." + ) diff --git a/edi_party_data_oca/readme/DESCRIPTION.md b/edi_party_data_oca/readme/DESCRIPTION.md index d55954476..a8e6d356a 100644 --- a/edi_party_data_oca/readme/DESCRIPTION.md +++ b/edi_party_data_oca/readme/DESCRIPTION.md @@ -7,4 +7,6 @@ registering new components for specific backends. **Deprecated**: the actual party data lookup logic has moved to `edi_party_helper_oca`, which has no dependency on the `component` framework. This module now only wraps it in a component for backward -compatibility and will be removed once its usages are ported over. +compatibility and will be removed once its usages are ported over. A +deprecation notice is logged on server startup while this module is +installed.