hrSrSSKrSSKrSSKrSSKrSSKrSSKJr SSKJ r Sr Sr S Sjr S S jr S rS rg)zFCommon functions for working with docstrings. For internal use only. N) compression) transportz* smart_open/doctools.py magic goes herecU(d/$[R"U5RS5n/nU(a,USS:wa#URS5 U(a USS:waM#U(d/$URS5 URS5 UHnUR 5(d U$UR S5(+nU(aJURSS5upVUR 5UR 5/pvnUR XVU/5 MUR S5nU(dMUSSR UR 55 M U$) aExtract keyword argument documentation from a function's docstring. Parameters ---------- docstring: str The docstring to extract keyword arguments from. Returns ------- list of (str, str, list str) str The name of the keyword argument. str Its type. str Its documentation as a list of lines. Notes ----- The implementation is rather fragile. It expects the following: 1. The parameters are under an underlined Parameters section 2. Keyword parameters have the literal ", optional" after the type 3. Names and types are not indented 4. Descriptions are indented with 4 spaces 5. The Parameters section ends with an empty line. Examples -------- >>> docstring = '''The foo function. ... Parameters ... ---------- ... bar: str, optional ... This parameter is the bar. ... baz: int, optional ... This parameter is the baz. ... ... ''' >>> kwargs = extract_kwargs(docstring) >>> kwargs[0] ('bar', 'str, optional', ['This parameter is the bar.'])  r Parameters :r )inspectcleandocsplitpopstrip startswithappend) docstringlineskwargsline is_arg_linenametype_ descriptionis_description_lines M/home/james-whalen/.local/lib/python3.13/site-packages/smart_open/doctools.pyextract_kwargsrs"\    Y ' - -d 3E F E!H , !  E!H ,   IIaL IIaLzz||  M//#.. **S!,KD'+zz|U[[]BD MM4 4 5 "oof5   2JrN ! !$**, / Mc[R"5nUHDup4nURU<U<SU<S35 UHnURU<SU<S35 M MF UR5$)atReconstruct a docstring from keyword argument info. Basically reverses :func:`extract_kwargs`. Parameters ---------- kwargs: list Output from the extract_kwargs function lpad: str, optional Padding string (from the left). Returns ------- str The docstring snippet documenting the keyword arguments. Examples -------- >>> kwargs = [ ... ('bar', 'str, optional', ['This parameter is the bar.']), ... ('baz', 'int, optional', ['This parameter is the baz.']), ... ] >>> print(to_docstring(kwargs), end='') bar: str, optional This parameter is the bar. baz: int, optional This parameter is the baz. z: rr )ioStringIOwritegetvalue)rlpadbufrrrrs r to_docstringr'ksZ> ++-C$* [ $e45D IIdD1 2 %+ <<>rc &[RR[RR[55n[RR USS5n[ U5n[U5nSSS5 WRS5nURS5nXES-US- nSR UVs/sHop[R"S SU5-PM sn5$!,(df  Nt=fs snf![a US -s$f=f) aExtract examples from this project's README.rst file. Parameters ---------- indent: str Prepend each line with this string. Should contain some number of spaces. Returns ------- str The examples. Notes ----- Quite fragile, depends on named labels inside the README.rst file. z..z README.rstNz.. _doctools_before_examples: z.. _doctools_after_examples: z^ zSee README.rst) ospathdirnameabspath__file__joinopenlistindexresub Exception)indentcurr_dir readme_pathfinrstartendrs r extract_examples_from_readme_rstr>s"wwrwwx89H'',,x|kk:;Agc!e$wwUKUTr4!88UKLL   L )((()s7# C>. C(:AC>=$C9!C>( C62 C>>DDc [R"5n[5n[RR [RR [ 55n[R"U5 [S5 [5 [[RR55GHupEU[R:XdXR;aM!URU5 UR n[RR%UR US9nSR'U5<SU<S3n[SU-5 [SS[)U5--5 [SUR*R-S5S -5 [5 [/UR0R*5n U (dGM[[3U S S 95 GM [S 5 [S 5 [5 [[555 [S5 [S5 [5 [6R8"5Hn [SU -5 M [5 [S5 SSS5 UR*(a4UR*R;[<UR?55Ulgg!["a U/nGNf=f!,(df  Nh=f)Nz; smart_open supports the following transport mechanisms:)r</z ()z %s~rrr )r%z Examplesz --------zJ This function also supports transparent compression and decompression z using the following codecs: * %szR The function depends on the file extension to determine the appropriate codec.) r!r"setr,r-r.r0 contextlibredirect_stdoutprintsortedr _REGISTRYitems NO_SCHEMEaddSCHEMESAttributeErrorrelpathr1len__doc__rrr2r'r>rget_supported_extensionsreplace PLACEHOLDERr$) fr&seen root_pathscheme submoduleschemesrOheadingr extensions rtweak_open_docstringr]s ++-C 5D 9:I  # #C ( KL !' (;(;(A(A(C!D F,,, 0A HHY  ##++ggooi&8&8 oJG#&88G#4g>G (W$ % (cCL01 2 (Y..44T:1== > G#INN$:$:;Fvl689'"E* n n  .01 Z[ /0 $==?I *y( )@  bcG )P yyII%%k3<<>B =" #!( # ) (s96A/K& J02CK8B*K0 K=KKK Kc[R"5n[5n/n/n[[R R 55HiupVU[R:XdXb;aM URU5 URUR5 URUR5 Mk [R"U5 [!S5 [!5 UHn[!SU-5 M [!5 [!S5 [!5 UHn[!SU-5 M SSS5 UR"(a4UR"R%[&UR)55Ulgg![a Nf=f![a URU5 GMcf=f!,(df  N=f)Nz Supported URI schemes are:rCz Valid URI examples::)r!r"rDrHrrIrJrKrLextend URI_EXAMPLESrNrMrrErFrGrQrSrTr$)rUr&rVrZexamplesrXrYexamples rtweak_parse_uri_docstringrcs\ ++-C 5DGH#I$7$7$=$=$?@ Y(( (I,=    OOI22 3 # NN9,, -A  # #C ( ./ F *v% &  () G *w& '  ) yyII%%k3<<>B '     # NN6 " " # ) (s1=E?FA#F2? F  F F/.F/2 G)r+)r )rQrEr r!os.pathr,r5r+rrrTrr'r>r]rcrrrfsE   : Nb$N)