o Tj8*@sddlmZmZddlZddlmZmZmZmZm Z ddl m Z m Z ddl m Z mZddl mZmZddlmZdd lmZmZed eeejfd Ze d ZGd ddeZGdddeZGdddeZGdddeZdS))ABCabstractmethodN)ListUnionDictTypeVarLiteral)EQUITY_SCREENER_EQ_MAPEQUITY_SCREENER_FIELDS)FUND_SCREENER_EQ_MAPFUND_SCREENER_FIELDS)ETF_SCREENER_EQ_MAPETF_SCREENER_FIELDSYFNotImplementedError)dynamic_docstring'generate_list_table_from_dict_universalT)bound) eqzis-inbtwngtltgtelteandorc@seZdZdedeedeeeejffddZ e e de fddZ e e de fdd Zdeddd fd d Zdeeeejfdd fd dZdeeeejfdd fddZdeeeejfdd fddZdeddd fddZde fddZddefddZdefddZd S) QueryBaseoperatoroperandcCs|}t|ts tdt|dkrtd|dkr!||n,|dvr+||n"|dkr5||n|dkr?| |n|dvrI| |ntd ||_ ||_ dS) NzInvalid operand typerzInvalid field for EquityQueryIS-IN>ORANDEQBTWN>GTLTGTELTEzInvalid Operator Value) upper isinstancelist TypeErrorlen ValueError_validate_isin_operand_validate_or_and_operand_validate_eq_operand_validate_btwn_operand_validate_gt_ltroperands)selfrr r7Z/home/dinkstrade/pdmp-scanner/venv/lib/python3.10/site-packages/yfinance/screener/query.py__init__s$        zQueryBase.__init__returncCtd)Nz/valid_fields() needs to be implemented by childrr6r7r7r8 valid_fields(zQueryBase.valid_fieldscCr;)Nz/valid_values() needs to be implemented by childrr<r7r7r8 valid_values-r>zQueryBase.valid_valuesNcCsBt|dkr tdtdd|Ddurtdt|ddS)Nz$Operand must be length longer than 1cs|]}t|tVqdSNr+r.0er7r7r8 5z5QueryBase._validate_or_and_operand..FzOperand must be type z for OR/AND)r.r/allr-typer6r r7r7r8r12s z"QueryBase._validate_or_and_operandcstdkr tdtfdd|jDs'tdt|dddd|jvrW|jd}t|trGt j d d |D}d |vrYtd d ddSdS) NrzOperand must be length 2 for EQc3|] }d|vVqdSrNr7rEfields_by_typer r7r8rG<z1QueryBase._validate_eq_operand..Invalid field for  "r"cSg|]}|qSr7r7rDr7r7r8 Cz2QueryBase._validate_eq_operand..r@Invalid EQ value ") r.r/anyr=valuesrJr?r+dictsetunion)r6r vvr7rPr8r28s   zQueryBase._validate_eq_operandcs~tdkr tdtfdd|jDs!tdt|tdtjdur/t dtd tjdur=t ddS) Nz!Operand must be length 3 for BTWNc3rLrMr7rNrPr7r8rGJrQz3QueryBase._validate_btwn_operand..rRr@Fz Invalid comparison type for BTWNr r.r/rYr=rZrJr+numbersRealr-rKr7rPr8r3Gs z QueryBase._validate_btwn_operandcsntdkr tdtfdd|jDs'tdt|dddtd tjd ur5t d dS) Nrz"Operand must be length 2 for GT/LTc3rLrMr7rNrPr7r8rGTrQz,QueryBase._validate_gt_lt..rRrSrrTr@Fz!Invalid comparison type for GT/LTr`rKr7rPr8r4Qs zQueryBase._validate_gt_ltcstdkr tdtfdd|jDs'tdt|dddd|jvra|jd}t|trGt j d d |D}t d tD]}||vr`td |dqNdSdS) Nrz#Operand must be length 2+ for IS-INc3rLrMr7rNrPr7r8rG]rQz3QueryBase._validate_isin_operand..rRrSrrTcSrUr7r7rDr7r7r8rVdrWz4QueryBase._validate_isin_operand..r@rX) r.r/rYr=rZrJr?r+r[r\r]range)r6r r^ir7rPr8r0Ys   z QueryBase._validate_isin_operandcsJj}j}jdkrd}fddjddD}|dd|DdS)Nr!r"cs$g|]}tdjd|gqS)r$r)rJr5)rEvr<r7r8rVos$z%QueryBase.to_dict..r@cSs"g|] }t|tr |n|qSr7)r+rto_dict)rEor7r7r8rVrs"rr5rh)r6opopsr7r<r8rfis  zQueryBase.to_dictrcsd|jj}t|jtrDtdd|jDr5dfdd|jD}|d|jd|dd S|d|jd t|jd S|d|jd t|jd S) N csrArBrCrErir7r7r8rG{rHz%QueryBase.__repr__..z, c3s:|]}dt|tr|dnt|VqdS)rkr@N)r+r__repr__reprrlindent indent_strr7r8rG}s ( (z, [  z])z, )) __class____name__r+r5r,rYjoinrrn)r6rp class_name operands_strr7ror8rmus zQueryBase.__repr__cCs|SrB)rmr<r7r7r8__str__szQueryBase.__str__)r)rv __module__ __qualname__Operatorrrstrrarbr9propertyrrr=r?r1r2r3r4r0rfrmrzr7r7r7r8rs *    rc@s\eZdZdZedeeiedefddZ edee ddgd iedefd d Z d S) EquityQuerya The `EquityQuery` class constructs filters for stocks based on specific criteria such as region, sector, exchange, and peer group. Start with value operations: `EQ` (equals), `IS-IN` (is in), `BTWN` (between), `GT` (greater than), `LT` (less than), `GTE` (greater or equal), `LTE` (less or equal). Combine them with logical operations: `AND`, `OR`. Example: Predefined Yahoo query `aggressive_small_caps`: .. code-block:: python from yfinance import EquityQuery EquityQuery('and', [ EquityQuery('is-in', ['exchange', 'NMS', 'NYQ']), EquityQuery('lt', ["epsgrowth.lasttwelvemonths", 15]) ]) valid_operand_fields_tabler:cCtSz[ Valid operands, grouped by category. {valid_operand_fields_table} )r r<r7r7r8r=zEquityQuery.valid_fieldsvalid_values_tableexchangeindustry) concat_keyscCrz Most operands take number values, but some have a restricted set of valid values. {valid_values_table} )r r<r7r7r8r?rzEquityQuery.valid_valuesN) rvr{r|__doc__rrr rrr=r r?r7r7r7r8rsrc@TeZdZdZedeeiedefddZ edee iedefddZ d S) FundQuerya The `FundQuery` class constructs filters for mutual funds based on specific criteria such as region, sector, exchange, and peer group. Start with value operations: `EQ` (equals), `IS-IN` (is in), `BTWN` (between), `GT` (greater than), `LT` (less than), `GTE` (greater or equal), `LTE` (less or equal). Combine them with logical operations: `AND`, `OR`. Example: Predefined Yahoo query `solid_large_growth_funds`: .. code-block:: python from yfinance import FundQuery FundQuery('and', [ FundQuery('eq', ['categoryname', 'Large Growth']), FundQuery('is-in', ['performanceratingoverall', 4, 5]), FundQuery('lt', ['initialinvestment', 100001]), FundQuery('lt', ['annualreturnnavy1categoryrank', 50]), FundQuery('eq', ['exchange', 'NAS']) ]) rr:cCrr)r r<r7r7r8r=rzFundQuery.valid_fieldsrcCrr)r r<r7r7r8r?rzFundQuery.valid_valuesN) rvr{r|rrrr rrr=r r?r7r7r7r8rsrc@r) ETFQuerya The `ETFQuery` class constructs filters for ETFs based on specific criteria such as category, fund family, exchange, and performance ratings. Start with value operations: `EQ` (equals), `IS-IN` (is in), `BTWN` (between), `GT` (greater than), `LT` (less than), `GTE` (greater or equal), `LTE` (less or equal). Combine them with logical operations: `AND`, `OR`. Example: Predefined Yahoo query `top_etfs_us`: .. code-block:: python from yfinance import ETFQuery ETFQuery('and', [ ETFQuery('gt', ['intradayprice', 10]), ETFQuery('is-in', ['performanceratingoverall', 4, 5]), ETFQuery('eq', ['region', 'us']) ]) rr:cCrr)rr<r7r7r8r=rzETFQuery.valid_fieldsrcCrr)r r<r7r7r8r?rzETFQuery.valid_valuesN) rvr{r|rrrrrrr=r r?r7r7r7r8rsr)abcrrratypingrrrrryfinance.constr r r r r ryfinance.exceptionsrutilsrrr~rbrr}rrrrr7r7r7r8s ~()