l0jPPUddlZddlZddlZddlZddlZddlZddlZddlm Z m Z m Z ddlm Z m Z mZmZmZmZmZmZmZddlmZmZmZmZmZGddZdeed fd ed dezd efd Zdede edededed ef dZ dede ed efdZ!de eee fd e"efdZ#ededzZ$ee%d<e&edddkr.e'(e$de)e'(e$ddd e"d efd!Z*d e+d efd"Z,d e-d efd#Z.d ed efd$Z/d ed efd%Z0d&e d'e d efd(Z1d e2d efd)Z3d dezfd*Z4d efd+Z5d ej6d efd,Z7d ej8d-e9d efd.Z:d efd/Z;d efd0Zd2e9d efd3Z?ed4Z@Gd5d6e e@ZAejBe>ee9effZCejDe>eAefZEe>e>efZF[A[@ejGd7ZHd8ZId9d:eId:d:d;d;d:df d e dede9d2e9d?e9d-e9d@e9dAde+ezd efdBZJdCd9d:eId:d:d;d;d:dD d e dEedede9d2e9d?e9d-e9d@e9d efdFZKdCd9d:eId:d:d;d;d:dD d e dEedede9d2e9d?e9d-e9d@e9d dfdGZLdHedIed efdJZMdS)KN)CallableIterableSequence) AnyGenericLiteral NamedTupleTypeVarUnioncastget_args get_origin) AbstractDocBreakDoc ConcatDocTextDoc pformat_docc&eZdZdefdZdefdZdS) _WithReprstringc||_dSNr)selfrs ]/home/wildlama/miniconda3/envs/lam/lib/python3.11/site-packages/wadler_lindig/_definitions.py__init__z_WithRepr.__init__s  returnc|jSrr)rs r__repr__z_WithRepr.__repr__"s {rN)__name__ __module__ __qualname__strrr!rrrrsJs#rrshape.dtypekindrc:|dddddddd}d tt|}|d |d }| |d |dz}t |S)aSummarises an array based on its shape/dtype/kind. (Where 'kind' refers to NumPy vs PyTorch vs JAX etc.) **Arguments:** - `shape`: a tuple of integers. - `dtype`: a string, for which common dtypes will be contracted (`float -> f`, `uint -> u`, `int -> i`, `complex -> c`) - `kind`: optional. If provided it is written in brackets afterwards. **Returns:** A [`wadler_lindig.TextDoc`][] with text looking like e.g. `f32[2,3,4](numpy)` for a NumPy array of shape `(2, 3, 4)` and `float32` dtype. floatfuintuinticomplexc,[]N())replacejoinmapr%r)r'r(r) short_dtype short_shapeouts r array_summaryr>&s"  gs##       C  ((3sE??++K  ) ); ) ) )C KKKK 3<<rbegindocssependindentcLt|dkr||zSd|D}tdt||z|tdz}||z|zS)aCA helper for formatting a 'bracketed' object: tuples, lists, classes, etc, which are all represented in essentially similar ways: a pair of brackets (whether round, square, etc.), a sequence of values in between -- which are indented if laid out in vertical mode, and possibly a name as prefix. See the [`(break-group).nest-break` example](./pattern.ipynb) for more on the pattern that this enables. **Arguments:** - `begin`: appears at the start, before any indent. - `docs:`: a sequence of documents. They will either be laid out horizontally together or vertically together. - `sep`: each element of `docs` will be separated by `sep`. - `end`: appears at the end, after any indent. - `indent`: how much to indent (for [`wadler_lindig.NestDoc`][] to use) when laying out vertically. **Returns:** A document in `(break-group).nest-break` form. !!! example Formatting a list, which do not have any name prefix: ```python import wadler_lindig as wl wl.bracketed( begin=wl.TextDoc("["), docs=[wl.pdoc(x) for x in obj], sep=wl.comma, end=wl.TextDoc("]"), indent=indent, ) ``` Formatting a frozenset, which does have a name prefix: ```python import wadler_lindig as wl wl.bracketed( begin=wl.TextDoc("frozenset({"), docs=[wl.pdoc(x) for x in obj], sep=wl.comma, end=wl.TextDoc("})"), indent=indent, ) ``` rc6g|]}|Sr&)group).0xs r zbracketed..s (((a (((r)lenrFrr9nest)r?r@rArBrCnesteds r bracketedrNCsr 4yyA~~ ""$$$((4(((2,,c4!6!6!8!88>>vFFRTU$++---rct|dkrtS|dg}|ddD],}||||-t|S)zConcatenates `objs` together separated by `sep`. **Arguments:** - `sep`: the separate to use. - `docs`: a sequence of documents to join. **Returns:** `ConcatDoc(docs[0], sep, docs[1], sep, docs[2], ..., sep, docs[-1])` rrN)rKrappend)rAr@piecesobjs rr9r9sq 4yyA~~{{1gYFABBx c c f rpairsc fd|DS)a8Formats key-value pairs in the form 'key=value'. **Arguments:** - `pairs`: an iterable of `(key, value)` pairs. - `**kwargs`: passed on to each `pdoc(value, **kwargs)` **Returns:** A list of documents `TextDoc(key) + TextDoc("=") + pdoc(value, **kwargs)` for each key-value pair. cpg|]2\}}t|tdzt|fiz3S)=)rpdocrGkeyvaluekwargss rrIznamed_objs..sC X X XJCGCLL73<< '$u*?*?*?*? ? X X Xrr&)rSr[s `r named_objsr\s! Y X X XRW X X XXrr3 commaGENERATING_DOCUMENTATIONrJz wadler-lindigr#__doc__z/A shorthand for `TextDoc(',') + BreakDoc(' ')`.rRc ttdfd|DttddS)Nr4c*g|]}t|fiSr&rWrGrHr[s rrIz!_pformat_list..s) - - -Ad1 - - -rr5rCr?r@rArBrC)rNrr^rRr[s `r _pformat_listrgsN cll - - - - - - -  CLLh    rc t|dkrtdSttdfd|DttddS)Nrzset(){c*g|]}t|fiSr&rcrds rrIz _pformat_set..)111$q##F##111r}rCrerKrrNr^rfs `r _pformat_setrnsk 3xx1}}w#,,1111S111 (#     rc t|dkrtdSttdfd|DttddS)Nrz frozenset()z frozenset({c*g|]}t|fiSr&rcrds rrIz&_pformat_frozenset..rkrz})rCrermrfs `r_pformat_frozensetrqsm 3xx1}}}%%%-((1111S111 (#     rc t|dkr%t|dfitdzg}nfd|D}ttd|ttddS) Nrrr3c*g|]}t|fiSr&rcrds rrIz"_pformat_tuple..s)///aQ!!&!!///rr6r7rCre)rKrWrrNr^rRr[objss ` r_pformat_tuplervs 3xx1}}SV&&v&&56////3/// cll   CLLh    rc tfdjDfi|}ttjjdz|t td|dS)Nc4g|]}|t|fSr&)getattr)rGnamerRs rrIz'_pformat_namedtuple..s(JJJdgc4001JJJrr6r7rCre)r\_fieldsrNr __class__r"r^rts` r_pformat_namedtupler}sr JJJJckJJJ U Uf U UD cm,s233   CLLh    rrYrZc xt|fi|tdztdzt|fi|zS)N:r])rWrr)rYrZr[s r _dict_entryrsC   v   - =U@U@Uf@U@U UUrc fd|D}ttd|ttddS)Nc2g|]\}}t||fiSr&)rrXs rrIz!_pformat_dict..s/ L L L*#uKU - -f - - L L LrrirlrCre)itemsrNrr^rts ` r _pformat_dictrs[ L L L L L L LD cll   CLLh    rcdD]E\}}|tjvr2t|ttj||r|cSFdS)N))numpyndarray)torchTensor)jaxArray)zmlx.corearray)sysmodules isinstancery)rHmodulers r _array_kindrsV  S[ Z73;v;NPU3V3V%W%W MMM 4rc |d}|rSt|}|Jt|jd^}}t |j||St t|S)N short_arrays.)rr%r(rsplitr>r'rrepr)rRr[rr)_r(s r_pformat_ndarrayr st.)L53 NN))#.. ESYt444 499  rc t|jfigfd|jDzt|jfiz}t td|ttddS)Nc*g|]}t|fiSr&rcrds rrIz$_pformat_partial..s) / / /4  V   / / /rzpartial(r7rCre) rWfuncargsr\keywordsrrNrr^rts ` r_pformat_partialrs ch ! !& ! !" / / / /ch / / / 0 S\'')) 4 4V 4 4 5 j!!   CLLh    rshow_function_modulec ~t|drd}nd}|r|jd|j}n|j}td|d|dS)N __wrapped__zwrapped functionfunctionr)hasattrr#r$r)rRrr[fnrzs r_pformat_functionr%sq sM""   .553#355 #r##D### $ $$rc *dt|jz}td}g}tj|D]_}|jrVt ||j|}|dr ||jus/| |j ||f`t|fi|}| }|d|d<tt|jfi|t!dz|t"t!d|d S) Nrz hide_defaultsshow_dataclass_moduleshow_type_moduler6r7rCre)typer"r dataclassesfieldsrryrzdefaultrP removeprefixr\copyrNrWr|rr^)rRr[ type_name uninitialisedrufieldrZ name_kwargss r_pformat_dataclassr4s%d3ii((I/00M D#C((II : IC];;E?+ I0F0F UZ44Y??GHHH d % %f % %D++--K&,-D&EK"# 3=00K0073<<?   CLLh    rc tdtdz}fdt|D}t||S)Nr]z| c*g|]}t|fiSr&rcrds rrIz"_pformat_union..K) 5 5 5!D  f   5 5 5r)rrr r9)rRr[barr@s ` r_pformat_unionrIsF 3--'$-- 'C 5 5 5 5x}} 5 5 5D T??rc fdt|D}ttt|fit dz|t t ddS)Nc*g|]}t|fiSr&rcrds rrIz*_pformat_generic_alias..Prrr4r5rCre)r rNrWrrr^)rRr[r@s ` r_pformat_generic_aliasrOst 5 5 5 5x}} 5 5 5D :c??--f-- <   CLLh    rrc ~t|drMt|dr=|r |jdvrt|jSt|jd|jStt |S)Nr#r$)builtinstypingtyping_extensionszcollections.abcr)rr#rr$r)rRrr[s r _pformat_typerZssL!! "gc>&B&B " C3>6 $ $ 3+,, ,cnAAs/?AABB BtCyy!!!r_TceZdZdS)_FooN)r"r#r$r&rrrrnsDrrc#Kt|}|| dV||dS#||wxYwr)idaddremove)seenrRid_s r _seen_contextrxs^ S''CHHSMMM  C Cs AAcdSrr&)rs r_noners 4rTFrcustomrr respect_pdocseen_idsc  B| t} t|| vrtdSt|tr|S|| d<|| d<|| d<|| d<| | d<|| d<|| d <|| d <|| d <t | |5||} | | cdddS|r_t t|d rB|jdi| } t| tr | cdddS||tj urtd cdddSt|trUt |dr,ttt|fi| cdddSt!|fi| cdddSt|t"rt%|fi| cdddSt|t&rt)|fi| cdddSt|trt+|fi| cdddSt|t,rt/|fi| cdddSt|t0jrt5|fi| cdddSt|tjrt9|fi| cdddS|t:urtdcdddSt|t<rt?|fi| cdddSt|t@rtC|fi| cdddSt|tDrtG|fi| cdddStIj%|r.t|tstM|fi| cdddStO|tQ|fi| cdddS|durtdcdddSttS|cdddS#1swxYwYdS)u Formats an object into a Wadler–Lindig document. Such documents are essentially strings that haven't yet been pretty-formatted to a particular width. **Arguments:** - `obj`: the object to pretty-doc. - `indent`: when the contents of a structured type are too large to fit on one line, they will be indented by this amount and placed on separate lines. - `short_arrays`: whether to print a NumPy array / PyTorch tensor / JAX array as a short summary of the form `f32[3,4]` (here indicating a `float32` matrix of shape `(3, 4)`) - `custom`: a way to pretty-doc custom types. This will be called on every object it encounters. If its return is `None` then the usual behaviour will be performed. If its return is an `AbstractDoc` then that will be used instead. - `hide_defaults`: whether to show the default values of dataclass fields. - `show_type_module`: whether to show the name of the module for a type: `somelib.SomeClass` versus `SomeClass`. - `show_dataclass_module`: whether to show the name of the module for a dataclass instance: `somelib.SomeClass()` versus `SomeClass()`. - `show_function_module`: whether to show the name of the module for a function: `` versus ``. - `seen_ids`: the `id(...)` of any Python objects that have already been seen, and should not be further introspected to avoid recursion errors (e.g. `x = []; x.append(x)`). Note that for efficiency, this argument will be mutated with the ids encountered. - `**kwargs`: all kwargs are forwarded on to all `__pdoc__` calls, as an escape hatch for custom behaviour. **Returns:** A pretty-doc representing `obj`. !!! info The behaviour of this function can be customised in two ways. First, any object which implements a `__pdoc__(self, **kwargs) -> None | AbstractDoc` method will have that method called to determine its pretty-doc. Second, the `custom` argument to this function can be used. This is particularly useful to provide custom pretty-docs for objects provided by third-party libraries. (For which you cannot add a `__pdoc__` method yourself.) Nz rCrrrrrrrr__pdoc__Noner{r.z...r&)*setrrrrrrrrrFtypesNoneTypetupler}r r rvlistrgdictrrn frozensetrqftpartialr FunctionTyperr _union_typesr_generic_alias_typesr _type_typesrr is_dataclassrrrr) rRrCrrrrrrrrr[ maybe_custom custom_pps rrWrWst55 #ww(}%%%#{## F8)F>F8+F?!F:!1F &;F "#%9F !")F> x % %-"-"vc{{  #-"-"-"-"-"-"-"-"  )GDIIz:: )$ ..v..I)[11 ) ((-"-"-"-"-"-"-"-" ;#//6??-"-"-"-"-"-"-"-" c5 ! ! 1sI&& L*4 C+@+@KKFKK-"-"-"-"-"-"-"-" "#0000!-"-"-"-"-"-"-"-"" c4  0 ////%-"-"-"-"-"-"-"-"& c4  0 ////)-"-"-"-"-"-"-"-"* c3   /..v..--"-"-"-"-"-"-"-". c9 % % 5%c44V441-"-"-"-"-"-"-"-"2 c2: & & 3#C226225-"-"-"-"-"-"-"-"6 c5- . . 4$S33F339-"-"-"-"-"-"-"-": #::5>>=-"-"-"-"-"-"-"-"> c< ( ( 1!#0000A-"-"-"-"-"-"-"-"D c/ 0 0 9)#8888G-"-"-"-"-"-"-"-"H c; ' ' 0 ////K-"-"-"-"-"-"-"-"L  #C ( ( 5C1F1F 5%c44V44O-"-"-"-"-"-"-"-"P s   '#C22622S-"-"-"-"-"-"-"-"T #::5>>W-"-"-"-"-"-"-"-"ZtCyy!![-"-"-"-"-"-"-"-"-"-"-"-"-"-"-"-"-"-"sP!APP-AP> P!P!P3!P!!P&P&P5P!P!P5!P#5P%P P,PPPX widthrCrrrrrrrrc Nt|f|||||||| d| } t| |S)z[As [`wadler_lindig.pprint`][], but returns a string instead of printing to stdout. )rCrrrrrrr)rWr) rRrrCrrrrrrrr[docs rpformatrsT$   !#)31!     C sE " ""rc  Ntt|f||||||||| d | dS)aPretty-prints an object to stdout. **Arguments:** - `obj`: the object to pretty-print. - `width`: a best-effort maximum width to allow. May be exceeded if there are unbroken pieces of text which are wider than this. - `indent`: when the contents of a structured type are too large to fit on one line, they will be indented by this amount and placed on separate lines. - `short_arrays`: whether to print a NumPy array / PyTorch tensor / JAX array as a short summary of the form `f32[3,4]` (here indicating a `float32` matrix of shape `(3, 4)`) - `custom`: a way to pretty-print custom types. This will be called on every object it . If its return is `None` then the default behaviour will be performed. If its return is an [`wadler_lindig.AbstractDoc`][] then that will be used instead. - `hide_defaults`: whether to show the default values of dataclass fields. - `show_type_module`: whether to show the name of the module for a type: `somelib.SomeClass` versus `SomeClass`. - `show_dataclass_module`: whether to show the name of the module for a dataclass instance: `somelib.SomeClass()` versus `SomeClass()`. - `show_function_module`: whether to show the name of the module for a function: `` versus ``. - `**kwargs`: all other unrecognized kwargs are forwarded on to any `__pdoc__` methods encountered, as an escape hatch for custom behaviour. **Returns:** A string representing `obj`. !!! info The behaviour of this function can be customised in two ways. First, any object which implements a `__pdoc__(self, **kwargs) -> None | AbstractDoc` method will have that method called to determine its pretty-doc. Second, the `custom` argument to this function can be used. This is particularly useful to provide custom pretty-docs for objects provided by third-party libraries. (For which you cannot add a `__pdoc__` method.) rN)printr) rRrrCrrrrrrrr[s rpprintr$s`p   %'-"7!5%  rminusplusctj||}dd|D}|S)uReturns a pretty-diff between two strings. (This is just a thin wrapper around the builtin `difflib`, and is just here as a helper for common use-cases.) !!! example ```python minus = "hello\nthere\nobi wan kenobi" plus = "hello\nthere\npatrick kidger" print(wadler_lindig.pdiff(minus, plus)) #  hello #  there # - obi wan kenobi # + patrick kidger ``` **Arguments:** - `minus`: any lines unique to this string will be prefixed with a `-`. - `plus`: any lines unique to this string will be prefixed with a `+`. **Returns:** A diff between the two tsrings `minus` and `plus`, showing their shared lines once and the unique lines from each.  c3DK|]}|d|VdS)?N) startswith)rGlines r zpdiff..s3GGd$//#2F2FGTGGGGGGr)difflibndiff splitlinesr9)rrdiffs rpdiffrmsP8 =))++T__->-> ? ?D 99GGdGGG G GD Kr)N contextlibrr functoolsrrrrcollections.abcrrrrrrr r r r r r_wadler_lindigrrrrrrrr/r%r>rNr9rr\r^__annotations__ryobject __setattr__r"rgrrnrrqrvr}rrrrrrrrboolrrrrrrrr UnionTyper GenericAliasrrcontextmanagerrrrWrrrr&rrr s 8888888888                      sCxD3J7:>. >. ; >. >.  >.  >.  >.>.>.>.Bk+!6;* YhuS#X/ Yd;>O Y Y Y Y WS\\HHSMM1{111 76-r22oEE ulH555  yO t+  c        I  K       K    ZkVSVV;VVVVt+ dSj    { "* ;     %   %6: % % % % %*[ ["t"$"[""""" WT]]     72;   eD#I&6!7!78 *DDcOO<TT']]# "  27!"'!& $z"z" z" z"z" cUD;.. / z"  z"  z" z"z"z"SXoz"z"z"z"z"@27!"'!&### # #  #  # cUD;.. / ### ### ####H27!"'!&FFF F F  F  F cUD;.. / FFF FFF FFFFRCCr