feat: translated

Author: edarchimbaud

CHANGELOG.md

@@ -1,9 +1,9 @@
-# 1.0.2版本
+# Version 1.0.2
 
-1. 采用批量方式写入数据，提高效率
+1. Use batch writing to improve efficiency
 
-# 1.0.1版本
+# Version 1.0.1
 
-1. 优化代码中的类型声明信息
-2. 增加对Tick汇总数据的支持
-3. 增加对流式写入参数的支持
+1. Optimize type declaration information in code
+2. Add support for Tick summary data
+3. Add support for streaming write parameters

README.md

@@ -1,4 +1,4 @@
-# VeighNa框架的PostgreSQL数据库接口
+# PostgreSQL Database Interface for VeighNa Framework
 
 <p align="center">
   <img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png"/>
@@ -10,29 +10,29 @@
     <img src ="https://img.shields.io/badge/python-3.7|3.8|3.9|3.10-blue.svg" />
 </p>
 
-## 说明
+## Description
 
-基于peewee开发的PostgreSQL数据库接口。
+Based on the PostgreSQL database interface developed by peewee.
 
-## 使用
+## Use
 
-### 全局配置
+### Global Configuration
 
-在VeighNa中使用PostgreSQL时，需要在全局配置中填写以下字段信息：
+To use PostgreSQL in VeighNa, you need to fill in the following field information in the global configuration:
 
-|名称|含义|必填|举例|
+|name|meaning|required|examples|
 |---------|----|---|---|
-|database.name|名称|是|postgresql|
-|database.host|地址|是|localhost|
-|database.port|端口|是|5432|
-|database.database|实例|是|vnpy|
-|database.user|用户名|是|postgres|
-|database.password|密码|是|123456|
+|database.name|Name|Yes|postgresql|
+|database.host|Address|Yes|localhost|
+|database.port|Port|Yes|5432|
+|database.database|Instance|Yes|vnpy|
+|database.user|Username|Yes|postgres|
+|database.password|Password|Yes|123456|
 
-请注意，VeighNa不会主动为关系型数据库创建数据库，所以请确保你所填的database.database字段对应的数据库已经创建好了。若未创建数据库，请手动连上数据库并创建。
+Please note that VeighNa does not actively create databases for relational databases, so please make sure that the database corresponding to the database.database field you filled in has been created. If no database has been created, please connect to it manually and create it.
 
-### 创建实例
+### Creating an instance
 
-VeighNa不会主动为PostgreSQL数据库创建实例，所以使用前请确保database.database字段中填写的的数据库实例已经创建了。
+VeighNa does not create instances of PostgreSQL databases on its own initiative, so please make sure that the instance of the database you filled in the database.database field has been created before using it.
 
-若实例尚未创建，可以使用【pgAdmin 4】客户端的【Create Database】进行操作。
+If an instance has not been created, you can use [Create Database] in the [pgAdmin 4] client.

vnpy_postgresql/postgresql_database.py

@@ -22,7 +22,7 @@
     BarOverview,
     TickOverview,
     DB_TZ,
-    convert_tz
+    convert_tz,
 )
 from vnpy.trader.setting import SETTINGS
 
@@ -33,12 +33,12 @@
     password=SETTINGS["database.password"],
     host=SETTINGS["database.host"],
     port=SETTINGS["database.port"],
-    autorollback=True
+    autorollback=True,
 )
 
 
 class DbBarData(Model):
-    """K线数据表映射对象"""
+    """K-Line Data Table Mapping Objects"""
 
     id: AutoField = AutoField()
 
@@ -61,7 +61,7 @@ class Meta:
 
 
 class DbTickData(Model):
-    """TICK数据表映射对象"""
+    """TICK data table mapping object"""
 
     id: AutoField = AutoField()
 
@@ -115,7 +115,7 @@ class Meta:
 
 
 class DbBarOverview(Model):
-    """K线汇总数据表映射对象"""
+    """K-Line Summary Data Table Mapping Objects"""
 
     id: AutoField = AutoField()
 
@@ -132,7 +132,7 @@ class Meta:
 
 
 class DbTickOverview(Model):
-    """Tick汇总数据表映射对象"""
+    """Tick Summary Data Table Mapping Object"""
 
     id: AutoField = AutoField()
 
@@ -148,7 +148,7 @@ class Meta:
 
 
 class PostgresqlDatabase(BaseDatabase):
-    """PostgreSQL数据库接口"""
+    """PostgreSQL Database Interface"""
 
     def __init__(self) -> None:
         """"""
@@ -157,14 +157,14 @@ def __init__(self) -> None:
         self.db.create_tables([DbBarData, DbTickData, DbBarOverview, DbTickOverview])
 
     def save_bar_data(self, bars: List[BarData], stream: bool = False) -> bool:
