Not an Issue - just remark on class

[lucaga]

While learning from the example of product_search and applying it to search bonds, ETF and other products, I ended up in the product_search.py

during my learning process, I had many doubt on what was what and who was doing what. So to simplify my understanding I created a couple of "help class"

• CommonRequest
• ETFsLeveragedsOptionsRequest
  to provide a common inheritance to other classes.

Eventually, I got the lesson I needed, and there isn't any need in the original code for such classes.Though, I'm now here with this typing work done, maybe it is helpful and could help maintaining the code better or to define more accurately default value, for example the offset value, which default gets defined two times.

I ask for feedback: is it worth a PR?

from datetime import datetime
from typing import Any

from pydantic import BaseModel, ConfigDict, Field, model_validator
from pydantic.alias_generators import to_camel


class ProductInfo(BaseModel):
    model_config = ConfigDict(
        extra="allow",
        alias_generator=to_camel,
        populate_by_name=True,
    )


class ProductBatch(BaseModel):
    offset: int = Field(default=10)
    products: list[dict] | None = Field(default=None)
    response_datetime: datetime = Field(default_factory=datetime.now)
    total: int = Field(default=0)


class ProductsConfig(ProductInfo):
    values: dict


class CommonRequest:
  search_text: str | None = Field(default=None)
  offset: int = Field(default=5)
  limit: int = Field(default=100)
  require_total: bool = Field(default=False)
  sort_columns: str = Field(default="name")
  sort_types: str = Field(default="asc")



class WarrantsRequest(ProductInfo,CommonRequest):
    print("WarrantsRequest")


class FundsRequest(ProductInfo,CommonRequest):
    print("FundsRequest")

class LookupRequest(ProductInfo,CommonRequest):
    product_type_id: int


class BondsRequest(ProductInfo,CommonRequest):
    bond_issuer_type_id: int
    bond_exchange_id: int

class FuturesRequest(ProductInfo,CommonRequest):
    future_exchange_id: int
    underlying_isin: str


class StocksRequest(ProductInfo,CommonRequest):
    exchange_id: int | None = Field(default=None)
    is_in_us_green_list: bool | None = Field(default=None, alias="isInUSGreenList")
    index_id: int | None = Field(default=None)
    stock_country_id: int | None = Field(default=None)


class ETFsLeveragedsOptionsRequest:
    input_aggregate_types: str
    input_aggregate_values: str

class ETFsRequest(ProductInfo,CommonRequest,ETFsLeveragedsOptionsRequest):
    popular_only: bool


class LeveragedsRequest(ProductInfo,CommonRequest,ETFsLeveragedsOptionsRequest):
    popular_only: bool
    underlying_product_id: int | None = Field(default=None)
    shortlong: str | None = Field(default=None)


class OptionsRequest(ProductInfo,CommonRequest,ETFsLeveragedsOptionsRequest):
    option_exchange_id: int
    underlying_isin: str


class UnderlyingsRequest(ProductInfo): #This class, although a Request, seems to be good w/o the common items
    future_exchange_id: int | None = Field(default=None)
    option_exchange_id: int | None = Field(default=None)

    int_account: int | None = Field(default=None)
    session_id: str | None = Field(default=None)

    @model_validator(mode="before")
    @classmethod
    def one_of(cls, data: Any):
        if isinstance(data, dict):
            if "future_exchange_id" in data and "option_exchange_id" in data:
                raise ValueError(
                    "Can't set both: `future_exchange_id` and `option_exchange_id`."
                )
            if "future_exchange_id" not in data and "option_exchange_id" not in data:
                raise ValueError(
                    "One of these parameters should be set: `future_exchange_id` or `option_exchange_id`."
                )

        return data


class Underlying(ProductInfo):
    contract_type: int | None = Field(default=None)
    isin: str | None = Field(default=None)
    name: str | None = Field(default=None)
    symbol: str | None = Field(default=None)
    underlying_name: str | None = Field(default=None)
    underlying_product_id: int | None = Field(default=None)

# class BondsRequest(ProductInfo):
#     bond_issuer_type_id: int
#     bond_exchange_id: int
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str


# class ETFsRequest(ProductInfo):
#     popular_only: bool
#     input_aggregate_types: str
#     input_aggregate_values: str
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str


# class FundsRequest(ProductInfo):
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str


# class FuturesRequest(ProductInfo):
#     future_exchange_id: int
#     underlying_isin: str
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str


# class LeveragedsRequest(ProductInfo):
#     popular_only: bool
#     input_aggregate_types: str
#     input_aggregate_values: str
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str
#     underlying_product_id: int | None = Field(default=None)
#     shortlong: str | None = Field(default=None)


# class LookupRequest(ProductInfo):
#     search_text: str
#     limit: int = Field(default=5)
#     offset: int = Field(default=0)
#     product_type_id: int


# class OptionsRequest(ProductInfo):
#     input_aggregate_types: str
#     input_aggregate_values: str
#     option_exchange_id: int
#     underlying_isin: str
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str


# class StocksRequest(ProductInfo):
#     exchange_id: int | None = Field(default=None)
#     is_in_us_green_list: bool | None = Field(default=None, alias="isInUSGreenList")
#     index_id: int | None = Field(default=None)
#     offset: int = Field(default=10)
#     limit: int = Field(default=0)
#     require_total: bool = Field(default=False)
#     search_text: str | None = Field(default=None)
#     sort_columns: str = Field(default="name")
#     sort_types: str = Field(default="asc")
#     stock_country_id: int | None = Field(default=None)




# class WarrantsRequest(ProductInfo):
#     search_text: str
#     offset: int
#     limit: int
#     require_total: bool
#     sort_columns: str
#     sort_types: str





# class UnderlyingsRequest(ProductInfo):
#     future_exchange_id: int | None = Field(default=None)
#     option_exchange_id: int | None = Field(default=None)

#     int_account: int | None = Field(default=None)
#     session_id: str | None = Field(default=None)

#     @model_validator(mode="before")
#     @classmethod
#     def one_of(cls, data: Any):
#         if isinstance(data, dict):
#             if "future_exchange_id" in data and "option_exchange_id" in data:
#                 raise ValueError(
#                     "Can't set both: `future_exchange_id` and `option_exchange_id`."
#                 )
#             if "future_exchange_id" not in data and "option_exchange_id" not in data:
#                 raise ValueError(
#                     "One of these parameters should be set: `future_exchange_id` or `option_exchange_id`."
#                 )

#         return data


# class Underlying(ProductInfo):
#     contract_type: int | None = Field(default=None)
#     isin: str | None = Field(default=None)
#     name: str | None = Field(default=None)
#     symbol: str | None = Field(default=None)
#     underlying_name: str | None = Field(default=None)
#     underlying_product_id: int | None = Field(default=None)

[Chavithra]

Hi @lucaga,

I will take a look at that during the week.

Feel free to join me on Discord if you want to chat about this.

Thanks