gjdatac-api 0.0.4__tar.gz → 0.0.5__tar.gz

{gjdatac_api-0.0.4 → gjdatac_api-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gjdatac_api
-Version: 0.0.4
+Version: 0.0.5
 Summary: 主动管理项目第一版(部分接口)
 Home-page: UNKNOWN
 Author: yin

{gjdatac_api-0.0.4 → gjdatac_api-0.0.5}/gjdatac_api/data_api_class.py

@@ -15,6 +15,12 @@ class GJDataC:
     def __init__(self, host, port, user_id, password):
         """
         用于定义一些不同接口所需的变量以及一些初始化操作
+        :param host: 数据库地址
+        :param port: 数据库端口
+        :param user_id: 数据库用户名
+        :param password: 数据库密码
+
+        用户调用api时，需要提供dolphindb相关的用户信息，包括host、port、user_id、password，用于连接数据库
         """
 
         ''' 初始化校验 '''
@@ -25,10 +31,9 @@ class GJDataC:
         self.password = password
 
         # 连接数据库
-        try:
-            self.db_session = ddb.session()
-            self.db_session.connect(self.host, self.port, self.user_id, self.password)
-        except Exception as e:
+        self.db_session = ddb.session()
+        success = self.db_session.connect(self.host, self.port, self.user_id, self.password)
+        if not success:
             raise Exception("please check your database connection information")
 
         ''' 关闭数据库连接 '''
@@ -169,7 +174,7 @@ class GJDataC:
         if not isinstance(param_value, str):
             raise ValueError(f"{param_name} type error, please input str type")
 
-    def __general_validate_asset_type(self, asset_type):
+    def general_validate_asset_type(self, asset_type):
         """
         对asset_type进行校验
         :param asset_type: str, 合约类型
@@ -281,35 +286,35 @@ class GJDataC:
 
         ''' 数据校验 (先对必填参数进行校验)'''
         # 对order_book_ids进行校验
-        self.__get_price_validate_order_book_ids(order_book_ids)
+        self.get_price_validate_order_book_ids(order_book_ids)
 
         # 对asset_type进行校验
-        self.__general_validate_asset_type(asset_type)
+        self.general_validate_asset_type(asset_type)
 
         # 对frequency进行校验
-        self.__get_price_validate_frequency(frequency)
+        self.get_price_validate_frequency(frequency)
 
         # 对 start_date 和 end_date 进行校验
-        self.__get_price_validate_start_end_date(start_date, end_date)
+        self.get_price_validate_start_end_date(start_date, end_date)
 
         ''' 参数校验完成后，开始根据参数从服务器获取数据 '''
         # 此处获取数据时已经根据order_book_ids筛选过一次数据了，所以后续不需要再对该字段进行筛选
-        self.__get_price_data_get_data(order_book_ids, asset_type, frequency)
+        self.get_price_data_get_data(order_book_ids, asset_type, frequency)
 
         ''' 数据处理 '''
         # 根据frequency进行处理
-        self.__get_price_by_type_frequency(asset_type, frequency)
+        self.get_price_by_type_frequency(asset_type, frequency)
 
         # 根据start_date和end_date筛选数据
-        self.__get_price_filter_by_date(start_date, end_date, order_book_ids)
+        self.get_price_filter_by_date(start_date, end_date, order_book_ids)
 
         # 对fields进行处理
-        self.__get_price_validate_fields(fields)
+        self.get_price_validate_fields(fields)
 
         return self.get_price_data
 
     # @staticmethod
-    def __get_price_validate_order_book_ids(self, order_book_ids):
+    def get_price_validate_order_book_ids(self, order_book_ids):
         """
         对order_book_ids 类型 以及 是否必填 进行校验
         :param order_book_ids: 合约类型
@@ -319,7 +324,7 @@ class GJDataC:
         self.general_validate_params_required(order_book_ids, "order_book_ids")  # 校验必填参数
         self.general_validate_field_str_or_list(order_book_ids, "order_book_ids")  # 校验参数类型
 
-    def __get_price_validate_frequency(self, frequency):
+    def get_price_validate_frequency(self, frequency):
         """
         对frequency进行校验
         
@@ -331,7 +336,7 @@ class GJDataC:
         if not isinstance(frequency, str):
             raise ValueError("frequency should be a string")
 
-    def __get_price_validate_start_end_date(self, start_date, end_date):
+    def get_price_validate_start_end_date(self, start_date, end_date):
         """
         对 start_date 和 end_date 进行校验
         校验 start_date 和 end_date 是否同时提供，或者都不提供。
@@ -394,7 +399,7 @@ class GJDataC:
         else:
             return False
 
-    def __get_price_filter_by_date(self, start_date, end_date, order_book_ids):
+    def get_price_filter_by_date(self, start_date, end_date, order_book_ids):
         """
         根据start_date和end_date筛选数据
         此处order_book_ids参数用于处理未传递start_date和end_date的情况(根据order_book_ids返回距离当前时间最近的一条数据)
@@ -431,7 +436,7 @@ class GJDataC:
                 # 使用 tail(1) 获取每个组的最后一条数据
                 self.get_price_data = nearest_data.apply(lambda x: x.tail(1)).reset_index(drop=True)
 
-    def __get_price_validate_fields(self, fields):
+    def get_price_validate_fields(self, fields):
         """
         根据用户选择的字段返回数据
         :param fields: 字段列表 -- 用户传入的需要返回的字段
@@ -441,7 +446,7 @@ class GJDataC:
         """
         self.get_price_data = self.general_validate_fields(self.get_price_data, fields)
 
-    def __get_price_by_type_frequency(self, asset_type, frequency):
+    def get_price_by_type_frequency(self, asset_type, frequency):
         """
         根据合约类型和frequency筛选数据
         
@@ -461,7 +466,7 @@ class GJDataC:
         # frequency存在再根据频率对数据做进一步处理
         else:
             bar_or_tick = get_price_frequency_dict[asset_type][suffix]  # 获取数据类型是bar还是tick，根据值处理字段
-            self.__get_price_data_rename_columns(bar_or_tick)  # 重命名字段
+            self.get_price_data_rename_columns(bar_or_tick)  # 重命名字段
 
     @staticmethod
     def _ends_with(variable, suffixes):
@@ -475,7 +480,7 @@ class GJDataC:
                 return True, suffix
         return False, ""
 
-    def __get_price_data_rename_columns(self, bar_or_tick):
+    def get_price_data_rename_columns(self, bar_or_tick):
         """
         将从数据库中获取的数据列名重命名
         
@@ -575,7 +580,7 @@ class GJDataC:
     #         return result_df
     #     return data.toDF()
 
-    def __get_price_data_get_data(self, order_book_ids, asset_type, frequency):
+    def get_price_data_get_data(self, order_book_ids, asset_type, frequency):
         """ 
         根据参数获取数据库和表名，调用接口获取数据 
 
@@ -623,29 +628,29 @@ class GJDataC:
 
         ''' 数据校验 '''
         # 对order_book_ids和commodity是否必填进行校验
-        self.__get_instruments_validate_order_book_ids_commodity(order_book_ids, commodity)
+        self.get_instruments_validate_order_book_ids_commodity(order_book_ids, commodity)
 
         # 对asset_type进行校验
-        self.__general_validate_asset_type(asset_type)
+        self.general_validate_asset_type(asset_type)
 
         ''' 根据传入的asset_type以及order_book_ids获取数据 '''
-        self.__get_instruments_data_get_data(asset_type=asset_type, order_book_ids=order_book_ids, commodity=commodity)
+        self.get_instruments_data_get_data(asset_type=asset_type, order_book_ids=order_book_ids, commodity=commodity)
 
         # 重命名字段
-        self.__get_instruments_data_rename_columns(asset_type)
+        self.get_instruments_data_rename_columns(asset_type)
 
         # 从交易参数中填充commodity和trading_hour的值
         # self.get_instruments_deal_commodity_trading_hour()
 
         ''' 按照文档筛选需要返回的字段 '''
-        self.__get_instruments_data_filter_return_fileds(asset_type)
+        self.get_instruments_data_filter_return_fileds(asset_type)
 
         # 对fields进行校验并根据fields返回对应的字段
-        self.__get_instruments_validate_fields(fields)
+        self.get_instruments_validate_fields(fields)
 
         return self.get_instruments_data
 
-    def __get_instruments_validate_order_book_ids_commodity(self, order_book_ids, commodity):
+    def get_instruments_validate_order_book_ids_commodity(self, order_book_ids, commodity):
         """
         对order_book_ids和commodity_type进行校验
         order_book_ids和commodity_type二选一，且只能二选一
@@ -687,7 +692,7 @@ class GJDataC:
             commodity, list) else self.get_instruments_data[
             self.get_instruments_data["commodity"] == commodity]
 
-    def __get_instruments_data_filter_return_fileds(self, asset_type):
+    def get_instruments_data_filter_return_fileds(self, asset_type):
         """
         根据asset_type返回对应的字段(不同合约类型字段不同)
         :param asset_type: 合约类型，"future" or "option"
@@ -699,7 +704,7 @@ class GJDataC:
         elif asset_type == "option":
             self.get_instruments_data = self.get_instruments_data[get_instruments_type_dict.get("option_return_fields")]
 
-    def __get_instruments_validate_fields(self, fields):
+    def get_instruments_validate_fields(self, fields):
         """
         根据用户选择的字段返回数据
         :param fields: str or list, 字段列表
@@ -731,7 +736,7 @@ class GJDataC:
 
         return filtered_data
 
-    def __get_instruments_data_get_data(self, asset_type=None, order_book_ids=None, commodity=None):
+    def get_instruments_data_get_data(self, asset_type=None, order_book_ids=None, commodity=None):
         """ 
         根据参数获取数据库和表名，调用接口获取数据 
         
@@ -776,7 +781,7 @@ class GJDataC:
         self.get_instruments_data["commodity"] = ""
         self.get_instruments_data["trading_hour"] = ""
 
-    def __get_instruments_data_rename_columns(self, asset_type):
+    def get_instruments_data_rename_columns(self, asset_type):
         """
         将从数据库中获取的数据列名重命名为文档要求的名字
         
@@ -820,11 +825,11 @@ class GJDataC:
         """
 
         """ 校验参数 """
-        self.get_trading_dates_data = self.__get_trading_dates_validate_date_n_start_end(date, n, start_date, end_date)
+        self.get_trading_dates_data = self.get_trading_dates_validate_date_n_start_end(date, n, start_date, end_date)
 
         return self.get_trading_dates_data
 
-    def __get_trading_dates_validate_date_n_start_end(self, date, n, start_date, end_date):
+    def get_trading_dates_validate_date_n_start_end(self, date, n, start_date, end_date):
         """
         校验date、n和start_date、end_date有效性
         
@@ -840,13 +845,13 @@ class GJDataC:
         if n and (start_date or end_date):
             raise ValueError("parameter error: cannot pass date、n and start_date、end_date at the same time")
         elif date and n:  # 根据date和n获取交易日历
-            return self.__get_trading_dates_by_date_n(date, n)
+            return self.get_trading_dates_by_date_n(date, n)
         elif start_date and end_date:  # 根据start_date和end_date获取交易日历
-            return self.__get_trading_dates_by_start_end(start_date, end_date)
+            return self.get_trading_dates_by_start_end(start_date, end_date)
         else:
             raise ValueError("parameter error: please pass date、n or start_date、end_date")
 
-    def __get_trading_dates_by_date_n(self, date, n):
+    def get_trading_dates_by_date_n(self, date, n):
         """
         校验 date 和 n
         :param date: str--选填, 日期
@@ -866,7 +871,7 @@ class GJDataC:
 
         return self.get_dates_in_n(date, n)
 
-    def __get_trading_dates_by_start_end(self, start_date, end_date):
+    def get_trading_dates_by_start_end(self, start_date, end_date):
         """
         根据start_date和end_date获取交易日历
         :param start_date: str（datetime.date, datetime.datetime）--选填, 开始日期
@@ -1011,27 +1016,6 @@ class GJDataC:
 
         return time_period_mapping_dict[_n]
 
-    # @staticmethod
-    # def get_current_week(date_data):
-    #     """
-    #     获取选定日期的当周。
-
-    #     Args:
-    #         date_data: 选定的日期，可以是 datetime.date 或 datetime.datetime 对象。
-
-    #     Returns:
-    #         一个元组，包含当前周的开始日期和结束日期，类型为 datetime.date。
-    #     """
-
-    #     # 获取星期几 (0-6, 0代表星期一)
-    #     weekday = date_data.weekday()
-
-    #     # 计算当周的开始日期和结束日期
-    #     start_date = date_data - datetime.timedelta(days=weekday)
-    #     end_date = start_date + datetime.timedelta(days=6)
-
-    #     return start_date, end_date
-
     """ get_margin_ratio 期货保证金 """
 
     def get_margin_ratio(self, order_book_id=None, commodity=None, date=datetime.datetime.now(), exchange=None):

{gjdatac_api-0.0.4 → gjdatac_api-0.0.5}/gjdatac_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gjdatac-api
-Version: 0.0.4
+Version: 0.0.5
 Summary: 主动管理项目第一版(部分接口)
 Home-page: UNKNOWN
 Author: yin

{gjdatac_api-0.0.4 → gjdatac_api-0.0.5}/setup.py

@@ -5,7 +5,7 @@ with open('description_info.md', 'r', encoding='utf-8') as f:
 
 setup(
     name='gjdatac_api',  # 你的包名
-    version='0.0.4',  # 版本号
+    version='0.0.5',  # 版本号
     description='主动管理项目第一版(部分接口)',  # 包的简要描述
     long_description=long_description,  # 包的详细描述
     long_description_content_type='text/markdown',  # 描述文件的类型