From e562c310336229a71351a45ef6241d61859e2f99 Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Mon, 17 May 2021 17:05:43 +0200 Subject: [PATCH] Added docs for cpl.database --- .../doctrees/cpl.database.connection.doctree | Bin 19688 -> 23089 bytes .../doctrees/cpl.database.context.doctree | Bin 22161 -> 25554 bytes docs/build/doctrees/cpl.database.doctree | Bin 28715 -> 28648 bytes docs/build/doctrees/environment.pickle | Bin 126993 -> 126993 bytes docs/build/html/cpl.database.connection.html | 20 ++++++++++++------ docs/build/html/cpl.database.context.html | 20 ++++++++++++------ docs/build/html/cpl.database.html | 6 ++---- docs/build/html/searchindex.js | 2 +- .../connection/database_connection_abc.py | 10 +++++---- .../database/context/database_context_abc.py | 19 +++++++---------- src/cpl/database/database_settings.py | 6 ++++++ 11 files changed, 51 insertions(+), 32 deletions(-) diff --git a/docs/build/doctrees/cpl.database.connection.doctree b/docs/build/doctrees/cpl.database.connection.doctree index 792ebea2b4d5975fb086a9b5ef6629c6c5cc2c2f..b9e161acbb649ad35843eca895a6726799c2aaa1 100644 GIT binary patch delta 4274 zcmdT{eQaA-72mthcI`A?8{#-0PEzM%Z4xJTOViMJ!*v=uXuEo8*KAVN;MmSfpKlzy z@v~8br~*RksPx!0jyH)(OhRSF?HCTFa(M+GPo%So7E}xK z8L`1W+?1`LIVJs%qw<>Yb>(_bU zK1-hLfQ>f`)w{L^LJd8w!l zs8`f>euO4E4%)@)5F6_5|BxiBCa$9dVY&3WYUnZGu&}Fr>F9qkv|hdIR^FHVmO$Q8 z+fPAmW#(>Nd1Y3~E7_E_6!o3ARSFMSY5|M=_KZ#2l}f|mKkhsd>tbGJ?u&q$}(yj8{$NGzZ{0W|Mh?48Q4pgW;dQ?`=4{^(H+Y{_FrewJpXzFH_9fxLo%49hcaH z^t!#_G=_Q{{h9lll;MZ{lWayz_EH{JO|IX31P+G}b*T<+$L#Z2^n?|m&R`xU$!o_! z34KImOp*`&IB-AviVTmrTVX2D+w%x17>#~IBAE(~?H#XvkfNT?!uJAW>|vRzT689W zuEAaPr_fMzC0q}ZgTE!Gv7vtVGu0IrWq5Y;7`!%gfi24ArC?TKuNwP*MTVu|4RGw( z!QK?RY@}VjLZ+g2`DJ|kmggzcKsi%L9<)}-1;Xgx>kBM~osucM+ zfvi&G8A?XK+sp!S|=U0$o3s{XSToJ)8iV3yJ|y*YlXS+Fm<2rh8>c04L*oQ-Pf#kL~y$V>IQpl)J-I> zff|0=F%D1M^O6DfNfxjRpxf-_Es;-2EKIKk&~50!1UgEOYk+p!EkNPe@D{inb;95F z++e*pgXe@^t9=#l6alLd<^;)W0lw57bR(^;fSII}4U5gst@v6++PRvpke@Ggdu)9? zB$vZ`-7-68FYn*?w0!?*QvWgycj791BMn7*&ErtiUD*U4XckW@8eN7}X!s@Cz-89V zcnA)MJx#hjt(>KpXUm=0fn%i$MxmrSxJTa!s54g zKx6g6xkGXY2G5PSW_`TPAvnRMyEAw{%qKE&arLy`6B{QIdCGv2uN$iTDy!C8 zEq7M~58z7JVrW79ZjaE}yK_mmXOu4~nbJWUUJo(FCEfABz6bXm*@q8Wu9(L=hq!v_ zwhUeZ^m-}N+=)l@q2M)1Tbg;px2C#c@V5Q tw>owYt&Sb7AbK9fF19Xqd>rSiaii8)D{j@UEV?I_GR94T@85U#-vQ~a5rhB$ delta 1841 zcmbVNZA_C_6!zY?g~H0jPyquiZE*6{K_O*@7fKODtz$(5vTTvKip^f`q%feFW^)@` z+@fpM>~ve4$+ExuAdbBIH8Vm?Oy)0t7{iv$A)6sYlWojMG7V(s+}2uMf0+Hb@4ctz zJomZJ`RMewZ0QU$zHR*ITGzC(ya?8}J;?&_hg##zRY!wk!D0L0NH`oCoERDj?;oES z8w$Uy=Bi_%iO5)3jceHhajh^a1IiyG06r<&2a44Olh#iD3xgl54*na{Z&^<=ewV@W zPB&j+`gECr@f;3Y>)ehNwr-uqG({^FCXQQcAaWq2*^b65HTytZEHgOm-vq^5Jh0F4 z7r)J5y3=RAofZTqE2=hMM}u%;yjZ|pG;26Cp^Y4ji{HuaBKr*nKUb81#n!B=<#mkj z;KYV?=$~&kG2Wjb(?JXpWco6Y@p2-g7jLOz+{YyoUs}WiCWq<93{2i2yJRv_E-Am4 zax@Me3XYE_8J|e_>BE)djDJkrDq)IeD*`xJsxNWi`h4|w48L&Jd6=Vtl)cDdzWOTI zYv1QTQjBZEQLRK=M6BeS<~ZD}?dOY$$3FDKf0du5$96fiEMX)Omk=hRRci+^QF8=o zeU>5m1(KlzY_4v;#$m+eWjQeAa&A4l};&yb2|Sdym7phJQGI_B1ZQ2ksc#4hvOPaQ*pguD!Cj4=tavA-vrJ=PZRR1jC*h_L@9Tc?x+*0o%r6H2>=Hu^5`|(ALysC5BPc z=n*xUkNfYwf{#6(1~$`F!-9A&la%tCjpp>*VY04(s|qUk9ACn;_{-o;)dXKRFL19S z75o2v_{?MUVf7OzajK5}QvMQgk1C{8w1RW1OyXH*HS~16!v0L<3zKNRmAWc= z8R~akg8U8>T;AqpYbiHOYnq!_mBKFG7gqmbdlutMq^K`%DTO9hCGkc{++oN}{3)_$ zAPz6?Sf#on%J1$x#9IuqxjY7}#4E7oHv#v1_-=!oULFKVR-B)cfFf(2ydj_7^H>cX4HeVp66E#0a189!~dp!mA&|G;dBNoVH z1s)+^DW<6v>fl;ekv`D%H|M%R@9F+b>5dV~30h90hltT~jE?W%5{c%7gE)SVjE2Uk z0tI;oq-Q{S1tOZA>;#~hF&f%>cbo3esWkc}mO&Wo`K_S#*(#Q4P|zQQ@X{SLo#h=k z260F9#0thiPj8WeM>x}G=XVTnzHing--NP64v1OuqhTjhs#R)Ju}BM*pJ+e;;W6l6 L_2)8Jd7YxGdA>Mt zVmn)-3Bo271Q_Uc%%mX37o-U-BwG{^g0*Gs8109CSer5EMhDek0xF?)S{V~VaL#?t zv7Nlp4aNuj;rYFD&pG#Z&bjy8-+NEava1)F{6+a&7YFC%&33ryDP-$muf3#VVA3@h z9vxK%W5MvKD;kRgM~4$?_OXO&j|&Z(kp}$L{_vEV8_ypIg$F<9AD;-vlmsN)k0(B# zs8?mxB0S{A3x|{w!Ok7mI1A(ZrGL-vVQAKHUsj=8tw9Vrg3J*q`qT``JXi!x~CY!>MVUIHEY2M%&3`Z2a z9S)8v(Iz!E5)w(M#~95qC6a-sO2acHqDlj_ghw~E$BPY+Cr%~wEEx~04*mz0l{GP- zzLrd9ya2<^^v)fuFe@vmz;B@ie519Ty$d(2Hh96?$o>MWZ8qqw&WC?^9nyyk%9}Sd zzJz+b4KM1Gd<*`?O^81+p*EbrTLa;0VWuG+2y23jWR(d0&y6G}uG9ZX-y@%ul~$~lm>ba4NCGGpC# zX?fr#a`0LS`tPZ%h+7cdL?oEt>j}`=nxj^b{T{h1%xTrx&m#~$1sL-h-Nb9CaF94pU|5dj#lRvpB45(;~m{AT#=mu z?m1n6kuDP4Edp+q$r!Gg$21g0|5LS0aXo^Mfv`Fhs&pt^u!zybT9Q4*oMP_)+>yp-(;Tdm-w8~6-SF~TJ znc8nYGh-^L{qi$#xcN6`8K0B8*V=>+*nMdYN@ie1oiO*AXLBTy(&oFe>m1Crtb+Ot zUu8ZR-{FSdH8};e>$)>lwy`7naDg>BgxC+8!MpK0Yz!(lHAo>de6X>BeF17)#Y1mv zDam;2Rw<#OzSO$8g5bt;#wNAXC&81cSj0(BlOJ;kH821t6nP3Hl`I>oGv-{G*-kT@ z-_*^{Kurekv4QqAmjH)&}6Ut zKV%w(GG&&p#m=8xe*YOmAa4EOr$aAFylba;sB}MIk9BNs?orxoC69F|1wsgVwe1fNB?KO%H-GI-vHGe8qt(8mE(Q zH^b_h4#;kQR>H3OeEU<9Dub)hD>~;8T8ddaw_SvtTkn@16=QW@#}Jca2;vb^TXsPB zWxb7+Zo4A|WNc&GtO4DfFrkCBMd1E6;WIc`ze{oh-0+-pJN&)l1q8e>+j)pdKN6@c zglb-f+0I|V^{UqD`P6JL)9o^VGXh{f^=vL<3yD|3{4N{3+GVq9>f)rCli_yP$=o-| zfrDS8iRuO4nH4UD&g=R_Nxoy9(*+pk%QD5O)#nz9jpBTd@=v@| z_(u|lcZ8F_g4O6NXQz-a*}!$cN=}aV{jiNRC?DAI5~N3bi+AG27IcOCX-&`;<1=)j zwagj8w^$bT9L!^Odh=ctos8nQ0RM;*jRuD4y$r5K2;c6t4;Qgu zETl9gKV1A9jm+1p4=sYC9j(qi;ou)o=IF)N8p2NykwC~VzHX#{iYV?4L@2RJB(E{~ zOHOJymN{KPHcnSp%=5A_IogD{{^+%vNK{{34k?c)p@h$jA04oEiMZv!jzc^4@4%aA zcp`$Yrb0Px4&i4CRHFv^K9$hHlP_tyKcqcoO#R<1@TRBg)67^sg;0qtBKNZnUWaku zEcy7ibfg)kLI0p+IF^~BjhQK;889R|O(;b@D^kR3P$QKdQZ!6Y>PXQ~CQOe4hYoG| E7l!836#xJL delta 2545 zcmb_eYiyHM7~VNwzpdL^#x8ujwA$W%| zB#3iFZNlX(5smV5KTs4>FEIpUA}km$W0S21{hBK|o&eJ{^@ zf6q5NO%5C*@^1Oi#O4$7Dg|^ci%2UtmCQBI_l>BgZuh`IZ}&)_d%!e2;^`ZBF3CFB z>FMlWz~~4ttVvc+@5rcU!0J;I+I*_w6)>wF8U~IjTVYPlfqqvq95FiRJb}wbGyQ@1 zN$w6p{)9715wxah7ccM05a8sOOyi~epHlxx9(l0wTBPGQS90=vp@-uV9B z5!Kz}W7m*gj`Zuqf5u!xNdwv?b^etW4KdfDP2nAL#V~KDXdW_66);)ws6HUFmhiA@ zD0gN|+mA{HwvA&J!7rBq8rlks9 zO`)~5#y_?+hmg0pv5I)i?O_V-X`et#VIp{oR*-i@Mh{1<9K~x?Mj;Z?y(Ot!R|`9f zr|BV#Cy?Aj3jrc-evR(LNbW4sxtnLq2Ds%)f;LwU7?+hlA}TT;R+787cMcB+3vwl( z<99D}5%RN0-tAH?y-DGI=_&r>|G4Z8f`8wyx5K`2JI$A1N-4yqk}+@td{j0KUsSw6 z%fgJsyO1G;>sbnWA8Vzy5MQTzfR|l4L^i=|m4(_3sA6DFI9XXiyCt}2ONYVaB@%N= zFk~;L%}B~a)0VfRETCpodKK7L)spStoKdw{?ct>^6;h%jvLumYhmr#3>KeLNf<^jl z*ja6{97LhObS89mb(htysq?+;d(nq;Agl4*u1|s!Sv7P&dXo>AYjfxk32IkVCBMW~ znHAgI0lQbsBkGVn51UbcJYsrW0U zHP{28^vuDh)tLvYGEo{+{ZlyA1(@n6+tH~$E5S@-193pP;}3csQ(N@EZpfz|dP7D^ z$C@;vyBajSe=F0^MGEpHGI(M`+d+4JL8f7UNs&zqP&*fkHFaG`zs{@v3iertD3O7U zBZiTklWNXUoUrfH~etfYHGe4RPO<8Tuw z7S-o&O)&XcP50=KCcHd`f{;QDmq)b-<0!ftV|l!X^cZ2lMROhe)qI>ctN+;A&4iu{ zdq$?<-L>C=rr>c?#MT^Mqg*^GTujDhV=_Jp`EX)m2Fy4!^Z{`(lc&-5vBX;lU|=@` zbvh;B1ph|RNT^Qw(?J4{a882}1_~7?$Bs~g^cWF}LY>m^Lj5R;R02Kg`$!H9wTQP< z%%dXnN&Ou5ZAyZ<4b`M5$kdq>4jP=wLcB&ro(kVIHj2T><;q(4a^oyXhhLpW{&*JX z7V4t^RiZ-c(9akZYDM~g{f8^AC4AKzbXk$MEycDCpgj{tdtmRk#{}bh{;EqM3I6-8 zziIM8F5_L)>+!ffFtsJ!pZ4?~sbxDV_Tg~@pN?yI^x)r4evEn(2RiwKzhkg>7&j(E zX{V5M3MuEPYC<{!s5-6<*S0p(Z)I5C_Sy0~xH|DOgxL`lzX%xMfe)#`XE*VdfPHjH z22*>E2Jev4mWLSa?H^cC0P8W@#S|37r-q%y19up6^Oh0A#!ljG3XfFuUXlIlI+6&y H-u=YCqy+S$ diff --git a/docs/build/doctrees/cpl.database.doctree b/docs/build/doctrees/cpl.database.doctree index 451e1917878a0067c752d8420a0b21cba20b15bc..94632fb7cb0e7166f83f846c43c95976700ffa22 100644 GIT binary patch delta 1676 zcmaKsT}+#06vua-zAay6QlJR5gLcf&0U>N{VIWu-9l{pg*}yuTl+v=gw-4h(Xt%gw zz<6V{S+<=TqKR%8GB2j+^2RBP=(Z?hnQ>dhl9~bXu|Ts_~@`@U-&?1#IiR$ z7>P?6zPMBr`yUv8ltkqs)9y&Shm7GIn;;IXGXC4Lr(N>$QT$xKB>wF6kOMggY-CMzwy-66QocR*GI{J3`+r?x#q9xBVUtRzxc z+kYyMe-C$u4cA4eUmoko0&P`}@c~r56~Km;3X998l?lsanzhp!X-} z^5Fpuz<`1uNKbi$e@nr?lf+jC>v9`YS5Fj@Lh`;&`CCpa$`a)lF^j9Fwo#k>L-1Du zx8$YJ3C*qrhNNdXcSw??87WRPSZykBbB4#}nTf`-Mgqg3$V+3Pi8y=klxK<3kSNWF zie6N-VpOv5=vh1$?qM%rEuGEbg`~Ho&*=IL+*DbL-_i0+YX~!bw=Kjp?yR-*=wNv%|h1~w;I8nwdq z&v-Dt@IF3>s1VawfdYoDdZ@0^!f>M+-Yl!2e<@%pHuzL7NVlqMG_U| zRSpc>-*;UsI6Rt@$w(3UI3jgA5@7tsIG{H z3l&wgMS!WDrKB;St*j^XIh^g*u5hMCF0#qg1MfUzrJ}S4p67+c$UQVmw~Y0(IvB1> zf+JPUB-|6Wz~a+|IOx#ABxNiA0`i{6hi zToGnlmSM8FiL{4cf?GVtZCk*UD>uu6Fyk%T2(45~FqNAjB|izqEyKJN0W;oulVep| zrpa5#LCywJ4iyk`F{FMr9Oc3m>Ze2MvDge!TX^%~1W&lpqJz}-`}B;Ab0#v7gmX>C zxeK*%p4rn})#D_bxvg_sC~qJ|xi(WQaatZ3+a_6}W^ zX_g~HAPv#LC2K0xs`yFWzFDd4?wKIXpWSUVM}Gvw+03T(+XxL4l` zS9+g-?mjb}kfFjh%(DfQBLo!_Djcl!?u276d`|~uz`>9V^GJY~CBP4YfS!Imyxk=P zuf(|eaQpWNnADVyd4w(Q!%yW1dhqlosZ89r zD2nGrAB)EZ+lIqD?#=OG%p2ph9k;t*9=4C-|A3*FMI5w<=Pi=GMY6SwiALPL4lg=7 z_+eahOvPd#@m=wAR-}fK+*FuknS5uKt?4i@)1wZe$@?h^KH+6dfG-_!-0sm}pcPH< z%<>zy77g+KWUDyf{lUt4i!nUB>@*H|kk}Fq*uE?sMX+(00|#f|(a;-&y3|1SXMj-~ mqcE@`xa_piS8*vP{*;=F@ilzlzeu_e)8MG9j5qnDtLr}))=AL- diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 5602a7f4f438cb18f94ed40a1a5adcab4f23d304..8b5d3e8ecf808f2900df57bd9bf5e2d3553b93dc 100644 GIT binary patch delta 7430 zcmZu#c|g_G@^?%D6}T5%K$HY7C?Fsz;=V6wsNtH13y7%q>)p9{(?sx@DT)gYI_^uk z<%(VvceAvo;(}IMT8Wlczw~MS>eYKa^UXO2F4FJ!&;6X4IkTLZIrIH~Z&8JJQH6KO zAI<%JGi|1X$r;X!Ng3H$#n`Jy5Qc>|Z5$xjnO4gbkL-wtJ9fdy*v>dCDiQTjeehzE0avx` zkDFsdSU&>Va4;?Kc2odc61f$YqVPaOD0XjEA3u#TKySR(ssnz|${)|QY%BDkm*nKO z^23pFZP{7^UTu|%zqX92w_H|)ZQzFJiI~+kfe#gjzqU`qq?qB@I>CUClXa+%jKJ7V zI`ogPhq~AR>gfdya7;@-XuTpnh&fI8bTint4LijT6H(&yHhR>>H^9wt&2%Db%Vl*% ztW_#71UE(Z!b|ZwjEWVeWB-rK43M{vXq#RfOs4s%=W_QC&Ig z-6mEZ?d6UJ3`$bIqGCH?S=(-$1RYLf-q^OjxRHHMp-64Izo$9BWJ3GwpK zsU72FzljPCOpf9ciOVET)BztSwIZvD{auTR_JnyU*?^Cd;<$~(J>!jNYu60NcXqJJ zIK0+*9GEb!%XJLuW5BSkIbg;=yF}o`Ep_o!S0@hYX+ZA@P0`$KB(Cggz+2No@Xv0e zux&R3+E&%Yx4P%!Mb=zCGlJ*dc!b^t{Gdkx+ItCWb# z%}sGHukW$#nB7gVOYdR0p@#wY^)}*S)_+zSiMgS9m?y!{8YVmaNWwp3E^oU&GU9%s?r}(<} zry7AvqRX>XmLvqX4BZdJl0^E5c*~qp!;a=H~jldye@^apT`8R}24f zivS-NTDhPmY=J5mnlKia2*h4H{M@?qB1yOpW~^6>^vuH^G3wHN@bqs@Fg`uNotfoO zJHDGT7ch9Zm0QD%VPjMVrWp@_(H)}cYBMX)-PN=LSPE-K~JEsE^f%saHA3ieIqy6=vh5J&@e#vz&cC7;Z`J|OQFbB_{ zigd@!nh3lIz(n*H``smPosBHv+x)Di_W2&A^0oL60IJlx)FJ z-+guNLB(F|@^^2ZccaFhX!o)C90F^(XDzs+M00Ze>2U-!r^HzBajz-Zr{rT77X$9u zBpRVEW-OVG6EuT+u+YdJu%W#IbrYSCij62NKGtb7GcxXh|7 z?cUr0m>dwkpuwbT2nHFK~|Cj~1FB${n+RJYSSNE8q4Y^gS>F^XCP)Z3ohU7lAl% zy`THZ!F)-$=N@`nErO1?0N*LG@?^-x@`K99#-n`W$`1zO^=H(+E;$HYGr6SIPYw08S-*%49^^%-kQ)}uDwx% z8drmwP=iXZK~1VbO|C&rsX8!wVD#a3QEq#8SZf({s(+Sn0$`u z?(}n)eZcIFztSYwTg+-cFWJ+fk$b{}^bj5rXP#4iu+aV>XhvmvXh8YC(5!TIeF*Xb zt+YfBe|mwdREV2^qqHm@nlz!&^})aNNndEx5bULOUWf4kkX<@y8hH7DwbW>XDLy`; z801EWWft$y$fWy3uLtmWU&imtqWwS3uL7WWQ_{g z^qVtb5=^H%Ghr}8^eh;~FlQDFVkNLml4;3>sovrpSG(*_x`)sh-%Abl);0z*XFBQUKrh}qY!0L`?42Vu>*hgsFjL<= zc!gnc9*pynkH`CDn+ts@F&~1NKPVqE7Xj>JsU=dx2XU7ib>42ge(*S)3c zZ~mme4UK7A9>mg>zd^8K|J$GZ5rS#;d>(RP^T3;xqUXU-2G=}k;?6vns=Rwq{X%Gk zskg&u+1t>Zx9oWvOv;Y0j_h+GkxJ%6Q!KmHz*n75y4F#}Jb0BZ&aZMBsH5dOIF@Jg z;Wf50DeL}ti;`@XblA8>icoJ43m++_OgpBL#KBa zb2FH!ZXrx#uoQALnCV<0jAm%Iq^c%E3D&^N_|?P4RI&uTz2w`=aO%AVLYNt|YH1a3 zl<*XaVc*62PBP_WRl2cJ`cf{vjZQ9w2}*f_in#T9@Dmnr)4#nd(!%&fL8tn!umqtA=JY)U+-2%2$- zbBZ|iHab)UgBboSg1*YgY?T82FZ#etQ&xtf%8%&zJdeyT(`4n3X_Z|YeYk?}ij92u z1yfmBNIw-r0_7t3DaK-tDztJ&*66yH@S`emmrxTb~W^1Fs_CH3?-`} zh2cM|p(jJPH8T9dHSoHMv|N-wg-Vt}0~YsM%Xh~{o7TcOp|cj!)UGc@YQkyGI_RVr zcU7*qA1c#*Uop7L`m&~VJ&b3#vL3oJ)Y|}k7zS^s%JffEj@;z_&%-@=y}toQs$>49 zlVgn<0|c(rLsg}WWZwv#z(~6`a=#eqmyIxnVaO&9m6@AhB18Sne9etCc{2=WDBaAL z%SirPcnTV6$`;Otk@jxk`(dPd?}FwnKL}dr>3RV)q>1;TE=74kce?g2G*PmMO4;*w zrBd2^U{QkTO2Iep!BE9%UCBw=Dt&L<$}`_WKW^nHE!1xtWO~Vuj!ty96oTm1c4$ed zzU+3NFZfhu!9u>M?wGn;9%GN;Cfuk6{=6 zaEQy~qU6KeMJ~d_{CJQjI8j;6smCCK^wALKSE(q5(CNPjBk24Q&@08Wm9i&CpekMQwy!-)}7#4p3c7|t)($0dDsk>)oI72>!9Hu_{kW1#E?jK1g{YY4)mgl5w z{W$Zs zEAlhGADu1dVurl}djEthhr?R+U~$r!ze7K@=~W871W}Yf0Q{-j1%7l$)giRy95kVS zT!2ttqh*S898o%2*$#IP<=cJFX!AOQ?<@|2zBvUz$Dkq&Rhkgujog3UqZ(Qd~Djn}t_P)9< zEws4-(-hyW_y=zAopI8$8_*8yl=unXE;~*7gdb{ldiN84zS!x(CtPtmg?-A8W;p-s_M3bhJNHjudhi{1iJekSa zg?BmFY%Gs^I)&(}D^C_52l7=5 zcvn^@o67FNETuQFGF*OWk5QbIK-zMZ=i1Ht&;qRV&-*Ztq31Uog_Tx+!-==jV+DP_ zh1N`26s-Lgx_isN@+Jq;*)l%Hp>O$-7UqO{K+*aPUOcA5hz6?x~@ z2N0z=wm=$oi#ZP-fPuHxdkCEw`aXmN2FF8gS1WCO2(L0cdC0A7rLN!cMX*vngEFy@ zjq>XzReT50EU5QAbm=ZX^mh2ysx|GEX|EJGi{}<=2gR4(>Y!S+qSfD>r8T5yUyxG% z_YlgTfg1&w>7;_&3VvrulOI&AbT68Jy`jgvly&tY~TE(nAqilTyzmiv;p z#T6YD7u1lb*N6*d(L`fF6HW4>G0DBTx#uRDSKU1fkay1eXMSB(-Bs09)z$q?d4o%N zgG=QfokG1cjJoIygMOZNevUcKsx{~@PqQ#)g ztSI%vB7g9UuP9Y>cBVd8Yc}Y!GxgSrQV-6Vn`TW*PqWZWu`WAJtJCV|+bNx4{(M3C z;v_ZrLIsN-?CVq7mM_e)YIS7Tm5;63>`dFEfD5e(vRgShjUM_%_-m70l?959dm+qk~G%byF;p9i(z| zyJB`w=Bv(1o`bR`{;cFWsD<^Tlm!lIQFM}`G*L6_Sx(S^wtORND#A;9vpFGA?8o4? zY)W)6`)AM~);>(lvP1k{N=wgR>d<~{Sy(X3jrL+!qr0(`kX|J3!PW+MWBdE`Z(Alp zKzi7aUcu~kSWi~nH5z)eh7f-i*vofquQn_+B80UI?Jd-d2pcAr`^2c(kl;?ttFH=r zu-M?vY+M&_HnR6XRv*%v&5m?~Xyz5?!+r|$=L*@KFkj~0)gQWYZaa%ntJi0m=UB7M znQ3#QjSDME!$=U|J|`nhrxSEMJKCiWE9mOMD!Yt;2}H%Qz;J)|PFM&z6zpCm(!=-f zFa*i0C?cL64i8{mBKxv}h$IMSN4xv7g2=YaKf+yXfN$nfk7(Ak0Z)nnPj2%Vtce;z z(NVJt-96a;sE*FUrHQ0|1pAOFv`kfvIiO{KbkUM#4mKYl(H zd|6;bDtoI>7YJrUdv#z7~35fdrDRHQ(SvdxJ6;%EG3H5zUwoh+0c>IkZpT0@=Pm=sJcK; zkqBTT#wM|Vk)gJ;W0Qae-nPyO7v$jC`0H|TePWduu&=XKEGognb|g^?EGx@kPlrF- zGdYQ^F$gQRfTT%4gvM4l<-8muPOB3Gwlv?f<$|ysOWPs`sTn66Vx~@YW#@nQVNt2xwv0@(oblbfB47u%8>lq0 zS;I~lfh_G&FxmVSbt__NYy)&_K@94%E5(2<+vI6GY#_h6c&TX(uyYj#dqoAZot7l_ ze7$tg&$j0@#Mx25}(LRxMyZ&yjY2 zUX=kvXxNR3o@`cmh;7}PeS%?ot(-E+C7Tv|+6J=%U}yFl=n(0c%OSb8dfiYULSs|o zdt$)8o9D?oq1x84VV#sL+e8lXDPy)=l7r6MRsnljYM>*iW1X4QbYMpu5TUXCx^tHt z?0b*ukaJAC&&fgj-rHgzk}zR!09M`ucUEcgw&~v=4@^~Hpp&d+g~d|k$pciHg~b|M zheOxIfGst7;&L5?*&>e22DZA&K&Rc8c^pk*7fyTIj7L*}1{yYIi>K|`u|h%EijKb} z2fiosfSnp+pw5ubR0-0?wo`QCR0$e(>vSzFux&jvwG|6mXrPYa&CKVLm@Z$;V?Ug$ z1chxq)6I72d^Lz>k^rKUB(xE2B*9tq5CYynh{?N0!b_rc5b(Z{;3AqvLTk}6XeMtL z1iV+!6y7LE#+yV!E72hmAg5GC?O~23Gee(~ot|mtje=NfYr3}PZ!uOss!y;mIGg&% zco%9a6X_>YD4AWM-1l^HN>db8T+>asT&7H?oap5m?11lc!g^pP31@2hr0UfJ0xPh-TkA+80zl zV63W*0v{i+R6QIHK`(>3s`cwI+Z*z#(zC$X6>_VzMwsX7$}>U66}tQxh@f@E)kh75s5Alc`gxYE)fYTA=Pgzgmlp1y@fEIAbb%_ zC0M!$CK1#vf<%I##W0j0W3ix)FNPUJsg^)0fnf=ZBsj4IUMKL(7fgLV%y;2$TIHGw z)sLY)doR(?McJkyjt;$+LOji#v=ovF4lNZc+Z4bc(Bkj{7)`LU0A@LhyYV3!i(oj$ z6oMb|#}+~w!GS`^B=9aGPqet8h>U9SS`lOr#JmZwyNIQ~tI+E%w8z~A5Q*2{1V73C zuL@NR{BXnD)Zqe)!G#uu7sEt?ykeo^UNOv<)}7I5^&#UP)WvosibbR zRN@hB&YbHoxw?$J7s|5bwB?Pq5`T1UZp$de>E+OoTwGdCq1WT_au`eSq8x@xB}-%o zy#D2-$8$9{m0prk%X0js0-`aWfv04wbSz~( zo;ll3j2>$ljFS_}rFT6lAlyalrb3O0SLlFE`#IP#eM@z>UvxE{PnmbSjpv4f3%_%sjAkw&hUXP#MWZQ57}!Z7L12{rz5 zmE6gB>W5z=xVbtue*me-_4rSOJ_L~)U@(Dp1B@c5+yDs#e{O&w1Oqn;_e(dz>(bLY zp8f=^Tn+9dj^9LQM~~Y#!7RRJ6C}%7U-8fc;nL0Us$|s5SW!LL!~IY)sLF=ZO2ZbI zO>lh+3?OK`6^0Rv-`W`IU$Bl*k*od+a>VuFR+u8U`MX-QHEa){S?2|fnKGei8@vi8 z+`o9Y$sQVxgF*Zxb2{0Zo;`cU@}3~4mw;WRPCfLXu^3rDIO*~w3E(< z3ERF4ii`Lf=-YL9{yJ@!!3vZ84Z z)sq!3?4eCrvGZQ)O;%hX;kUi8fT*;66zCk>y^r#lgTL*AnFNXN3pnsTHK!c(*bm7r z;^QXO3y&i2*6kpyv1)R#azBM92VD+O-_Jpzq z%tW0!LOV5}b0yWC0W&MXNN~Fn^aLZ1LblYm2_ud{vbTl)&(dXD>EAPX>J1orOe|P; z3>MM?wM}?C!$$cw;87cB7>t)rf|p!aW0yTU39+Oxs0xw@a;hk=2E1EEcc1|W zpAvCdaf-5Kz(=Pjp$43EnzC%b>eJN6jM(Z7)r}F8&(Mu1zD2*G6c$nnr^mtoeB~^t zNg92YYFJ2rXp)YwZ_$Wo&p+r+5g+g)u%?bO88{leRMDAcv!U@; zvEYS&zz8{M90pv4Ff1HJFVKNk=-v=ZC*aPD;DbM1fdCJ!exAWzd=^}NrEy`BV@fz# z_5GOolm!z%rsikC(vM-JR5XXH?~U$P!GrjIS1HjJOp&nbDvXk|7D!LM#(}1#xtQ8U zMW&`Hc%+sZw*}AE!a#!m)KXq7IP4lsmfG@pSVm&~HDU9~HJB#(#WGweHy{>QU8ieb zZ1o+0Z%}8oVBk%9*jmthlQL()%Qs;PLB~3J z*ji9mM}5kI)pam}0B%urTX5zrI-$bwA*t{FEuo>uCy*uiHpxHw2^|;m$J+1lbF7))sGFYtkYBOWaU5c3*{qNDuYQ{J2!C0)nNH^AH$q4-lj4nch zzee6?hrgm5Rd52DIAcAG26K~A(|tPZVor#C&hz^a26-6rHH;(Be+@HS#J^op8m!z- z&ERtd`l5e5cuIDR1{ivgOKQ z!k`~l*Z~bX`mPH!&__f318~M3{3^bo2N!#4^04*+ERyTS*d3+odb;E!XmIBZ>S(tg zLTAXue?NpV1Vg?dFLH6iHx%_;d@5nsx6q9!y@XBQ!XOv%58hl2*3{BAj(>iHv6MdIVvTW7OcJJH&bP2tsIT+sDw4VEAK*CNMvy zTFu2>k13qF`0O#&aV`${j!r=?77|Dm%SkCcG_m132q!_?@1g%7@rk!r<>Zt#I%{-^ zwW6p(ImW;7HuyR@h0A|At6E5Fnn|(ndkCNpz-=6~SS{hMg#QpEi%+Sp>gMWSf7zj4 zNc**r<~B*?H%SZW&Sp|H{y4_H7iGPz`Y$2W9Op1v= zk~t&lC6r3o&%uIM2$Ds&o8jGjZ@qjR#)UMmg>>5Aq-$G9P0gej|Ag$AF-5`>37aIG yB1jeoy&aWFQ%Su{)nqRzam>56kVgMaI
connect(connection_string: str)
-

Connects to a database by connection string -:param connection_string: -:return:

+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
@@ -219,9 +223,13 @@
abstract connect(connection_string: str)
-

Connects to a database by connection string -:param connection_string: -:return:

+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
diff --git a/docs/build/html/cpl.database.context.html b/docs/build/html/cpl.database.context.html index 9ce6d4a5..99bf126d 100644 --- a/docs/build/html/cpl.database.context.html +++ b/docs/build/html/cpl.database.context.html @@ -192,9 +192,13 @@
connect(connection_string: str)
-

Connects to a database with connection string -:param connection_string: -:return:

+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
@@ -225,9 +229,13 @@
abstract connect(connection_string: str)
-

Connects to a database with connection string -:param connection_string: -:return:

+

Connects to a database by connection string

+
+
+
connection_string: str

Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html

+
+
+
diff --git a/docs/build/html/cpl.database.html b/docs/build/html/cpl.database.html index 413f183d..20a2e1d6 100644 --- a/docs/build/html/cpl.database.html +++ b/docs/build/html/cpl.database.html @@ -236,10 +236,8 @@
from_dict(settings: dict)
-

Converts attributes to dict

-
-

settings: dict

-
+

Sets attributes from given dict

+

settings: dict

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index b017381e..330b9295 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","index","modules"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","index.rst","modules.rst"],objects:{"cpl.application":{application_abc:[1,0,0,"-"],application_builder:[1,0,0,"-"],application_builder_abc:[1,0,0,"-"],startup_abc:[1,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[1,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[1,2,1,""],main:[1,2,1,""],run:[1,2,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[1,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[1,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.startup_abc":{StartupABC:[1,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[1,2,1,""],configure_services:[1,2,1,""]},"cpl.configuration":{configuration:[2,0,0,"-"],configuration_abc:[2,0,0,"-"],configuration_model_abc:[2,0,0,"-"],configuration_variable_name_enum:[2,0,0,"-"],console_argument:[2,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[2,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[2,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[2,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[2,2,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[2,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[2,3,1,""],environment:[2,3,1,""],name:[2,3,1,""],to_list:[2,2,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[2,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[2,2,1,""],console_arguments:[2,2,1,""],is_value_token_optional:[2,2,1,""],name:[2,2,1,""],token:[2,2,1,""],value_token:[2,2,1,""]},"cpl.console":{background_color_enum:[3,0,0,"-"],console:[3,0,0,"-"],console_call:[3,0,0,"-"],foreground_color_enum:[3,0,0,"-"],spinner_thread:[3,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[3,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.console":{Console:[3,1,1,""]},"cpl.console.console.Console":{background_color:[3,3,1,""],banner:[3,2,1,""],clear:[3,2,1,""],close:[3,2,1,""],color_reset:[3,2,1,""],disable:[3,2,1,""],enable:[3,2,1,""],error:[3,2,1,""],foreground_color:[3,3,1,""],read:[3,2,1,""],read_line:[3,2,1,""],reset_cursor_position:[3,2,1,""],select:[3,2,1,""],set_background_color:[3,2,1,""],set_cursor_position:[3,2,1,""],set_foreground_color:[3,2,1,""],set_hold_back:[3,2,1,""],spinner:[3,2,1,""],table:[3,2,1,""],write:[3,2,1,""],write_at:[3,2,1,""],write_line:[3,2,1,""],write_line_at:[3,2,1,""]},"cpl.console.console_call":{ConsoleCall:[3,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[3,2,1,""],args:[3,2,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[3,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[3,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[3,2,1,""],run:[3,2,1,""],stop_spinning:[3,2,1,""]},"cpl.database":{database_model:[4,0,0,"-"],database_settings:[4,0,0,"-"],database_settings_name_enum:[4,0,0,"-"]},"cpl.database.connection":{database_connection:[5,0,0,"-"],database_connection_abc:[5,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[5,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[5,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.context":{database_context:[6,0,0,"-"],database_context_abc:[6,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[6,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[6,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.database_settings":{DatabaseSettings:[4,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[4,2,1,""],case_sensitive:[4,2,1,""],connection_string:[4,2,1,""],credentials:[4,2,1,""],echo:[4,2,1,""],encoding:[4,2,1,""],from_dict:[4,2,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[4,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[4,3,1,""],case_sensitive:[4,3,1,""],connection_string:[4,3,1,""],credentials:[4,3,1,""],echo:[4,3,1,""],encoding:[4,3,1,""]},"cpl.dependency_injection":{service_collection:[7,0,0,"-"],service_collection_abc:[7,0,0,"-"],service_descriptor:[7,0,0,"-"],service_lifetime_enum:[7,0,0,"-"],service_provider:[7,0,0,"-"],service_provider_abc:[7,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[7,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[7,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[7,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[7,2,1,""],lifetime:[7,2,1,""],service_type:[7,2,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[7,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[7,3,1,""],scoped:[7,3,1,""],singleton:[7,3,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[7,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[7,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.environment":{application_environment:[8,0,0,"-"],application_environment_abc:[8,0,0,"-"],environment_name_enum:[8,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[8,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[8,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[8,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[8,3,1,""],production:[8,3,1,""],staging:[8,3,1,""],testing:[8,3,1,""]},"cpl.logging":{logger_abc:[9,0,0,"-"],logger_service:[9,0,0,"-"],logging_level_enum:[9,0,0,"-"],logging_settings:[9,0,0,"-"],logging_settings_name_enum:[9,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[9,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logger_service":{Logger:[9,1,1,""]},"cpl.logging.logger_service.Logger":{create:[9,2,1,""],debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[9,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[9,3,1,""],ERROR:[9,3,1,""],FATAL:[9,3,1,""],INFO:[9,3,1,""],OFF:[9,3,1,""],TRACE:[9,3,1,""],WARN:[9,3,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[9,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[9,2,1,""],filename:[9,2,1,""],from_dict:[9,2,1,""],level:[9,2,1,""],path:[9,2,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[9,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[9,3,1,""],file_level:[9,3,1,""],filename:[9,3,1,""],path:[9,3,1,""]},"cpl.mailing":{email:[10,0,0,"-"],email_client_abc:[10,0,0,"-"],email_client_service:[10,0,0,"-"],email_client_settings:[10,0,0,"-"],email_client_settings_name_enum:[10,0,0,"-"]},"cpl.mailing.email":{EMail:[10,1,1,""]},"cpl.mailing.email.EMail":{add_header:[10,2,1,""],add_receiver:[10,2,1,""],body:[10,2,1,""],check_mail:[10,2,1,""],get_content:[10,2,1,""],header:[10,2,1,""],header_list:[10,2,1,""],receiver:[10,2,1,""],receiver_list:[10,2,1,""],subject:[10,2,1,""],transceiver:[10,2,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[10,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_service":{EMailClient:[10,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[10,2,1,""],create:[10,2,1,""],login:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[10,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[10,2,1,""],from_dict:[10,2,1,""],host:[10,2,1,""],port:[10,2,1,""],user_name:[10,2,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[10,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[10,3,1,""],host:[10,3,1,""],port:[10,3,1,""],user_name:[10,3,1,""]},"cpl.time":{time_format_settings:[11,0,0,"-"],time_format_settings_names_enum:[11,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[11,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[11,2,1,""],date_time_format:[11,2,1,""],date_time_log_format:[11,2,1,""],from_dict:[11,2,1,""],time_format:[11,2,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[11,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[11,3,1,""],date_time_format:[11,3,1,""],date_time_log_format:[11,3,1,""],time_format:[11,3,1,""]},"cpl.utils":{credential_manager:[12,0,0,"-"],pip:[12,0,0,"-"],string:[12,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[12,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[12,2,1,""],decrypt:[12,2,1,""],encrypt:[12,2,1,""]},"cpl.utils.pip":{Pip:[12,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[12,2,1,""],get_outdated:[12,2,1,""],get_package:[12,2,1,""],install:[12,2,1,""],reset_executable:[12,2,1,""],set_executable:[12,2,1,""],uninstall:[12,2,1,""]},"cpl.utils.string":{String:[12,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[12,2,1,""],convert_to_snake_case:[12,2,1,""],first_to_lower:[12,2,1,""],first_to_upper:[12,2,1,""],random_string:[12,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":[1,2,5,6,7,8,9,10],"byte":12,"case":12,"char":[3,12],"class":[1,2,3,4,5,6,7,8,9,10,11,12],"default":3,"enum":[2,3,4,7,8,9,10,11],"function":[3,12],"int":[3,12],"new":3,"return":[2,3,5,6,7,8,9,10,12],"static":[2,10,12],"transient":7,"true":2,The:13,These:13,Useful:[3,12],abc:[1,2,3,5,6,7,8,9,10],about:13,activ:3,add:[2,7,10],add_configur:2,add_console_argu:2,add_db_context:7,add_environment_vari:2,add_head:10,add_json_fil:2,add_log:7,add_receiv:10,add_scop:7,add_singleton:7,add_transi:7,additional_argu:2,address:10,alias:2,ani:3,app:[1,13],applic:[0,3,13,14],application_abc:[0,14],application_build:[0,14],application_builder_abc:[0,14],application_environ:[0,14],application_environment_abc:[0,9,10,14],application_nam:8,applicationabc:1,applicationbuild:1,applicationbuilderabc:1,applicationenviron:8,applicationenvironmentabc:[8,9,10],appset:1,arg:[1,3,6,12],argument:[2,3],argument_error_funct:2,attribut:[2,4,9,10,11],auth_plugin:4,authplugin:4,back:3,background:3,background_color:3,background_color_enum:[0,14],backgroundcolorenum:3,banner:3,base64:12,base:[1,2,3,4,5,6,7,8,9,10,11,12],befor:3,blue:3,bodi:10,bool:[2,3,10],build:[1,12],build_servic:7,build_service_provid:7,build_str:12,call:[1,3],callabl:[2,3,7],camel:12,can:13,case_sensit:4,casesensit:4,chang:6,charact:3,check:10,check_mail:10,classmethod:[3,12],clear:3,close:3,collect:[2,3,7],color:3,color_reset:3,command:12,common:13,complex:13,config:[1,7],configur:[0,1,4,7,9,10,11,14],configuration_abc:[0,1,7,14],configuration_model_abc:[0,4,9,10,11,14],configuration_variable_name_enum:[0,14],configurationabc:[1,2,7],configurationmodelabc:[2,4,9,10,11],configurationvariablenameenum:2,configure_configur:1,configure_servic:1,connect:[0,4,6,10,14],connection_str:[4,5,6],connectionstr:4,consol:[0,2,9,14],console_argu:[0,14],console_cal:[0,14],console_level:9,consoleargu:2,consolecal:3,consoleloglevel:9,contain:1,context:[0,4,7,14],convert:[2,4,9,10,11,12],convert_to_camel_cas:12,convert_to_snake_cas:12,coordin:3,creat:[1,7,9,10,12,13],credenti:[4,10,12],credential_manag:[0,14],credentialmanag:12,current:8,cursor:3,cursor_background_color:3,cursor_foreground_color:3,custom:[1,2,8],cyan:3,databas:[0,7,14],database_connect:[0,4,14],database_connection_abc:[0,4,14],database_context:[0,4,14],database_context_abc:[0,4,7,14],database_model:[0,14],database_set:[0,5,6,7,14],database_settings_name_enum:[0,14],databaseconnect:5,databaseconnectionabc:5,databasecontext:6,databasecontextabc:[6,7],databaseset:[4,5,6,7],databasesettingsnameenum:4,date_format:11,date_time_format:11,date_time_log_format:11,date_time_now:8,dateformat:11,datetimeformat:11,datetimelogformat:11,db_context:7,db_context_typ:7,db_set:7,debug:9,decod:12,decrypt:12,defin:2,dependency_inject:[0,1,14],desktop:13,detail:13,develop:[8,13],dict:[2,3,4,9,10,11],directori:8,disabl:3,echo:4,effici:13,element:3,email:[0,14],email_client_abc:[0,14],email_client_servic:[0,14],email_client_set:[0,14],email_client_settings_name_enum:[0,14],emailcli:10,emailclientabc:10,emailclientset:10,emailclientsettingsnameenum:10,enabl:3,encod:[4,12],encrypt:12,end:3,end_tim:8,engin:[5,6],enterpris:13,entri:[1,3],enumer:[2,3,4,7,8,9,10,11],env:9,environ:[0,2,9,10,14],environment_nam:8,environment_name_enum:[0,14],environmentnameenum:8,error:[2,3,9],everyth:13,except:9,execut:12,exit:[3,9],fatal:9,file:2,file_level:9,fileloglevel:9,filenam:9,first:[12,13],first_to_low:12,first_to_upp:12,foreground:3,foreground_color:3,foreground_color_enum:[0,14],foregroundcolorenum:3,found:2,from:[1,2,13],from_dict:[2,4,9,10,11],get:12,get_configur:2,get_cont:10,get_execut:12,get_outd:12,get_packag:12,get_servic:7,given:[2,3,7,12],great:13,green:3,grei:3,handl:[3,12],has:3,header:[3,9,10],header_background_color:3,header_foreground_color:3,header_list:10,help:13,hold:3,host:10,host_nam:8,implement:7,info:9,inform:9,input:3,instal:12,instanc:[1,7],instance_typ:7,interact:3,intern:7,invalid:2,is_value_token_opt:2,json:2,key_typ:2,keyword:3,known:2,kwarg:3,last:3,learn:13,length:[3,12],level:9,librari:13,lifetim:7,line:3,list:[2,3,7,10,12],load:1,local:12,log:[0,10,14],logfil:9,logger:[7,9,10],logger_abc:[0,10,14],logger_servic:[0,14],loggerabc:[9,10],logging_level_enum:[0,14],logging_set:[0,14],logging_settings_name_enum:[0,14],logginglevelenum:9,loggingset:9,loggingsettingsnameenum:9,login:10,lower:12,magenta:3,mail:[0,14],mail_set:10,main:1,meant:13,menu:3,messag:[3,9],msg_len:3,name:[2,8,9],next:3,none:[2,3,7,9,10,12],object:[1,2,3,7,10,12],occur:2,off:9,on_blu:3,on_cyan:3,on_default:3,on_green:3,on_grei:3,on_magenta:3,on_r:3,on_whit:3,on_yellow:3,option:[2,3,7,9,10,12],option_background_color:3,option_foreground_color:3,outdat:12,output:[2,3],packag:[12,13],page:13,param:[5,6,7,8,9,10,12],path:[2,9],pip:[0,14],place:2,platform:13,point:[1,3],port:10,posit:3,prefix:2,prepar:1,print:3,product:8,properti:[2,3,4,5,6,7,8,9,10,11],provid:[1,7],python:13,random:12,random_str:12,read:[2,3],read_lin:3,receiv:10,receiver_list:10,red:3,repres:3,reset:[3,12],reset_cursor_posit:3,reset_execut:12,run:[1,3],runtim:8,runtime_directori:8,save:[2,6],save_chang:6,scope:7,search:2,search_typ:2,select:3,send:10,send_mail:10,server:[10,13],servic:[1,7],service_collect:[0,14],service_collection_abc:[0,14],service_descriptor:[0,14],service_lifetime_enum:[0,14],service_provid:[0,14],service_provider_abc:[0,1,14],service_typ:7,servicecollect:7,servicecollectionabc:7,servicedescriptor:7,servicelifetimeenum:7,serviceprovid:7,serviceproviderabc:[1,7],session:[5,6],set:[1,2,3,4,8,9,10,11,12],set_background_color:3,set_cursor_posit:3,set_execut:12,set_foreground_color:3,set_hold_back:3,set_runtime_directori:8,set_working_directori:8,should:2,show:3,shown:2,simpl:13,singleton:7,snake:12,sourc:12,specifi:2,spinner:3,spinner_background_color:3,spinner_foreground_color:3,spinner_thread:[0,14],spinnerthread:3,stage:8,standard:12,start_tim:8,startup:1,startup_abc:[0,14],startupabc:1,stderr:12,stdout:12,stop:3,stop_spin:3,store:2,str:[2,3,5,6,8,9,10,12],string:[0,3,5,6,9,10,14],subject:10,submodul:[0,14],system:12,tabl:[3,12],take:2,termin:3,test:8,text:3,text_background_color:3,text_foreground_color:3,thi:[1,13],thread:3,time:[0,9,14],time_format:[9,11],time_format_set:[0,9,14],time_format_settings_names_enum:[0,14],timeformat:11,timeformatset:[9,11],timeformatsettingsnamesenum:11,to_list:2,token:2,trace:9,traceback:3,transceiv:10,tree:9,type:[1,2,7],understand:13,uninstal:12,union:[2,3,7],upper:12,use:[1,13],use_startup:1,used:1,user_nam:10,usernam:10,util:[0,14],valid:10,valu:[2,3,4,7,8,9,10,11],value_token:2,variabl:2,warn:9,when:3,whether:2,which:[2,3],white:3,work:8,working_directori:8,write:[3,9],write_at:3,write_lin:3,write_line_at:3,yellow:3,you:13,your:13},titles:["CPL","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","Introduction to the CPL Docs","cpl"],titleterms:{applic:1,application_abc:1,application_build:1,application_builder_abc:1,application_environ:8,application_environment_abc:8,background_color_enum:3,configur:2,configuration_abc:2,configuration_model_abc:2,configuration_variable_name_enum:2,connect:5,consol:3,console_argu:2,console_cal:3,context:6,cpl:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],credential_manag:12,databas:[4,5,6],database_connect:5,database_connection_abc:5,database_context:6,database_context_abc:6,database_model:4,database_set:4,database_settings_name_enum:4,dependency_inject:7,doc:13,email:10,email_client_abc:10,email_client_servic:10,email_client_set:10,email_client_settings_name_enum:10,environ:8,environment_name_enum:8,foreground_color_enum:3,introduct:13,log:9,logger_abc:9,logger_servic:9,logging_level_enum:9,logging_set:9,logging_settings_name_enum:9,mail:10,manual:13,pip:12,service_collect:7,service_collection_abc:7,service_descriptor:7,service_lifetime_enum:7,service_provid:7,service_provider_abc:7,spinner_thread:3,startup_abc:1,string:12,submodul:4,time:11,time_format_set:11,time_format_settings_names_enum:11,util:12}}) \ No newline at end of file +Search.setIndex({docnames:["cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","index","modules"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","index.rst","modules.rst"],objects:{"cpl.application":{application_abc:[1,0,0,"-"],application_builder:[1,0,0,"-"],application_builder_abc:[1,0,0,"-"],startup_abc:[1,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[1,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[1,2,1,""],main:[1,2,1,""],run:[1,2,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[1,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[1,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.startup_abc":{StartupABC:[1,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[1,2,1,""],configure_services:[1,2,1,""]},"cpl.configuration":{configuration:[2,0,0,"-"],configuration_abc:[2,0,0,"-"],configuration_model_abc:[2,0,0,"-"],configuration_variable_name_enum:[2,0,0,"-"],console_argument:[2,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[2,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[2,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[2,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[2,2,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[2,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[2,3,1,""],environment:[2,3,1,""],name:[2,3,1,""],to_list:[2,2,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[2,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[2,2,1,""],console_arguments:[2,2,1,""],is_value_token_optional:[2,2,1,""],name:[2,2,1,""],token:[2,2,1,""],value_token:[2,2,1,""]},"cpl.console":{background_color_enum:[3,0,0,"-"],console:[3,0,0,"-"],console_call:[3,0,0,"-"],foreground_color_enum:[3,0,0,"-"],spinner_thread:[3,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[3,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.console":{Console:[3,1,1,""]},"cpl.console.console.Console":{background_color:[3,3,1,""],banner:[3,2,1,""],clear:[3,2,1,""],close:[3,2,1,""],color_reset:[3,2,1,""],disable:[3,2,1,""],enable:[3,2,1,""],error:[3,2,1,""],foreground_color:[3,3,1,""],read:[3,2,1,""],read_line:[3,2,1,""],reset_cursor_position:[3,2,1,""],select:[3,2,1,""],set_background_color:[3,2,1,""],set_cursor_position:[3,2,1,""],set_foreground_color:[3,2,1,""],set_hold_back:[3,2,1,""],spinner:[3,2,1,""],table:[3,2,1,""],write:[3,2,1,""],write_at:[3,2,1,""],write_line:[3,2,1,""],write_line_at:[3,2,1,""]},"cpl.console.console_call":{ConsoleCall:[3,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[3,2,1,""],args:[3,2,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[3,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[3,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[3,2,1,""],run:[3,2,1,""],stop_spinning:[3,2,1,""]},"cpl.database":{database_model:[4,0,0,"-"],database_settings:[4,0,0,"-"],database_settings_name_enum:[4,0,0,"-"]},"cpl.database.connection":{database_connection:[5,0,0,"-"],database_connection_abc:[5,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[5,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[5,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.context":{database_context:[6,0,0,"-"],database_context_abc:[6,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[6,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[6,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.database_settings":{DatabaseSettings:[4,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[4,2,1,""],case_sensitive:[4,2,1,""],connection_string:[4,2,1,""],credentials:[4,2,1,""],echo:[4,2,1,""],encoding:[4,2,1,""],from_dict:[4,2,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[4,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[4,3,1,""],case_sensitive:[4,3,1,""],connection_string:[4,3,1,""],credentials:[4,3,1,""],echo:[4,3,1,""],encoding:[4,3,1,""]},"cpl.dependency_injection":{service_collection:[7,0,0,"-"],service_collection_abc:[7,0,0,"-"],service_descriptor:[7,0,0,"-"],service_lifetime_enum:[7,0,0,"-"],service_provider:[7,0,0,"-"],service_provider_abc:[7,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[7,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[7,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[7,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[7,2,1,""],lifetime:[7,2,1,""],service_type:[7,2,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[7,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[7,3,1,""],scoped:[7,3,1,""],singleton:[7,3,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[7,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[7,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.environment":{application_environment:[8,0,0,"-"],application_environment_abc:[8,0,0,"-"],environment_name_enum:[8,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[8,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[8,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[8,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[8,3,1,""],production:[8,3,1,""],staging:[8,3,1,""],testing:[8,3,1,""]},"cpl.logging":{logger_abc:[9,0,0,"-"],logger_service:[9,0,0,"-"],logging_level_enum:[9,0,0,"-"],logging_settings:[9,0,0,"-"],logging_settings_name_enum:[9,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[9,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logger_service":{Logger:[9,1,1,""]},"cpl.logging.logger_service.Logger":{create:[9,2,1,""],debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[9,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[9,3,1,""],ERROR:[9,3,1,""],FATAL:[9,3,1,""],INFO:[9,3,1,""],OFF:[9,3,1,""],TRACE:[9,3,1,""],WARN:[9,3,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[9,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[9,2,1,""],filename:[9,2,1,""],from_dict:[9,2,1,""],level:[9,2,1,""],path:[9,2,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[9,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[9,3,1,""],file_level:[9,3,1,""],filename:[9,3,1,""],path:[9,3,1,""]},"cpl.mailing":{email:[10,0,0,"-"],email_client_abc:[10,0,0,"-"],email_client_service:[10,0,0,"-"],email_client_settings:[10,0,0,"-"],email_client_settings_name_enum:[10,0,0,"-"]},"cpl.mailing.email":{EMail:[10,1,1,""]},"cpl.mailing.email.EMail":{add_header:[10,2,1,""],add_receiver:[10,2,1,""],body:[10,2,1,""],check_mail:[10,2,1,""],get_content:[10,2,1,""],header:[10,2,1,""],header_list:[10,2,1,""],receiver:[10,2,1,""],receiver_list:[10,2,1,""],subject:[10,2,1,""],transceiver:[10,2,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[10,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_service":{EMailClient:[10,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[10,2,1,""],create:[10,2,1,""],login:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[10,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[10,2,1,""],from_dict:[10,2,1,""],host:[10,2,1,""],port:[10,2,1,""],user_name:[10,2,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[10,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[10,3,1,""],host:[10,3,1,""],port:[10,3,1,""],user_name:[10,3,1,""]},"cpl.time":{time_format_settings:[11,0,0,"-"],time_format_settings_names_enum:[11,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[11,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[11,2,1,""],date_time_format:[11,2,1,""],date_time_log_format:[11,2,1,""],from_dict:[11,2,1,""],time_format:[11,2,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[11,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[11,3,1,""],date_time_format:[11,3,1,""],date_time_log_format:[11,3,1,""],time_format:[11,3,1,""]},"cpl.utils":{credential_manager:[12,0,0,"-"],pip:[12,0,0,"-"],string:[12,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[12,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[12,2,1,""],decrypt:[12,2,1,""],encrypt:[12,2,1,""]},"cpl.utils.pip":{Pip:[12,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[12,2,1,""],get_outdated:[12,2,1,""],get_package:[12,2,1,""],install:[12,2,1,""],reset_executable:[12,2,1,""],set_executable:[12,2,1,""],uninstall:[12,2,1,""]},"cpl.utils.string":{String:[12,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[12,2,1,""],convert_to_snake_case:[12,2,1,""],first_to_lower:[12,2,1,""],first_to_upper:[12,2,1,""],random_string:[12,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":[1,2,5,6,7,8,9,10],"byte":12,"case":12,"char":[3,12],"class":[1,2,3,4,5,6,7,8,9,10,11,12],"default":3,"enum":[2,3,4,7,8,9,10,11],"function":[3,12],"int":[3,12],"new":3,"return":[2,3,7,8,9,10,12],"static":[2,10,12],"transient":7,"true":2,The:13,These:13,Useful:[3,12],abc:[1,2,3,5,6,7,8,9,10],about:13,activ:3,add:[2,7,10],add_configur:2,add_console_argu:2,add_db_context:7,add_environment_vari:2,add_head:10,add_json_fil:2,add_log:7,add_receiv:10,add_scop:7,add_singleton:7,add_transi:7,additional_argu:2,address:10,alias:2,ani:3,app:[1,13],applic:[0,3,13,14],application_abc:[0,14],application_build:[0,14],application_builder_abc:[0,14],application_environ:[0,14],application_environment_abc:[0,9,10,14],application_nam:8,applicationabc:1,applicationbuild:1,applicationbuilderabc:1,applicationenviron:8,applicationenvironmentabc:[8,9,10],appset:1,arg:[1,3,6,12],argument:[2,3],argument_error_funct:2,attribut:[2,4,9,10,11],auth_plugin:4,authplugin:4,back:3,background:3,background_color:3,background_color_enum:[0,14],backgroundcolorenum:3,banner:3,base64:12,base:[1,2,3,4,5,6,7,8,9,10,11,12],befor:3,blue:3,bodi:10,bool:[2,3,10],build:[1,12],build_servic:7,build_service_provid:7,build_str:12,call:[1,3],callabl:[2,3,7],camel:12,can:13,case_sensit:4,casesensit:4,chang:6,charact:3,check:10,check_mail:10,classmethod:[3,12],clear:3,close:3,collect:[2,3,7],color:3,color_reset:3,command:12,common:13,complex:13,config:[1,7],configur:[0,1,4,7,9,10,11,14],configuration_abc:[0,1,7,14],configuration_model_abc:[0,4,9,10,11,14],configuration_variable_name_enum:[0,14],configurationabc:[1,2,7],configurationmodelabc:[2,4,9,10,11],configurationvariablenameenum:2,configure_configur:1,configure_servic:1,connect:[0,4,6,10,14],connection_str:[4,5,6],connectionstr:4,consol:[0,2,9,14],console_argu:[0,14],console_cal:[0,14],console_level:9,consoleargu:2,consolecal:3,consoleloglevel:9,contain:1,context:[0,4,7,14],convert:[2,9,10,11,12],convert_to_camel_cas:12,convert_to_snake_cas:12,coordin:3,core:[5,6],creat:[1,7,9,10,12,13],credenti:[4,10,12],credential_manag:[0,14],credentialmanag:12,current:8,cursor:3,cursor_background_color:3,cursor_foreground_color:3,custom:[1,2,8],cyan:3,databas:[0,7,14],database_connect:[0,4,14],database_connection_abc:[0,4,14],database_context:[0,4,14],database_context_abc:[0,4,7,14],database_model:[0,14],database_set:[0,5,6,7,14],database_settings_name_enum:[0,14],databaseconnect:5,databaseconnectionabc:5,databasecontext:6,databasecontextabc:[6,7],databaseset:[4,5,6,7],databasesettingsnameenum:4,date_format:11,date_time_format:11,date_time_log_format:11,date_time_now:8,dateformat:11,datetimeformat:11,datetimelogformat:11,db_context:7,db_context_typ:7,db_set:7,debug:9,decod:12,decrypt:12,defin:2,dependency_inject:[0,1,14],desktop:13,detail:13,develop:[8,13],dict:[2,3,4,9,10,11],directori:8,disabl:3,doc:[5,6],echo:4,effici:13,element:3,email:[0,14],email_client_abc:[0,14],email_client_servic:[0,14],email_client_set:[0,14],email_client_settings_name_enum:[0,14],emailcli:10,emailclientabc:10,emailclientset:10,emailclientsettingsnameenum:10,enabl:3,encod:[4,12],encrypt:12,end:3,end_tim:8,engin:[5,6],enterpris:13,entri:[1,3],enumer:[2,3,4,7,8,9,10,11],env:9,environ:[0,2,9,10,14],environment_nam:8,environment_name_enum:[0,14],environmentnameenum:8,error:[2,3,9],everyth:13,except:9,execut:12,exit:[3,9],fatal:9,file:2,file_level:9,fileloglevel:9,filenam:9,first:[12,13],first_to_low:12,first_to_upp:12,foreground:3,foreground_color:3,foreground_color_enum:[0,14],foregroundcolorenum:3,found:2,from:[1,2,4,13],from_dict:[2,4,9,10,11],get:12,get_configur:2,get_cont:10,get_execut:12,get_outd:12,get_packag:12,get_servic:7,given:[2,3,4,7,12],great:13,green:3,grei:3,handl:[3,12],has:3,header:[3,9,10],header_background_color:3,header_foreground_color:3,header_list:10,help:13,hold:3,host:10,host_nam:8,html:[5,6],http:[5,6],implement:7,info:9,inform:9,input:3,instal:12,instanc:[1,7],instance_typ:7,interact:3,intern:7,invalid:2,is_value_token_opt:2,json:2,key_typ:2,keyword:3,known:2,kwarg:3,last:3,learn:13,length:[3,12],level:9,librari:13,lifetim:7,line:3,list:[2,3,7,10,12],load:1,local:12,log:[0,10,14],logfil:9,logger:[7,9,10],logger_abc:[0,10,14],logger_servic:[0,14],loggerabc:[9,10],logging_level_enum:[0,14],logging_set:[0,14],logging_settings_name_enum:[0,14],logginglevelenum:9,loggingset:9,loggingsettingsnameenum:9,login:10,lower:12,magenta:3,mail:[0,14],mail_set:10,main:1,meant:13,menu:3,messag:[3,9],msg_len:3,name:[2,8,9],next:3,none:[2,3,7,9,10,12],object:[1,2,3,7,10,12],occur:2,off:9,on_blu:3,on_cyan:3,on_default:3,on_green:3,on_grei:3,on_magenta:3,on_r:3,on_whit:3,on_yellow:3,option:[2,3,7,9,10,12],option_background_color:3,option_foreground_color:3,org:[5,6],outdat:12,output:[2,3],packag:[12,13],page:13,param:[7,8,9,10,12],path:[2,9],pip:[0,14],place:2,platform:13,point:[1,3],port:10,posit:3,prefix:2,prepar:1,print:3,product:8,properti:[2,3,4,5,6,7,8,9,10,11],provid:[1,7],python:13,random:12,random_str:12,read:[2,3],read_lin:3,receiv:10,receiver_list:10,red:3,repres:3,reset:[3,12],reset_cursor_posit:3,reset_execut:12,run:[1,3],runtim:8,runtime_directori:8,save:[2,6],save_chang:6,scope:7,search:2,search_typ:2,see:[5,6],select:3,send:10,send_mail:10,server:[10,13],servic:[1,7],service_collect:[0,14],service_collection_abc:[0,14],service_descriptor:[0,14],service_lifetime_enum:[0,14],service_provid:[0,14],service_provider_abc:[0,1,14],service_typ:7,servicecollect:7,servicecollectionabc:7,servicedescriptor:7,servicelifetimeenum:7,serviceprovid:7,serviceproviderabc:[1,7],session:[5,6],set:[1,2,3,4,8,9,10,11,12],set_background_color:3,set_cursor_posit:3,set_execut:12,set_foreground_color:3,set_hold_back:3,set_runtime_directori:8,set_working_directori:8,should:2,show:3,shown:2,simpl:13,singleton:7,snake:12,sourc:12,specifi:2,spinner:3,spinner_background_color:3,spinner_foreground_color:3,spinner_thread:[0,14],spinnerthread:3,sqlalchemi:[5,6],stage:8,standard:12,start_tim:8,startup:1,startup_abc:[0,14],startupabc:1,stderr:12,stdout:12,stop:3,stop_spin:3,store:2,str:[2,3,5,6,8,9,10,12],string:[0,3,5,6,9,10,14],subject:10,submodul:[0,14],system:12,tabl:[3,12],take:2,termin:3,test:8,text:3,text_background_color:3,text_foreground_color:3,thi:[1,13],thread:3,time:[0,9,14],time_format:[9,11],time_format_set:[0,9,14],time_format_settings_names_enum:[0,14],timeformat:11,timeformatset:[9,11],timeformatsettingsnamesenum:11,to_list:2,token:2,trace:9,traceback:3,transceiv:10,tree:9,type:[1,2,7],understand:13,uninstal:12,union:[2,3,7],upper:12,use:[1,13],use_startup:1,used:1,user_nam:10,usernam:10,util:[0,14],valid:10,valu:[2,3,4,7,8,9,10,11],value_token:2,variabl:2,warn:9,when:3,whether:2,which:[2,3],white:3,work:8,working_directori:8,write:[3,9],write_at:3,write_lin:3,write_line_at:3,yellow:3,you:13,your:13},titles:["CPL","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","Introduction to the CPL Docs","cpl"],titleterms:{applic:1,application_abc:1,application_build:1,application_builder_abc:1,application_environ:8,application_environment_abc:8,background_color_enum:3,configur:2,configuration_abc:2,configuration_model_abc:2,configuration_variable_name_enum:2,connect:5,consol:3,console_argu:2,console_cal:3,context:6,cpl:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],credential_manag:12,databas:[4,5,6],database_connect:5,database_connection_abc:5,database_context:6,database_context_abc:6,database_model:4,database_set:4,database_settings_name_enum:4,dependency_inject:7,doc:13,email:10,email_client_abc:10,email_client_servic:10,email_client_set:10,email_client_settings_name_enum:10,environ:8,environment_name_enum:8,foreground_color_enum:3,introduct:13,log:9,logger_abc:9,logger_servic:9,logging_level_enum:9,logging_set:9,logging_settings_name_enum:9,mail:10,manual:13,pip:12,service_collect:7,service_collection_abc:7,service_descriptor:7,service_lifetime_enum:7,service_provid:7,service_provider_abc:7,spinner_thread:3,startup_abc:1,string:12,submodul:4,time:11,time_format_set:11,time_format_settings_names_enum:11,util:12}}) \ No newline at end of file diff --git a/src/cpl/database/connection/database_connection_abc.py b/src/cpl/database/connection/database_connection_abc.py index 139e9214..c4d6df13 100644 --- a/src/cpl/database/connection/database_connection_abc.py +++ b/src/cpl/database/connection/database_connection_abc.py @@ -19,9 +19,11 @@ class DatabaseConnectionABC(ABC): @abstractmethod def connect(self, connection_string: str): - """ - Connects to a database by connection string - :param connection_string: - :return: + r"""Connects to a database by connection string + + Parameter + --------- + connection_string: :class:`str` + Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html """ pass diff --git a/src/cpl/database/context/database_context_abc.py b/src/cpl/database/context/database_context_abc.py index d27d6da0..4aaed5a9 100644 --- a/src/cpl/database/context/database_context_abc.py +++ b/src/cpl/database/context/database_context_abc.py @@ -20,23 +20,20 @@ class DatabaseContextABC(ABC): @abstractmethod def connect(self, connection_string: str): - """ - Connects to a database with connection string - :param connection_string: - :return: + r"""Connects to a database by connection string + + Parameter + --------- + connection_string: :class:`str` + Database connection string, see: https://docs.sqlalchemy.org/en/14/core/engines.html """ pass def save_changes(self): - """ - Saves changes of the database - """ + r"""Saves changes of the database""" pass @abstractmethod def _create_tables(self): - """ - Create all tables for application from database model - :return: - """ + r"""Create all tables for application from database model""" pass diff --git a/src/cpl/database/database_settings.py b/src/cpl/database/database_settings.py index 130fc78c..70cda14e 100644 --- a/src/cpl/database/database_settings.py +++ b/src/cpl/database/database_settings.py @@ -68,6 +68,12 @@ class DatabaseSettings(ConfigurationModelABC): self._echo = echo def from_dict(self, settings: dict): + r"""Sets attributes from given dict + + Parameter + --------- + settings: :class:`dict` + """ try: self._connection_string = settings[DatabaseSettingsNameEnum.connection_string.value] self._credentials = settings[DatabaseSettingsNameEnum.credentials.value]