U ku f@sddlmZddlZddlZddlZddlmZdddddddd d d Zddd d dZddd ddZ ddddddddZ dddddZ dS)) annotationsN)AnyFz str | Nonerboolstr)articlevaluenameverbosecapitalreturncCst|tr|}t|s(t|j}n|j}|r>t||}|dks\|dkrDt|sD|dk r|d|}|dk rt|d|S|Snd}t|r|j}nlt|t j r|j}d}nTt|t j r|j j}d}n:t|j tj tj fkrdtt|}d}n t|}d}|r t||}|r0|d}t|||||dSn:|d ksX|dkrr|dkrf|St|d|Std |dS) aReturn string that describes a value Parameters ---------- article : str or None A definite or indefinite article. If the article is indefinite (i.e. "a" or "an") the appropriate one will be inferred. Thus, the arguments of ``describe`` can themselves represent what the resulting string will actually look like. If None, then no article will be prepended to the result. For non-articled description, values that are instances are treated definitely, while classes are handled indefinitely. value : any The value which will be named. name : str or None (default: None) Only applies when ``article`` is "the" - this ``name`` is a definite reference to the value. By default one will be inferred from the value's type and repr methods. verbose : bool (default: False) Whether the name should be concise or verbose. When possible, verbose names include the module, and/or class name where an object was defined. capital : bool (default: False) Whether the first letter of the article should be capitalized or not. By default it is not. Examples -------- Indefinite description: >>> describe("a", object()) 'an object' >>> describe("a", object) 'an object' >>> describe("a", type(object)) 'a type' Definite description: >>> describe("the", object()) "the object at '...'" >>> describe("the", object) 'the object object' >>> describe("the", type(object)) 'the type type' Definitely named description: >>> describe("the", object(), "I made") 'the object I made' >>> describe("the", object, "I will use") 'the object I will use' ZtheN TFzat '%s'z'')rr r )aZanzAThe 'article' argument should be 'the', 'a', 'an', or None not %r) isinstancerlowerinspectisclasstype__name___prefix add_articletypes FunctionType MethodType__func____repr__objecthexidreprjoindescribe ValueError)rrrr r typenameresultZ tick_wrapr$@/tmp/pip-unpacked-wheel-utpcgctl/traitlets/utils/descriptions.pyr sT>            r )rr cCsRt|tjr"td|jddd}n,t|}|dk rJ|jdkrJ|jd}nd}|S)NT)r .builtins)rrrr __self__r getmoduler)rrmoduler$r$r%rzs   rcCs$t|rt|jStt|SdS)zsReturns a string of the value's type with an indefinite article. For example 'an Image' or 'a PlotValue'. N)rrrrclass_ofr)rr$r$r%r,s  r,)rdefiniter r cCsj|rd|}n8tdd|}|dddkr>d|}nd|}|rb|d |ddS|SdS) aReturns the string with a prepended article. The input does not need to begin with a character. Parameters ---------- name : str Name to which to prepend an article definite : bool (default: False) Whether the article is definite or not. Indefinite articles being 'a' and 'an', while 'the' is definite. capital : bool (default: False) Whether the added article should have its first letter capitalized or not. zthe z[\W_]+r(NZaeiouzan za r)recompilesubrupper)rr-r r#Z first_lettersr$r$r%rs  r)objr cCst|}|d|S)z]Return a string representation of a value and its type for readable error messages. r )r)r3Zthe_typer$r$r% repr_typesr4)NFF)FF) __future__rrr/rtypingrr rr,rr4r$r$r$r%s  q