-        """保存K线数据"""
-        # 读取主键参数
+        """Save K-Line Data"""
+        # Read the primary key parameters
         bar: BarData = bars[0]
         symbol: str = bar.symbol
         exchange: Exchange = bar.exchange
         interval: Interval = bar.interval
 
-        # 将BarData数据转换为字典，并调整时区
+        # Converting BarData data to a dictionary and adjusting the time zone
         data: list = []
 
         for bar in bars:
@@ -177,7 +177,7 @@ def save_bar_data(self, bars: List[BarData], stream: bool = False) -> bool:
             d.pop("vt_symbol")
             data.append(d)
 
-        # 使用upsert操作将数据更新到数据库中 chunked批量操作加快速度
+        # Updating data to the database using the upsert operation chunked batch operation to speed it up
         with self.db.atomic():
             for c in chunked(data, 100):
                 DbBarData.insert_many(c).on_conflict(
@@ -188,7 +188,7 @@ def save_bar_data(self, bars: List[BarData], stream: bool = False) -> bool:
                         DbBarData.open_price: DbBarData.open_price,
                         DbBarData.high_price: DbBarData.high_price,
                         DbBarData.low_price: DbBarData.low_price,
-                        DbBarData.close_price: DbBarData.close_price
+                        DbBarData.close_price: DbBarData.close_price,
                     },
                     conflict_target=(
                         DbBarData.symbol,
@@ -198,7 +198,7 @@ def save_bar_data(self, bars: List[BarData], stream: bool = False) -> bool:
                     ),
                 ).execute()
 
-        # 更新K线汇总数据
+        # Updated K-line summary data
         overview: DbBarOverview = DbBarOverview.get_or_none(
             DbBarOverview.symbol == symbol,
             DbBarOverview.exchange == exchange.value,
@@ -232,13 +232,13 @@ def save_bar_data(self, bars: List[BarData], stream: bool = False) -> bool:
         return True
 
     def save_tick_data(self, ticks: List[TickData], stream: bool = False) -> bool:
-        """保存TICK数据"""
-        # 读取主键参数
+        """Save TICK data"""
+        # Read the primary key parameters
         tick: TickData = ticks[0]
         symbol: str = tick.symbol
         exchange: Exchange = tick.exchange
 
-        # 将TickData数据转换为字典，并调整时区
+        # Converting TickData data to a dictionary and adjusting the time zone
         data: list = []
 
         for tick in ticks:
@@ -250,7 +250,7 @@ def save_tick_data(self, ticks: List[TickData], stream: bool = False) -> bool:
             d.pop("vt_symbol")
             data.append(d)
 
-        # 使用upsert操作将数据更新到数据库中
+        # Updating data into the database using the upsert operation
         with self.db.atomic():
             for d in data:
                 DbTickData.insert(d).on_conflict(
@@ -259,8 +259,6 @@ def save_tick_data(self, ticks: List[TickData], stream: bool = False) -> bool:
                         DbTickData.symbol,
                         DbTickData.exchange,
                         DbTickData.datetime,
-
-
                     ),
                 ).execute()
 
@@ -308,7 +306,7 @@ def save_tick_data(self, ticks: List[TickData], stream: bool = False) -> bool:
                     ),
                 ).execute()
 
-        # 更新Tick汇总数据
+        # Update Tick summary data
         overview: DbTickOverview = DbTickOverview.get_or_none(
             DbTickOverview.symbol == symbol,
             DbTickOverview.exchange == exchange.value,
@@ -329,8 +327,7 @@ def save_tick_data(self, ticks: List[TickData], stream: bool = False) -> bool:
             overview.end = max(ticks[-1].datetime, overview.end)
 
             s: ModelSelect = DbTickData.select().where(
-                (DbTickData.symbol == symbol)
-                & (DbTickData.exchange == exchange.value)
+                (DbTickData.symbol == symbol) & (DbTickData.exchange == exchange.value)
             )
             overview.count = s.count()
 
@@ -344,17 +341,19 @@ def load_bar_data(
         exchange: Exchange,
         interval: Interval,
         start: datetime,
-        end: datetime
+        end: datetime,
     ) -> List[BarData]:
-        """读取K线数据"""
+        """Read K-line data"""
         s: ModelSelect = (
-            DbBarData.select().where(
+            DbBarData.select()
+            .where(
                 (DbBarData.symbol == symbol)
                 & (DbBarData.exchange == exchange.value)
                 & (DbBarData.interval == interval.value)
                 & (DbBarData.datetime >= start)
                 & (DbBarData.datetime <= end)
-            ).order_by(DbBarData.datetime)
+            )
+            .order_by(DbBarData.datetime)
         )
 
         bars: List[BarData] = []
@@ -371,27 +370,25 @@ def load_bar_data(
                 high_price=db_bar.high_price,
                 low_price=db_bar.low_price,
                 close_price=db_bar.close_price,
-                gateway_name="DB"
+                gateway_name="DB",
             )
             bars.append(bar)
 
         return bars
 
     def load_tick_data(
-        self,
-        symbol: str,
-        exchange: Exchange,
-        start: datetime,
-        end: datetime
+        self, symbol: str, exchange: Exchange, start: datetime, end: datetime
     ) -> List[TickData]:
-        """读取TICK数据"""
+        """Read TICK data"""
         s: ModelSelect = (
-            DbTickData.select().where(
+            DbTickData.select()
+            .where(
                 (DbTickData.symbol == symbol)
                 & (DbTickData.exchange == exchange.value)
                 & (DbTickData.datetime >= start)
                 & (DbTickData.datetime <= end)
-            ).order_by(DbTickData.datetime)
+            )
+            .order_by(DbTickData.datetime)
         )
 
         ticks: List[TickData] = []
@@ -433,27 +430,24 @@ def load_tick_data(
                 ask_volume_4=db_tick.ask_volume_4,
                 ask_volume_5=db_tick.ask_volume_5,
                 localtime=db_tick.localtime,
-                gateway_name="DB"
+                gateway_name="DB",
             )
             ticks.append(tick)
 
         return ticks
 
     def delete_bar_data(
-        self,
-        symbol: str,
-        exchange: Exchange,
-        interval: Interval
+        self, symbol: str, exchange: Exchange, interval: Interval
     ) -> int:
-        """删除K线数据"""
+        """Delete K-line data"""
         d: ModelDelete = DbBarData.delete().where(
             (DbBarData.symbol == symbol)
             & (DbBarData.exchange == exchange.value)
             & (DbBarData.interval == interval.value)
         )
         count: int = d.execute()
 
-        # 删除K线汇总数据
+        # Delete K-line summary data
         d2: ModelDelete = DbBarOverview.delete().where(
             (DbBarOverview.symbol == symbol)
             & (DbBarOverview.exchange == exchange.value)
@@ -462,19 +456,14 @@ def delete_bar_data(
         d2.execute()
         return count
 
-    def delete_tick_data(
-        self,
-        symbol: str,
-        exchange: Exchange
-    ) -> int:
-        """删除TICK数据"""
+    def delete_tick_data(self, symbol: str, exchange: Exchange) -> int:
+        """Delete TICK data"""
         d: ModelDelete = DbTickData.delete().where(
-            (DbTickData.symbol == symbol)
-            & (DbTickData.exchange == exchange.value)
+            (DbTickData.symbol == symbol) & (DbTickData.exchange == exchange.value)
         )
         count: int = d.execute()
 
-        # 删除Tick汇总数据
+        # Delete Tick Summary Data
         d2: ModelDelete = DbTickOverview.delete().where(
             (DbTickOverview.symbol == symbol)
             & (DbTickOverview.exchange == exchange.value)
@@ -484,8 +473,8 @@ def delete_tick_data(
         return count
 
     def get_bar_overview(self) -> List[BarOverview]:
-        """查询数据库中的K线汇总信息"""
-        # 如果已有K线，但缺失汇总信息，则执行初始化
+        """Query the K-line summary information in the database"""
+        # If there is already a K-line, but summary information is missing, perform initialization
         data_count: int = DbBarData.select().count()
         overview_count: int = DbBarOverview.select().count()
         if data_count and not overview_count:
@@ -500,7 +489,7 @@ def get_bar_overview(self) -> List[BarOverview]:
         return overviews
 
     def get_tick_overview(self) -> List[TickOverview]:
-        """查询数据库中的Tick汇总信息"""
+        """Query the database for Tick summary information"""
         s: ModelSelect = DbTickOverview.select()
         overviews: list = []
         for overview in s:
@@ -509,19 +498,13 @@ def get_tick_overview(self) -> List[TickOverview]:
         return overviews
 
     def init_bar_overview(self) -> None:
-        """初始化数据库中的K线汇总信息"""
-        s: ModelSelect = (
-            DbBarData.select(
-                DbBarData.symbol,
-                DbBarData.exchange,
-                DbBarData.interval,
-                fn.COUNT(DbBarData.id).alias("count")
-            ).group_by(
-                DbBarData.symbol,
-                DbBarData.exchange,
-                DbBarData.interval
-            )
-        )
+        """Initialize the K-line summary information in the database"""
+        s: ModelSelect = DbBarData.select(
+            DbBarData.symbol,
+            DbBarData.exchange,
+            DbBarData.interval,
+            fn.COUNT(DbBarData.id).alias("count"),
+        ).group_by(DbBarData.symbol, DbBarData.exchange, DbBarData.interval)
 
         for data in s:
             overview: DbBarOverview = DbBarOverview()