smartrack-sdk 1.0.0__py3-none-any.whl

smartrack_sdk/models/requests.py

@@ -0,0 +1,291 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+请求模型类
+包含所有API请求的数据模型
+"""
+
+from abc import ABC
+from datetime import datetime
+from typing import Dict, Any, List, Optional
+from dataclasses import dataclass, field
+
+from .enums import LedColors, RackTestMode
+
+
+@dataclass
+class BaseRequest(ABC):
+    """API请求基类"""
+
+    user_id: str = ""
+    client_id: str = ""
+    session_id: str = field(default_factory=lambda: str(int(datetime.now().timestamp())))
+    timestamp: str = field(default_factory=lambda: datetime.now().isoformat())
+    extra_data: Dict[str, Any] = field(default_factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        return {
+            "userId": self.user_id,
+            "clientId": self.client_id,
+            "sessionId": self.session_id,
+            "timestamp": self.timestamp,
+            "extraData": self.extra_data,
+        }
+
+    def add_extra_data(self, key: str, value: Any) -> None:
+        """添加附加数据"""
+        self.extra_data[key] = value
+
+    def __post_init__(self):
+        """初始化后处理"""
+        if not self.session_id:
+            self.session_id = str(int(datetime.now().timestamp()))
+        if not self.timestamp:
+            self.timestamp = datetime.now().isoformat()
+
+
+@dataclass
+class ClearErrorRequest(BaseRequest):
+    """清错错误请求"""
+
+    rack_id: Optional[str] = None  # 料架编号 (优先级低于储位号)
+    cell_id: Optional[str] = None  # 储位编号 (如果CellId不为空,则忽略RackId)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        if self.rack_id:
+            base_dict["rackId"] = self.rack_id
+        if self.cell_id:
+            base_dict["cellId"] = self.cell_id
+        return base_dict
+
+    def set_cell_id(self, cell_id: str) -> None:
+        """设置储位编号"""
+        self.cell_id = cell_id
+
+    def set_rack_id(self, rack_id: str) -> None:
+        """设置料架编号"""
+        self.rack_id = rack_id
+
+
+@dataclass
+class RackTestRequest(BaseRequest):
+    """料架测试请求"""
+
+    rack_id: str = ""  # 料架编号
+    test_mode: RackTestMode = RackTestMode.ALL_OFF  # 测试模式
+    led_color: LedColors = LedColors.OFF  # 亮灯颜色
+    is_blink: bool = False  # 是否闪烁
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict.update({
+            "rackId": self.rack_id,
+            "testMode": self.test_mode.value,
+            "ledColor": self.led_color.value,
+            "isBlink": self.is_blink,
+        })
+        return base_dict
+
+    def set_rack_id(self, rack_id: str) -> None:
+        """设置料架编号"""
+        self.rack_id = rack_id
+
+    def set_test_mode(self, test_mode: RackTestMode) -> None:
+        """设置测试模式"""
+        self.test_mode = test_mode
+
+    def set_led_color(self, led_color: LedColors) -> None:
+        """设置亮灯颜色"""
+        self.led_color = led_color
+
+    def set_blink(self, is_blink: bool) -> None:
+        """设置是否闪烁"""
+        self.is_blink = is_blink
+
+
+@dataclass
+class StockInRequest(BaseRequest):
+    """入库请求"""
+
+    sheet_id: str = ""  # 入库单号
+    rack_id: str = ""  # 料架编号
+    grn: str = ""  # 朔源码
+    led_color: LedColors = LedColors.GREEN  # 亮灯颜色
+    is_blink: bool = True  # 是否闪烁
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict.update({
+            "sheetId": self.sheet_id,
+            "rackId": self.rack_id,
+            "grn": self.grn,
+            "ledColor": self.led_color.value,
+            "isBlink": self.is_blink,
+        })
+        return base_dict
+
+    def set_sheet_id(self, sheet_id: str) -> None:
+        """设置入库单号"""
+        self.sheet_id = sheet_id
+
+    def set_rack_id(self, rack_id: str) -> None:
+        """设置料架编号"""
+        self.rack_id = rack_id
+
+    def set_grn(self, grn: str) -> None:
+        """设置溯源码"""
+        self.grn = grn
+
+    def set_led_color(self, led_color: LedColors) -> None:
+        """设置亮灯颜色"""
+        self.led_color = led_color
+
+    def set_blink(self, is_blink: bool) -> None:
+        """设置是否闪烁"""
+        self.is_blink = is_blink
+
+
+@dataclass
+class StockOutRequest(BaseRequest):
+    """出库请求"""
+
+    led_color: LedColors = LedColors.RED  # 亮灯颜色
+    is_blink: bool = True  # 是否闪烁
+    grn_list: List[str] = field(default_factory=list)  # 出库朔源码列表
+    sheet_id: Optional[str] = None  # 请求单号
+
+    def add_grn(self, grn: str) -> None:
+        """添加朔源码"""
+        if grn not in self.grn_list:
+            self.grn_list.append(grn)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict.update({
+            "ledColor": self.led_color.value,
+            "isBlink": self.is_blink,
+            "grnList": self.grn_list,
+        })
+        if self.sheet_id:
+            base_dict["sheetId"] = self.sheet_id
+        return base_dict
+
+
+@dataclass
+class StockOutSheetRequest(BaseRequest):
+    """单号出库请求"""
+
+    sheet_id: str = ""  # 工单号/领料单号
+    grn_list: List[str] = field(default_factory=list)  # 出库朔源码列表
+
+    def add_grn(self, grn: str) -> None:
+        """添加朔源码"""
+        if grn not in self.grn_list:
+            self.grn_list.append(grn)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict.update({
+            "sheetId": self.sheet_id,
+            "grnList": self.grn_list,
+        })
+        return base_dict
+
+    def set_sheet_id(self, sheet_id: str) -> None:
+        """设置工单号/领料单号"""
+        self.sheet_id = sheet_id
+
+
+@dataclass
+class StockOutSheetCancelRequest(BaseRequest):
+    """单号出库取消请求"""
+
+    sheet_id: str = ""  # 工单号/领料单号
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict["sheetId"] = self.sheet_id
+        return base_dict
+
+    def set_sheet_id(self, sheet_id: str) -> None:
+        """设置工单号/领料单号"""
+        self.sheet_id = sheet_id
+
+
+@dataclass
+class StockOutSheetFinishRequest(BaseRequest):
+    """单号出库完成请求"""
+
+    sheet_id: str = ""  # 工单号/领料单号
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict["sheetId"] = self.sheet_id
+        return base_dict
+
+    def set_sheet_id(self, sheet_id: str) -> None:
+        """设置工单号/领料单号"""
+        self.sheet_id = sheet_id
+
+
+@dataclass
+class StockInFinishRequest(BaseRequest):
+    """入库完成请求"""
+
+    sheet_id: str = ""  # 入库单号
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict["sheetId"] = self.sheet_id
+        return base_dict
+
+    def set_sheet_id(self, sheet_id: str) -> None:
+        """设置入库单号"""
+        self.sheet_id = sheet_id
+
+
+@dataclass
+class ResetCellRequest(BaseRequest):
+    """重置储位状态请求"""
+
+    cell_list: List[str] = field(default_factory=list)  # 储位列表
+
+    def add_cell(self, cell_id: str) -> None:
+        """添加储位"""
+        if cell_id not in self.cell_list:
+            self.cell_list.append(cell_id)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict["cellList"] = self.cell_list
+        return base_dict
+
+
+@dataclass
+class GetStockByGRNListRequest(BaseRequest):
+    """通过GRN列表查询库存请求"""
+
+    grn_list: List[str] = field(default_factory=list)  # GRN列表
+
+    def add_grn(self, grn: str) -> None:
+        """添加GRN"""
+        if grn not in self.grn_list:
+            self.grn_list.append(grn)
+
+    def to_dict(self) -> Dict[str, Any]:
+        """转换为字典"""
+        base_dict = super().to_dict()
+        base_dict["grnList"] = self.grn_list
+        return base_dict

smartrack_sdk/models/responses.py

@@ -0,0 +1,209 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+响应模型类
+包含所有API响应的数据模型
+"""
+
+from dataclasses import dataclass, field
+from typing import List, Optional, Any, Dict
+from datetime import datetime
+
+from .enums import LedColors, CellStatus
+
+
+@dataclass
+class BaseResponse:
+    """API响应基类"""
+
+    code: int = 0  # 返回代码
+    message: str = ""  # 返回消息
+    session_id: str = ""  # 会话Id
+    timestamp: str = field(default_factory=lambda: datetime.now().isoformat())  # 时间戳
+
+    @property
+    def is_success(self) -> bool:
+        """判断是否成功"""
+        return self.code == 0
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'BaseResponse':
+        """从字典创建实例"""
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", ""),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+        )
+
+
+@dataclass
+class StockDataDto:
+    """库存数据Dto"""
+
+    rack_id: Optional[str] = None  # 料架号
+    grn: Optional[str] = None  # GRN
+    cell_id: Optional[str] = None  # 储位号
+    stock_in_sheet: Optional[str] = None  # 入库单号
+    stock_out_sheet: Optional[str] = None  # 出库单号
+    led_color: Optional[LedColors] = None  # LED颜色
+    is_blink: Optional[bool] = None  # 是否闪烁
+    status: Optional[CellStatus] = None  # 状态
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'StockDataDto':
+        """从字典创建实例"""
+        led_color = data.get("ledColor")
+        status = data.get("status")
+
+        return cls(
+            rack_id=data.get("rackId"),
+            grn=data.get("grn"),
+            cell_id=data.get("cellId"),
+            stock_in_sheet=data.get("stockInSheet"),
+            stock_out_sheet=data.get("stockOutSheet"),
+            led_color=LedColors(led_color) if led_color is not None else None,
+            is_blink=data.get("isBlink"),
+            status=CellStatus(status) if status is not None else None,
+        )
+
+
+@dataclass
+class StockDataResponse(BaseResponse):
+    """库存数据响应"""
+
+    result_data: List[StockDataDto] = field(default_factory=list)  # 返回数据
+    total: int = 0  # 总数
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'StockDataResponse':
+        """从字典创建实例"""
+        result_data = []
+        for item in data.get("resultData", []):
+            result_data.append(StockDataDto.from_dict(item))
+
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", ""),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+            result_data=result_data,
+            total=data.get("total", 0),
+        )
+
+
+@dataclass
+class StockOutResponseDto:
+    """出库响应数据"""
+
+    cell: Optional[str] = None  # 储位
+    grn: Optional[str] = None  # 朔源码
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'StockOutResponseDto':
+        """从字典创建实例"""
+        return cls(
+            cell=data.get("cell"),
+            grn=data.get("grn"),
+        )
+
+
+@dataclass
+class StockOutResponse(BaseResponse):
+    """出库响应"""
+
+    result_data: List[StockOutResponseDto] = field(default_factory=list)  # 返回数据
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'StockOutResponse':
+        """从字典创建实例"""
+        result_data = []
+        for item in data.get("resultData", []):
+            result_data.append(StockOutResponseDto.from_dict(item))
+
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", ""),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+            result_data=result_data,
+        )
+
+
+@dataclass
+class StockOutSheetResponse(BaseResponse):
+    """单号出库响应"""
+
+    result_data: List[StockOutResponseDto] = field(default_factory=list)  # 返回数据
+    led_color: Optional[LedColors] = None  # 亮灯颜色
+    color_name: Optional[str] = None  # 颜色名称
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'StockOutSheetResponse':
+        """从字典创建实例"""
+        result_data = []
+        for item in data.get("resultData", []):
+            result_data.append(StockOutResponseDto.from_dict(item))
+
+        led_color = data.get("ledColor")
+
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", ""),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+            result_data=result_data,
+            led_color=LedColors(led_color) if led_color is not None else None,
+            color_name=data.get("colorName"),
+        )
+
+
+@dataclass
+class ClearErrorResponseDto:
+    """清错响应数据"""
+
+    grn: Optional[str] = None  # 朔源码
+    cell: Optional[str] = None  # 储位
+    state: int = 0  # 储位状态 0-空，1-非空
+
+    @property
+    def is_empty(self) -> bool:
+        """是否为空"""
+        return self.state == 0
+
+    @property
+    def is_not_empty(self) -> bool:
+        """是否非空"""
+        return self.state == 1
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'ClearErrorResponseDto':
+        """从字典创建实例"""
+        return cls(
+            grn=data.get("grn"),
+            cell=data.get("cell"),
+            state=data.get("state", 0),
+        )
+
+
+@dataclass
+class ClearErrorResponse(BaseResponse):
+    """清错错误响应"""
+
+    result_data: List[ClearErrorResponseDto] = field(default_factory=list)  # 返回数据
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'ClearErrorResponse':
+        """从字典创建实例"""
+        result_data = []
+        for item in data.get("resultData", []):
+            result_data.append(ClearErrorResponseDto.from_dict(item))
+
+        return cls(
+            code=data.get("code", 0),
+            message=data.get("message", ""),
+            session_id=data.get("sessionId", ""),
+            timestamp=data.get("timestamp", datetime.now().isoformat()),
+            result_data=result_data,
+        )

smartrack_sdk/tests/__init__.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+测试包
+包含所有测试模块
+"""