o ȷe@sHddlZddlZddlZd ddZddZddZdd d Zd d ZdS)NFcCsjt|tr |}t|st|j}n|j}|rt||}|dks,|durt|s|durC|d|}|durAt|d|S|Sd}t|rN|j}n5t|t j rZ|j}d}n)t|t j rg|j j}d}nt|j tj tj fvr}dtt|}d}nt|}d}|rt||}|r|d}t|||||dS|d vs|dur|dur|St|d|Std |) 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 infered. 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 infered 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' theN TFzat '%s'z'')nameverbosecapital)aanzAThe 'article' argument should be 'the', 'a', 'an', or None not %r) isinstancestrlowerinspectisclasstype__name___prefix add_articletypes FunctionType MethodType__func____repr__objecthexidreprjoindescribe ValueError)articlevaluerrrtypenameresult tick_wrapr#S/var/www/ideatree/venv/lib/python3.10/site-packages/traitlets/utils/descriptions.pyrsT 8          rcCsVt|tjrtd|jddd}|St|}|dur'|jdkr'|jd}|Sd}|S)NT)r.builtins)r rrr__self__r getmoduler)rrmoduler#r#r$rqs   rcCs t|r t|jStt|S)zsReturns a string of the value's type with an indefinite article. For example 'an Image' or 'a PlotValue'. )r r rrclass_ofr)rr#r#r$r+}s   r+cCsf|rd|}ntdd|}|dddvrd|}nd|}|r1|d |ddS|S) aReturns the string with a prepended article. The input does not need to begin with a charater. 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'Naeiouzan za r)recompilesubr upper)rdefiniterr! first_lettersr#r#r$rs  rcCst|}|d|}|S)z]Return a string representation of a value and its type for readable error messages. r)r)objthe_typemsgr#r#r$ repr_typesr7)NFF)FF)r r.rrrr+rr7r#r#r#r$s k