From 5bda3a8a9d3c0a06c2fb06c79e35dbccc6c168b2 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Sat, 10 Oct 2026 17:18:58 +0200 Subject: [PATCH] [ADD] endpoint_spec Declare endpoints on any class (eg: services), not only on controllers: metadata read by routes generators (see endpoint_route_handler). * `endpoint` decorator: metadata only, never wraps the method; specs are inherited, `endpoint.extend` updates them on overrides * `EndpointSpec` / `collect_endpoints` * `Conventions`: explicit endpoints only by default, subclass it to expose non decorated methods (as a transition) No dependency on any dispatcher. --- endpoint_spec/README.rst | 1 + endpoint_spec/__init__.py | 0 endpoint_spec/__manifest__.py | 14 ++ endpoint_spec/endpoint.py | 207 ++++++++++++++++++++++ endpoint_spec/pyproject.toml | 3 + endpoint_spec/readme/CONTRIBUTORS.md | 1 + endpoint_spec/readme/DESCRIPTION.md | 12 ++ endpoint_spec/readme/USAGE.md | 38 ++++ endpoint_spec/static/description/icon.png | Bin 0 -> 9455 bytes endpoint_spec/tests/__init__.py | 1 + endpoint_spec/tests/test_endpoint.py | 104 +++++++++++ 11 files changed, 381 insertions(+) create mode 100644 endpoint_spec/README.rst create mode 100644 endpoint_spec/__init__.py create mode 100644 endpoint_spec/__manifest__.py create mode 100644 endpoint_spec/endpoint.py create mode 100644 endpoint_spec/pyproject.toml create mode 100644 endpoint_spec/readme/CONTRIBUTORS.md create mode 100644 endpoint_spec/readme/DESCRIPTION.md create mode 100644 endpoint_spec/readme/USAGE.md create mode 100644 endpoint_spec/static/description/icon.png create mode 100644 endpoint_spec/tests/__init__.py create mode 100644 endpoint_spec/tests/test_endpoint.py diff --git a/endpoint_spec/README.rst b/endpoint_spec/README.rst new file mode 100644 index 00000000..b6790cf4 --- /dev/null +++ b/endpoint_spec/README.rst @@ -0,0 +1 @@ +waiting the bot :) diff --git a/endpoint_spec/__init__.py b/endpoint_spec/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/endpoint_spec/__manifest__.py b/endpoint_spec/__manifest__.py new file mode 100644 index 00000000..282a8a9a --- /dev/null +++ b/endpoint_spec/__manifest__.py @@ -0,0 +1,14 @@ +# Copyright 2026 Camptocamp SA +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +{ + "name": "Endpoint spec", + "summary": "Declare endpoints on any class: metadata for routes generators.", + "version": "18.0.1.0.0", + "license": "LGPL-3", + "development_status": "Alpha", + "author": "Camptocamp,Odoo Community Association (OCA)", + "maintainers": ["simahawk"], + "website": "https://github.com/OCA/web-api", + "depends": ["base"], +} diff --git a/endpoint_spec/endpoint.py b/endpoint_spec/endpoint.py new file mode 100644 index 00000000..76439beb --- /dev/null +++ b/endpoint_spec/endpoint.py @@ -0,0 +1,207 @@ +# Copyright 2026 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). +"""Declare endpoints on classes that are not controllers. + +Controllers declare their routes w/ `odoo.http.route`. +This module is for service-like classes whose methods are turned into +routes by a generator (see `endpoint_route_handler` generators): + + class MyService: + + @endpoint("GET", path="/") + def get(self, id): + ... + + @endpoint(input=MyParam(), output=MyParam()) + def scan(self, barcode): + ... + + specs = collect_endpoints(MyService) + +The decorator only declares metadata: it never wraps the method. +Validation happens in the dispatcher, at the HTTP boundary. +Hence, methods can call each other and tests can call them directly. +""" + +import dataclasses +import inspect +from collections.abc import Mapping +from typing import Any + +ENDPOINT_ATTR = "_endpoint_spec" +ENDPOINT_EXTEND_ATTR = "_endpoint_spec_extend" + + +@dataclasses.dataclass(frozen=True) +class EndpointRoute: + """Paths served with the same HTTP methods.""" + + paths: tuple + methods: tuple + + +@dataclasses.dataclass(frozen=True) +class EndpointSpec: + """Metadata of an endpoint. + + :param routes: tuple of `EndpointRoute`. + Paths are relative to the root of the generator. + When no route is given, conventions provide the default one. + :param methods: HTTP methods to use for the default route + :param input: param object for request params (eg: an `http_api_dispatcher` param) + :param output: param object for the result + :param routing: any other routing key (auth, cors, csrf, api_doc, ...) + """ + + routes: tuple = () + methods: tuple = () + input: Any = None + output: Any = None + routing: Mapping = dataclasses.field(default_factory=dict) + + def merge(self, **values): + """Return a new spec updated with given values. + + `routing` values are merged, other values are replaced. + """ + if "routing" in values: + values["routing"] = dict(self.routing, **values["routing"]) + return dataclasses.replace(self, **values) + + +def _as_tuple(value): + """Normalize a single value or an iterable to a tuple.""" + if value is None: + return () + if isinstance(value, str): + return (value,) + return tuple(value) + + +def endpoint(methods="POST", path=None, input=None, output=None, **routing): + """Declare a method as endpoint. + + :param methods: HTTP method(s) + :param path: path(s) relative to the root of the generator. + If not given, conventions provide the default path. + :param input: param object for request params + :param output: param object for the result + :param routing: any other routing key (auth, cors, csrf, api_doc, ...) + """ + methods = _as_tuple(methods) + routes = () + if path: + routes = (EndpointRoute(paths=_as_tuple(path), methods=methods),) + spec = EndpointSpec( + routes=routes, methods=methods, input=input, output=output, routing=routing + ) + + def deco(func): + """Store the spec on the function, untouched.""" + setattr(func, ENDPOINT_ATTR, spec) + return func + + return deco + + +def extend(**values): + """Update the spec inherited from parent classes. + + Use it on overrides to change only some values: + + @endpoint.extend(routing={"api_doc": {"tags": ["new"]}}) + def scan(self, barcode): + return super().scan(barcode) + """ + + def deco(func): + """Store the values to merge into the inherited spec.""" + setattr(func, ENDPOINT_EXTEND_ATTR, values) + return func + + return deco + + +endpoint.extend = extend + + +def find_spec(cls, name): + """Return the spec of method `name` looking up the class hierarchy. + + An override without decorator keeps the spec of its parent. + `endpoint.extend` updates on overrides are applied + from the parent to the child. + """ + extensions = [] + for klass in cls.__mro__: + func = klass.__dict__.get(name) + if func is None: + continue + func = getattr(func, "__func__", func) + ext = getattr(func, ENDPOINT_EXTEND_ATTR, None) + if ext: + extensions.append(ext) + spec = getattr(func, ENDPOINT_ATTR, None) + if spec is not None: + for ext in reversed(extensions): + spec = spec.merge(**ext) + return spec + return None + + +def public_methods(cls): + """Return `(name, func)` of public methods without triggering properties.""" + res = [] + for attr in inspect.classify_class_attrs(cls): + if attr.kind != "method" or attr.name.startswith("_"): + continue + res.append((attr.name, getattr(cls, attr.name))) + return sorted(res) + + +class Conventions: + """Provide defaults for endpoint specs. + + The base class exposes only decorated methods + and uses `/` as default path. + This is the recommended behavior: endpoints are declared explicitly. + + Subclasses can expose non decorated methods via `guess`. + This is meant only as a transition, eg: to migrate services from `base_rest` + (see `ShopfloorConventions` in `shopfloor_base`). + """ + + def guess(self, cls, name, func): + """Return a spec for a non decorated method or None to skip it.""" + return None + + def default_routes(self, cls, name, func, methods=None): + """Default route: POST (or given methods) on `/`.""" + methods = _as_tuple(methods) or ("POST",) + return (EndpointRoute(paths=(f"/{name}",), methods=methods),) + + def complete(self, cls, name, func, spec): + """Fill the missing values of a spec.""" + if not spec.routes: + routes = self.default_routes(cls, name, func, spec.methods or None) + spec = spec.merge(routes=routes) + return spec + + +def collect_endpoints(cls, conventions=None): + """Return `{method name: EndpointSpec}` for the endpoints of `cls`. + + Decorated methods (on the class or its parents) are always collected. + Non decorated public methods are passed to `conventions.guess`. + """ + conventions = conventions or Conventions() + res = {} + for name, func in public_methods(cls): + spec = find_spec(cls, name) + if spec is None: + spec = conventions.guess(cls, name, func) + if spec is None: + continue + res[name] = conventions.complete(cls, name, func, spec) + return res diff --git a/endpoint_spec/pyproject.toml b/endpoint_spec/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/endpoint_spec/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/endpoint_spec/readme/CONTRIBUTORS.md b/endpoint_spec/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..2b66303a --- /dev/null +++ b/endpoint_spec/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Simone Orsi \<\> diff --git a/endpoint_spec/readme/DESCRIPTION.md b/endpoint_spec/readme/DESCRIPTION.md new file mode 100644 index 00000000..1e59ce3e --- /dev/null +++ b/endpoint_spec/readme/DESCRIPTION.md @@ -0,0 +1,12 @@ +Declare endpoints on any class (eg: services), not only on controllers. + +Provides the metadata that routes generators (see `endpoint_route_handler`) +read to build routes: HTTP methods, paths, input/output params and any routing key. + +- `endpoint` decorator: declares metadata only, it never wraps the method +- `EndpointSpec`: the metadata of an endpoint +- `collect_endpoints`: collect the specs of a class, following inheritance +- conventions: defaults for non decorated methods + +It does not depend on any dispatcher: generated routes can use +any route type (eg: `http_api`, `restapi` from `base_rest`). diff --git a/endpoint_spec/readme/USAGE.md b/endpoint_spec/readme/USAGE.md new file mode 100644 index 00000000..3bb4230a --- /dev/null +++ b/endpoint_spec/readme/USAGE.md @@ -0,0 +1,38 @@ +## Declare endpoints + + from odoo.addons.endpoint_spec.endpoint import collect_endpoints, endpoint + + class MyService: + + @endpoint("GET", path="/") + def get(self, id): + ... + + @endpoint(input=MyParam(), output=MyParam()) + def scan(self, barcode): + ... + + specs = collect_endpoints(MyService) + # {"get": EndpointSpec(...), "scan": EndpointSpec(...)} + +The decorator only declares metadata: it does not wrap the method. +Methods can call each other and tests can call them directly. + +Specs are inherited: an override w/o decorator keeps the spec of its parent. +Use `@endpoint.extend(...)` on an override to change only some values. + +Decorated methods w/o path get `/` as default path. +Non decorated methods are not exposed. + +Use the specs in a routes generator: one route per path of each `EndpointRoute`, +w/ the HTTP methods, the `input` / `output` params and the `routing` keys of the spec. + +## Conventions + +By default only decorated methods are exposed: this is the recommended behavior. + +To expose non decorated methods, pass your own `Conventions` subclass +to `collect_endpoints` and implement `guess`. Use it only as a transition, +eg: to migrate services from `base_rest` w/o declaring every endpoint at once +(see `ShopfloorConventions` in `shopfloor_base`). With implicit exposure, +any new public method becomes an endpoint by mistake. diff --git a/endpoint_spec/static/description/icon.png b/endpoint_spec/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/endpoint_spec/tests/__init__.py b/endpoint_spec/tests/__init__.py new file mode 100644 index 00000000..c3f07a7d --- /dev/null +++ b/endpoint_spec/tests/__init__.py @@ -0,0 +1 @@ +from . import test_endpoint diff --git a/endpoint_spec/tests/test_endpoint.py b/endpoint_spec/tests/test_endpoint.py new file mode 100644 index 00000000..b988aa1d --- /dev/null +++ b/endpoint_spec/tests/test_endpoint.py @@ -0,0 +1,104 @@ +# Copyright 2026 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo.tests.common import BaseCase + +from ..endpoint import ( + Conventions, + EndpointRoute, + EndpointSpec, + collect_endpoints, + endpoint, + find_spec, +) + + +class Base: + def helper(self): + """Public method of the base class: never exposed by conventions.""" + + @property + def boom(self): + raise AssertionError("Properties must not be evaluated") + + +class Service(Base): + @endpoint("GET", path=["/", "//get"], auth="public") + def get(self, id): + return id + + @endpoint(input="in", output="out") + def scan(self, barcode): + return barcode + + @endpoint(["GET", "POST"]) + def multi(self): + return True + + def not_decorated(self): + return True + + def _private(self): + return True + + +class ServiceChild(Service): + def scan(self, barcode): + return super().scan(barcode) + + @endpoint.extend(routing={"api_doc": {"tags": ["child"]}}, output="out2") + def multi(self): + return super().multi() + + +def _routes(*pairs): + return tuple(EndpointRoute(paths=tuple(p), methods=tuple(m)) for p, m in pairs) + + +class TestEndpoint(BaseCase): + def test_decorator_does_not_wrap(self): + """The decorator only attaches metadata: the method is left as is.""" + self.assertEqual(Service().scan("abc"), "abc") + self.assertEqual(Service.scan.__name__, "scan") + + def test_collect_explicit_only(self): + """Only decorated methods are collected, w/ their routes and routing.""" + specs = collect_endpoints(Service) + self.assertEqual(sorted(specs), ["get", "multi", "scan"]) + self.assertEqual( + specs["get"].routes, _routes((("/", "//get"), ("GET",))) + ) + self.assertEqual(specs["get"].routing, {"auth": "public"}) + self.assertEqual(specs["scan"].routes, _routes((("/scan",), ("POST",)))) + self.assertEqual(specs["scan"].input, "in") + self.assertEqual(specs["multi"].routes, _routes((("/multi",), ("GET", "POST")))) + + def test_inherited_spec(self): + """Child classes inherit the specs of their parents and extend them.""" + specs = collect_endpoints(ServiceChild) + self.assertEqual(specs["scan"].input, "in") + self.assertEqual(specs["multi"].output, "out2") + self.assertEqual(specs["multi"].routing, {"api_doc": {"tags": ["child"]}}) + self.assertEqual(specs["multi"].routes, _routes((("/multi",), ("GET", "POST")))) + self.assertIsNone(find_spec(ServiceChild, "not_decorated")) + + def test_custom_conventions(self): + """Conventions can expose undecorated methods; explicit specs win.""" + + class ExposeAll(Conventions): + """Expose every public method not inherited from `Base`.""" + + def guess(self, cls, name, func): + if hasattr(Base, name): + return None + return EndpointSpec(methods=("PUT",)) + + specs = collect_endpoints(Service, conventions=ExposeAll()) + self.assertEqual(sorted(specs), ["get", "multi", "not_decorated", "scan"]) + self.assertNotIn("helper", specs) + self.assertEqual( + specs["not_decorated"].routes, _routes((("/not_decorated",), ("PUT",))) + ) + # Explicit specs are not affected by conventions + self.assertEqual(specs["scan"].routes, _routes((("/scan",), ("POST",))))