Method select

financedatabase/Indices.py:24–134

Select indices based on specified filter criteria. Returns all indices when no input is given and has the option to give a specific combination of indices based on the filters defined. Args: category_group (str | list, optional): Filter by category grou

(
        self,
        category_group: str | list | None = None,
        category: str | list | None = None,
        currency: str | list | None = None,
        exchange: str | list | None = None,
        mic: str | list | None = None,
    )

    FILE_NAME = "indices.bz2"

    def select(
        self,
        category_group: str | list | None = None,
        category: str | list | None = None,
        currency: str | list | None = None,
        exchange: str | list | None = None,
        mic: str | list | None = None,
    ) -> FinanceFrame:
        """
        Select indices based on specified filter criteria.

        Returns all indices when no input is given and has the option to give
        a specific combination of indices based on the filters defined.

        Args:
            category_group (str | list, optional): Filter by category group.
                Default is None, which returns all category groups.
            category (str | list, optional): Filter by category.
                Default is None, which returns all categories.
            currency (str | list, optional): Filter by currency.
                Default is None, which returns all currencies.
            exchange (str | list, optional): Filter by exchange.
                Default is None, which returns all exchanges.
            mic (str | list, optional): Filter by ISO 10383 MIC code.
                Default is None, which returns all MIC codes.

        Raises:
            ValueError: If the specified category group, category, currency, or exchange
                is not available in the database.

        Returns:
            FinanceFrame: DataFrame containing indices data matching the specified criteria.
        """
        indices = self.data.copy(deep=True)

        if category_group:
            category_groups = (
                [category_group] if isinstance(category_group, str) else category_group
            )
            category_groups_lower = [
                category_group.lower() for category_group in category_groups
            ]
            options_lower = [
                option.lower()
                for option in self.show_options(selection="category_group")
            ]
            for category_group_lower, category_group_actual in zip(
                category_groups_lower, category_groups
            ):
                if category_group_lower not in options_lower:
                    raise ValueError(
                        f"The category group '{category_group_actual}' is not available in the database. "
                        "Please check the available category groups using the 'show_options' method."
                    )
            indices = indices[
                indices["category_group"].str.lower().isin(category_groups_lower)
            ]
        if category: