o 6WjX@sUdZddlmZddlZddlZddlmZddlmZddl m Z m Z m Z ddl mZmZmZmZddlmZmZmZmZd d lmZd Zejd ksQejd krWd=ddZnd=ddZd>ddZdddd?d!d"Zed#Zd$ed%< e eeZ!d&ed'<Gd(d)d)e Z"Gd*d+d+e#Z$Gd,d-d-e Z%e%j&Z& ee%j&Z'd$ed.< Gd/d0d0eZ(d1d2d@d4d5Z)dAd9d:Z*dd2dBd;d<Z+dS)CzEHigh-level introspection utilities, used to inspect type annotations.) annotationsN) Generator)InitVar)EnumIntEnumauto)AnyLiteral NamedTuplecast) TypeAlias assert_neverget_args get_origin)typing_objects)AnnotationSourceForbiddenQualifierInspectedAnnotation Qualifierget_literal_valuesinspect_annotationis_union_origin))r objrreturnboolcCs t|SaReturn whether the provided origin is the union form. ```pycon >>> is_union_origin(typing.Union) True >>> is_union_origin(get_origin(int | str)) True >>> is_union_origin(types.UnionType) True ``` !!! note Since Python 3.14, both `Union[, , ...]` and ` | | ...` forms create instances of the same [`typing.Union`][] class. As such, it is recommended to not use this function anymore (provided that you only support Python 3.14 or greater), and instead use the [`typing_objects.is_union()`][typing_inspection.typing_objects.is_union] function directly: ```python from typing import Union, get_origin from typing_inspection import typing_objects typ = int | str # Or Union[int, str] origin = get_origin(typ) if typing_objects.is_union(origin): ... ``` )ris_unionrr"n/home/esfera/Documents/content_generation/venv/lib/python3.10/site-packages/typing_inspection/introspection.pyrs rcCst|p |tjuSr)rr types UnionTyper!r"r"r#r>svalueNonecCs8t|ttttttjfs|tjurt|ddSdS)zCType check the provided literal value against the legal parameters.zK is not a valid literal value, must be one of: int, bytes, str, Enum, None.N) isinstanceintbytesstrrrrNoneType TypeError)r&r"r"r#_literal_type_check^s  r.Feager type_checkunpack_type_aliases annotationr1r2#Literal['skip', 'lenient', 'eager']Generator[Any]c cs`|dkr)d}|jD]}|rt||dus|tjur#|s dVd}q |Vq dSg}|jD]Y}t|rjz|j}WntyW|dkrF|rLt|||t|fYq.wt |||d}| dd|Dq.|rpt||tjur~|dtjfq.||t|fq.zt |}Wnt yd d|DEdHYdSwd d|DEdHdS) a=Yield the values contained in the provided [`Literal`][typing.Literal] [special form][]. Args: annotation: The [`Literal`][typing.Literal] [special form][] to unpack. type_check: Whether to check if the literal values are [legal parameters][literal-legal-parameters]. Raises a [`TypeError`][] otherwise. unpack_type_aliases: What to do when encountering [PEP 695](https://peps.python.org/pep-0695/) [type aliases][type-aliases]. Can be one of: - `'skip'`: Do not try to parse type aliases. Note that this can lead to incorrect results: ```pycon >>> type MyAlias = Literal[1, 2] >>> list(get_literal_values(Literal[MyAlias, 3], unpack_type_aliases="skip")) [MyAlias, 3] ``` - `'lenient'`: Try to parse type aliases, and fallback to `'skip'` if the type alias can't be inspected (because of an undefined forward reference). - `'eager'`: Parse type aliases and raise any encountered [`NameError`][] exceptions (the default): ```pycon >>> type MyAlias = Literal[1, 2] >>> list(get_literal_values(Literal[MyAlias, 3], unpack_type_aliases="eager")) [1, 2, 3] ``` Note: While `None` is [equivalent to][none] `type(None)`, the runtime implementation of [`Literal`][typing.Literal] does not de-duplicate them. This function makes sure this de-duplication is applied: ```pycon >>> list(get_literal_values(Literal[NoneType, None])) [None] ``` Example: ```pycon >>> type Ints = Literal[1, 2] >>> list(get_literal_values(Literal[1, Ints], unpack_type_alias="skip")) ["a", Ints] >>> list(get_literal_values(Literal[1, Ints])) [1, 2] >>> list(get_literal_values(Literal[1.0], type_check=True)) Traceback (most recent call last): ... TypeError: 1.0 is not a valid literal value, must be one of: int, bytes, str, Enum, None. ``` skipFNTr/r0css|] }|t|fVqdSN)type).0ar"r"r# sz%get_literal_values..cs|]\}}|VqdSr7r"r9p_r"r"r#r;csr<r7r"r=r"r"r#r;r@)__args__r.rr,is_typealiastype __value__ NameErrorappendr8rextenddictfromkeysr-) r3r1r2 _has_noneargvalues_and_type alias_valuesub_argsdctr"r"r#rgsN:       r)required not_required read_only class_varinit_varfinalr rset[Qualifier]_all_qualifiersc@s^eZdZdZeZ eZ eZ eZ eZ eZ eZ eZ e dddZdS)rzThe source of an annotation, e.g. a class or a function. Depending on the source, different [type qualifiers][type qualifier] may be (dis)allowed. rrUcCsz|tjurdhS|tjurddhS|tjurhdS|tjur#hdS|tjtjtjfvr0tS|tj ur7t St |dS)zIThe allowed [type qualifiers][type qualifier] for this annotation source.rTrR>rTrSrR>rOrQrPN) rASSIGNMENT_OR_VARIABLECLASS DATACLASS TYPED_DICT NAMED_TUPLEFUNCTIONBAREsetANYrVr selfr"r"r#allowed_qualifiers<s      z#AnnotationSource.allowed_qualifiersN)rrU)__name__ __module__ __qualname____doc__rrWrXrYrZr[r\r_r]propertyrbr"r"r"r#rs(      rc@s&eZdZUdZded< d ddZdS) rz-The provided [type qualifier][] is forbidden.r qualifierrr'cCs ||_dSr7)rh)rarhr"r"r#__init__Vs zForbiddenQualifier.__init__N)rhrrr')rcrdrerf__annotations__rir"r"r"r#rPs rc@s&eZdZeZdddZdddZdS) _UnknownTypeEnumrr+cCdS)NUNKNOWNr"r`r"r"r#__str__]z_UnknownTypeEnum.__str__cCrl)Nz r"r`r"r"r#__repr__`roz_UnknownTypeEnum.__repr__N)rr+)rcrdrerrmrnrpr"r"r"r#rkZs rk _UnkownTypec@s.eZdZUdZded< ded< ded<dS) rz'The result of the inspected annotation.zAny | _UnkownTyper8rU qualifiersz list[Any]metadataN)rcrdrerfrjr"r"r"r#rks  rr6r2annotation_sourcecCs|j}t}g} t||d\}}|r||}qt|}|durt|r8d|vr-td|d|jd}n{t |rPd|vrEtd|d|jd}nct |rhd|vr]td|d|jd}nKt |rd|vrutd|d|jd}n3t |rd |vrtd|d |jd}nnt |trd |vrtd |d tt|j}nnq t |rd|vrtd|dt}n(t|rd|vrtd|dt}n|turd |vrtd |d t}t|||S) a Inspect an [annotation expression][], extracting any [type qualifier][] and metadata. An [annotation expression][] is a [type expression][] optionally surrounded by one or more [type qualifiers][type qualifier] or by [`Annotated`][typing.Annotated]. This function will: - Unwrap the type expression, keeping track of the type qualifiers. - Unwrap [`Annotated`][typing.Annotated] forms, keeping track of the annotated metadata. Args: annotation: The annotation expression to be inspected. annotation_source: The source of the annotation. Depending on the source (e.g. a class), different type qualifiers may be (dis)allowed. To allow any type qualifier, use [`AnnotationSource.ANY`][typing_inspection.introspection.AnnotationSource.ANY]. unpack_type_aliases: What to do when encountering [PEP 695](https://peps.python.org/pep-0695/) [type aliases][type-aliases]. Can be one of: - `'skip'`: Do not try to parse type aliases (the default): ```pycon >>> type MyInt = Annotated[int, 'meta'] >>> inspect_annotation(MyInt, annotation_source=AnnotationSource.BARE, unpack_type_aliases='skip') InspectedAnnotation(type=MyInt, qualifiers={}, metadata=[]) ``` - `'lenient'`: Try to parse type aliases, and fallback to `'skip'` if the type alias can't be inspected (because of an undefined forward reference): ```pycon >>> type MyInt = Annotated[Undefined, 'meta'] >>> inspect_annotation(MyInt, annotation_source=AnnotationSource.BARE, unpack_type_aliases='lenient') InspectedAnnotation(type=MyInt, qualifiers={}, metadata=[]) >>> Undefined = int >>> inspect_annotation(MyInt, annotation_source=AnnotationSource.BARE, unpack_type_aliases='lenient') InspectedAnnotation(type=int, qualifiers={}, metadata=['meta']) ``` - `'eager'`: Parse type aliases and raise any encountered [`NameError`][] exceptions. Returns: The result of the inspected annotation, where the type expression, used qualifiers and metadata is stored. Example: ```pycon >>> inspect_annotation( ... Final[Annotated[ClassVar[Annotated[int, 'meta_1']], 'meta_2']], ... annotation_source=AnnotationSource.CLASS, ... ) ... InspectedAnnotation(type=int, qualifiers={'class_var', 'final'}, metadata=['meta_1', 'meta_2']) ``` TrtNrRrrTrOrPrQrS)rbr^_unpack_annotatedrr is_classvarraddrAis_final is_requiredis_notrequired is_readonlyr(rr rr8rmr)r3rur2rbrrrs_metaoriginr"r"r#rsv8                  -     rLiteral['lenient', 'eager']check_annotatedtuple[Any, list[Any]]c Cs.t|}|r$t|r$|j}t|j}t||dd\}}||}||fSt|rSz|j}Wnt y?|dkr:Y|gfSwt||dd\}}|rO||fS|gfSt|rz|j}Wnt yn|dkriY|gfSwz||j }Wn t yYnwt||dd\}}|r||fS|gfS|gfS)NFr2rr/T) rr is_annotated __origin__list __metadata___unpack_annotated_innerrBrCrDrAr-) r3r2rr~annotated_typerssub_metar&typr"r"r#rsZ     +       rcCs<|dkrtt|r|jt|jfS|gfSt||ddS)Nr6Tr)rrrrrrr)r3r2r"r"r#rvBs rv)rrrr)r&rrr')r3rr1rr2r4rr5)r3rrurr2r4rr)r3rr2rrrrr)r3rr2r4rr),rf __future__rsysr$collections.abcr dataclassesrenumrrrtypingrr r r typing_extensionsr r rrr__all__ version_inforr.rrrjr^rVr Exceptionrrkrmrqrrrrvr"r"r"r#sD      "  pq   |D