o Tj@snddlmZmZddlZddlmZmZmZddl m Z ddl m Z ddl mZe dZGd d d eZdS) )ABCabstractmethodN)DictListOptional) _QUERY1_URL_)YfData)Tickerz /v1/financec@seZdZdZd#dedefddZedefd d Zedefd d Zedefd dZ ede fddZ ede fddZ edeejfddZedee eeffddZde fddZd$ddZde fddZdeejfddZed$dd Zd$d!d"ZdS)%Domainz Abstract base class representing a domain entity in financial data, with key attributes and methods for fetching and parsing data. Derived classes must implement the `_fetch_and_parse()` method. NUSkeyregioncCsH||_||_||_t|d|_d|_d|_d|_ d|_ d|_ dS)a Initializes the Domain object with a key, session, and region. Args: key (str): Unique key identifying the domain entity. session (Optional[requests.Session]): Session object for HTTP requests. Defaults to None. region (str): Yahoo region (ISO 3166-1 alpha-2 country code, e.g. "US", "GB", "FR", "DE", "JP"). Determines the regional scope of returned data such as ``top_companies``. Defaults to "US". )sessionN) _keyrstripupper_regionr _data_name_symbol _overview_top_companies_research_reports)selfr rrrY/home/dinkstrade/pdmp-scanner/venv/lib/python3.10/site-packages/yfinance/domain/domain.py__init__s   zDomain.__init__returncCs|jS)z Retrieves the key of the domain entity. Returns: str: The unique key of the domain entity. )rrrrrr 'sz Domain.keycC||j|jS)z| Retrieves the name of the domain entity. Returns: str: The name of the domain entity. )_ensure_fetchedrrrrrname1 z Domain.namecCr )z Retrieves the symbol of the domain entity. Returns: str: The symbol representing the domain entity. )r!rrrrrsymbol<r#z Domain.symbolcCs||jt|jS)z Retrieves a Ticker object based on the domain entity's symbol. Returns: Ticker: A Ticker object associated with the domain entity. )r!rr rrrrtickerGs  z Domain.tickercCr )z Retrieves the overview information of the domain entity. Returns: Dict: A dictionary containing an overview of the domain entity. )r!rrrrroverviewRr#zDomain.overviewcCr )z Retrieves the top companies within the domain entity. Returns: pandas.DataFrame: A DataFrame containing the top companies in the domain. )r!rrrrr top_companies]r#zDomain.top_companiescCr )z Retrieves research reports related to the domain entity. Returns: List[Dict[str, str]]: A list of research reports, where each report is a dictionary with metadata. )r!rrrrrresearch_reportshr#zDomain.research_reportscCs$ddd|jd}|jj||d}|S)z Fetches data from the given query URL. Args: query_url (str): The URL used for the data query. Returns: Dict: The JSON response data from the request. truezen-US) formatted withReturnslangr)params)rr get_raw_json)r query_url params_dictresultrrr_fetchss z Domain._fetchcCsP|d|_|d|_||di|_||di|_|d|_dS)z Parses and assigns common data fields such as name, symbol, overview, and top companies. Args: data (Dict): The raw data received from the API. r"r$r& topCompaniesresearchReportsN)getrr_parse_overviewr_parse_top_companiesrr)rdatarrr_parse_and_assign_commons  zDomain._parse_and_assign_commonc Csd|dd|didd|dd|dd|dd|didd|d iddd S) z Parses the overview data for the domain entity. Args: overview (Dict): The raw overview data. Returns: Dict: A dictionary containing parsed overview information. companiesCountN marketCaprawmessageBoardId descriptionindustriesCount marketWeight employeeCount)companies_count market_capmessage_board_idr>industries_count market_weightemployee_countr5)rr&rrrr6s    zDomain._parse_overviewcCs2gd}dd|D}|sdStj||ddS)a) Parses the top companies data and converts it into a pandas DataFrame. Args: top_companies (Dict): The raw top companies data. Returns: Optional[pandas.DataFrame]: A DataFrame containing top company data, or None if no data is available. )r$r"ratingz market weightc Ss:g|]}|d|d|d|diddfqS)r$r"rIr@r<NrH).0crrr sz/Domain._parse_top_companies..N)columnsr$)_pd DataFrame set_index)rr'top_companies_columntop_companies_valuesrrrr7s zDomain._parse_top_companiescCstd)z Abstract method for fetching and parsing domain-specific data. Must be implemented by derived classes. z>_fetch_and_parse() needs to be implemented by children classes)NotImplementedErrorrrrr_fetch_and_parseszDomain._fetch_and_parsecCs|dur |dSdS)z Ensures that the given attribute is fetched by calling `_fetch_and_parse()` if the attribute is None. Args: attribute: The attribute to check and potentially fetch. N)rT)r attributerrrr!s zDomain._ensure_fetched)Nr )rN)__name__ __module__ __qualname____doc__strrpropertyr r"r$r r%rr&rrNrOr'rr(r2r9r6r7rrTr!rrrrr s0         r )abcrrpandasrNtypingrrrconstrr8r r%r _QUERY_URL_r rrrrs