physicsLab 2.0.0__tar.gz → 2.0.2__tar.gz

{physicslab-2.0.0 → physicslab-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: physicsLab
-Version: 2.0.0
+Version: 2.0.2
 Summary: Python API for Quantum-Physics App
 Home-page: https://github.com/GoodenoughPhysicsLab/physicsLab
 Author: Arendelle
@@ -14,8 +14,8 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions
-Requires-Dist: requests
-Requires-Dist: colorama
+Requires-Dist: requests==2.32.3
+Requires-Dist: colorama==0.4.6
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{physicslab-2.0.0 → physicslab-2.0.2}/README.md

@@ -17,10 +17,11 @@
 *  将midi转换为物实对应的电路
 *  修改物实的实验封面
 *  获取用户的所有头像或实验用过的所有封面
+
 更多好用的功能等你来发现
 
 ## 功能支持
-* 跨平台支持，只要Python能在该平台上运行并且能够读写文件，比如`Windows`, `Linux`, `MacOS`, `Android`
+* 跨平台支持，只要`Python3.8+`能在该平台上运行并且能够读写文件，比如`Windows7+`, `Linux`, `MacOS`, `Android`
 * 支持物实**所有**实验类型：电学，天体物理，电与磁
 * 支持物实**全部**元件
 * 大多数物实网络api封装的支持 (直接与物实服务器进行交互)
@@ -29,13 +30,14 @@
 自版本`2.0.0`及之后, `physicsLab`会逐步增加兼容的考虑与支持
 
 但这并不意味着无意义的兼容。通常来说，会采用标注弃用, 并推荐转移到新api的模式。
-* v2.0.0: `clsss Experiment, ExperimentOpenedError, ExperimentClosedError, ExperimentExistError, ExperimentNotExistError`实验性地加入`stable`支持
+* v2.0.0: `class Experiment, ExperimentOpenedError, ExperimentClosedError, ExperimentExistError, ExperimentNotExistError`实验性地加入`stable`支持
+* v2.0.1: 三大实验所有元件的类名实验性地加入`stable`支持
 
 ## 版本发布
 `physicsLab`的版本发布采取快照的方式, `physicsLab`仅会维护`trunk`
 
 ## 安装教程
-1.  请确保你的电脑有[Python](https://www.python.org)（>=3.8）与[物理实验室AR](https://www.turtlesim.com/)（简称`物实`）（也可以联系物理实验室的开发者[Jone-Chen](https://gitee.com/civitasjohn)）
+1.  请确保你的电脑有[Python](https://www.python.org)（>=3.8）与[物理实验室AR](https://www.turtlesim.com/)（简称`物实`）（也可以联系物理实验室的开发者[John-Chen](https://gitee.com/civitasjohn)）
 
 2.  在cmd或shell输入以下载physicsLab：
 ```shell
@@ -45,7 +47,7 @@ pip install physicsLab
 ```shell
 python -m pip install physicsLab
 ```
-> Note: 在`Windows`下你可以输入`py`来使用`python`，`Linux, MacOS`下可能需要输入`python3`来使用`python`
+> Note: 在`Windows`下你可以输入`py`来使用`Python`，`Linux, MacOS`下可能需要输入`python3`或者`python3.x`（`python`加上你的`Python`版本）来使用`python`
 
 3.  有一个并非必需的功能：播放midi（仅在Windows下可用）。你可以输入下面命令的任意一条：
 ```shell
@@ -64,10 +66,10 @@ pip install chardet
 > Note: 每次通过`physicsLab`生成了一个新的存档之后，都需要重新加载物实的本地存档，即点击`从本地读取`，再次点击进入对应存档
 
 ### 新手解惑: 为什么我明明安装了physicsLab, python却告诉我无法找到？
-pip安装的包会被放在`site-package`文件夹下  
-这大概率是因为pip安装的包所对应的`site-package`与你使用的`python`对应的`site-package`不一样导致的  
-解决方案：找到ide调用的`python`对应的`site-package`，然后把`physicsLab`与`physicsLab.egg-info`复制过去  
-同时我推荐去学一下`python`的虚拟环境`venv`，有效解决此问题  
+`pip`安装的包会被放在`site-packages`文件夹下  
+这大概率是因为pip安装的包所对应的`site-packages`与你使用的`Python`对应的`site-packages`不一样导致的  
+解决方案：找到ide调用的`python`对应的`site-packages`，然后把`physicsLab`与`physicsLab.egg-info`复制过去  
+同时我推荐去学一下`Python`的虚拟环境`venv`，有效解决此问题  
 
 如果此方法失效了，虽然这一定不是这个方法的问题，但你还可以在python的开头写上这两行代码来解决这个问题：  
 ```python
@@ -75,8 +77,8 @@ import sys
 sys.path.append("/your/path/of/physicsLab") # 将字符串替换为你想添加的路径
 ```
 这个方法很丑陋但很简单好用，可以帮你快速解决问题，毕竟能跑起来就很不错了  
-其原理是python会在sys.path这个列表里面的路径去寻找python package，若未找到则会报错。因此该方法的原理就是把python找不到的路径加进去，python就找到了  
-注：每次运行的时候加入的path都是临时的，因此该方法必须让python在每次运行的时候都执行一遍  
+其原理是`Python`会在`sys.path`这个列表里面的路径去寻找`Python Package`，若未找到则会报错。因此该方法的原理就是把`Python`找不到的路径加进去，`Python`就找到了  
+注：每次运行的时候的`sys.path`都是临时的，因此该方法必须让`Python`在每次运行的时候都执行一遍  
 
 ## 特殊说明事项
 * 如果`physicsLab`抛出`AssertionError`，请**报告 bug** (请在issue中附上最小复现)
@@ -96,8 +98,8 @@ sys.path.append("/your/path/of/physicsLab") # 将字符串替换为你想添加
 
 ## 优点
 *  `physicsLab`拥有优秀的与物实存档交互的能力，你甚至可以使用程序完成部分工作之后你再继续完成或者让程序在你已完成的实验的基础上继续完成。
-  如此灵活的功能使得physicsLab即使是在python shell上也能出色的完成工作！
-*  `physicsLab`为纯python库，其c拓展部分(播放midi的部分)被放到了`plmidi`中，但`plmidi`不是必须需要的。纯Python库通常意味着更容易使用，更少的问题。
+  如此灵活的功能使得`physicsLab`即使是在`Python`的`shell`上也能出色的完成工作！
+*  `physicsLab`为纯`Python`库，其c拓展部分(播放midi的部分)被放到了`plmidi`中，但`plmidi`不是必须需要的。纯`Python`库通常意味着更容易使用，更少的问题。
 *  封装了物实里的大量元件，即使是***未解锁的元件***也可以轻易用脚本生成，甚至一些常用的电路也被封装好了！
 *  物理实验室存档的位置有点隐蔽，但用该脚本生成实验时，你无须亲自寻找这个文件在哪里。
 *  外部依赖少

{physicslab-2.0.0 → physicslab-2.0.2}/physicsLab/__init__.py

@@ -1,11 +1,16 @@
 # -*- coding: utf-8 -*-
 ''' Python API for Physics-Lab-AR '''
 
-# 颜色打印
 from ._colorUtils import close_color_print
 # 操作实验
 from .element import search_experiment, Experiment
-from ._core import get_current_experiment
+from ._core import (
+    ElementBase,
+    get_current_experiment,
+    elementXYZ_to_native,
+    native_to_elementXYZ,
+    ElementXYZ,
+)
 # 实验, 标签类型
 from .enums import ExperimentType, Category, Tag, OpenMode, WireColor
 # 电学实验
@@ -17,8 +22,6 @@ from .electromagnetism import *
 # `physicsLab`自定义异常类
 from .errors import *
 
-from .lib.wires import crt_wires, del_wires
-
 from physicsLab.plAR import *
 from physicsLab.utils import *
 

{physicslab-2.0.0 → physicslab-2.0.2}/physicsLab/_colorUtils.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+''' 在命令行打印出有颜色的字 '''
 from enum import Enum, unique
 
 import colorama
@@ -15,10 +16,9 @@ class COLOR(Enum):
     CYAN = colorama.Fore.CYAN
     WHITE = colorama.Fore.WHITE
 
-# 打印write_Experiment的信息时是否使用彩色字
 _ColorSupport = True
 
-def color_print(msg: str, color: COLOR, end="\n") -> None:
+def color_print(msg: str, color: COLOR, end='\n') -> None:
     if not isinstance(color, COLOR) or not isinstance(msg, str):
         raise TypeError
 
@@ -30,6 +30,6 @@ def color_print(msg: str, color: COLOR, end="\n") -> None:
         print(msg, end=end)
 
 def close_color_print():
-    ''' 关闭打印文字的颜色 '''
+    ''' 关闭打印的文字是有颜色的功能 '''
     global _ColorSupport
     _ColorSupport = False

{physicslab-2.0.0 → physicslab-2.0.2}/physicsLab/_core.py

@@ -2,8 +2,8 @@
 ''' `physicsLab` 操作存档的核心文件
     该文件提供操作存档的核心: `class _Experiment` 与所有元件的基类: class `_ElementBase`
     为了避免在physicsLab内出现大量的cyclic import
-    该文件仅会对存档进行文件读写方面的操作, 对元件的导入由`class Experiment`负责
-    `class Experiment`提供了更加用户友好的接口
+    该文件仅会对存档进行文件读写方面的操作, 将元件的的信息进一步导入由`class Experiment`负责
+    `class Experiment`也提供了对用户更加友好的接口
 '''
 import os
 import json
@@ -17,9 +17,9 @@ from physicsLab import plAR
 from physicsLab import  _tools
 from physicsLab import errors
 from physicsLab import _colorUtils
-from .web import User, _check_response
+from .web._api import _User, _check_response
 from .enums import Category, Tag, ExperimentType, OpenMode
-from .typehint import Union, Optional, List, Dict, num_type, Self, Callable, Tuple, final, NoReturn
+from ._typing import Union, Optional, List, Dict, num_type, Self, Callable, Tuple, final, NoReturn
 
 class _ExperimentStack:
     data: List["_Experiment"] = []
@@ -56,7 +56,7 @@ class _ExperimentStack:
     @classmethod
     def top(cls) -> "_Experiment":
         if len(cls.data) == 0:
-            raise errors.ExperimentError("no experiment can be operated (experiment stack is empty)")
+            raise errors.ExperimentError("no experiment can be operated")
 
         return cls.data[-1]
 
@@ -76,18 +76,18 @@ def _check_not_closed(method: Callable) -> Callable:
 class _Experiment:
     ''' 物实实验 (支持物实的三种实验类型) '''
 
-    if "PHYSICSLAB_HOME_PATH" in os.environ.keys():
+    if "PHYSICSLAB_HOME_PATH" in os.environ:
         SAV_PATH_DIR = os.environ["PHYSICSLAB_HOME_PATH"]
     else:
         if platform.system() == "Windows":
             SAV_PATH_DIR = os.path.join(plAR.WIN_PLAR_HOME_DIR, "Circuit")
         else:
-            SAV_PATH_DIR = "physicsLabSav"
+            SAV_PATH_DIR = os.path.abspath("physicsLabSav")
 
     open_mode: OpenMode
-    _position2elements: Dict[Tuple[num_type, num_type, num_type], List["_ElementBase"]]
-    _id2element: Dict[str, "_ElementBase"]
-    Elements: List["_ElementBase"]
+    _position2elements: Dict[Tuple[num_type, num_type, num_type], List["ElementBase"]]
+    _id2element: Dict[str, "ElementBase"]
+    Elements: List["ElementBase"]
     SAV_PATH: str
     PlSav: dict
     CameraSave: dict
@@ -98,6 +98,21 @@ class _Experiment:
     def __init__(*args, **kwargs) -> NoReturn:
         raise NotImplementedError
 
+    @property
+    @_check_not_closed
+    def is_elementXYZ(self) -> bool:
+        return self._is_elementXYZ
+
+    @is_elementXYZ.setter
+    @_check_not_closed
+    def is_elementXYZ(self, status) -> None:
+        if not isinstance(status, bool):
+            raise TypeError
+        if self.experiment_type != ExperimentType.Circuit:
+            raise errors.ExperimentTypeError
+
+        self._is_elementXYZ = status
+
     @_check_not_closed
     def get_elements_count(self) -> int:
         ''' 该实验的元件的数量 '''
@@ -114,11 +129,11 @@ class _Experiment:
         return self
 
     @_check_not_closed
-    def del_element(self, element: "_ElementBase") -> Self:
+    def del_element(self, element: "ElementBase") -> Self:
         ''' 删除元件
             @param element: 三大实验的元件
         '''
-        if not isinstance(element, _ElementBase):
+        if not isinstance(element, ElementBase):
             raise TypeError
         if element.experiment is not self:
             raise errors.ExperimentError("element is not in this experiment") # TODO 换一个更好的异常类型?
@@ -128,14 +143,14 @@ class _Experiment:
         identifier = element.data["Identifier"]
 
         if self.experiment_type == ExperimentType.Circuit:
-            res_Wires = set()
+            rest_wires = set()
             for a_wire in self.Wires:
                 if a_wire.Source.element_self.data["Identifier"] == identifier \
                         or a_wire.Target.element_self.data["Identifier"] == identifier:
                     continue
 
-                res_Wires.add(a_wire)
-            self.Wires = res_Wires
+                rest_wires.add(a_wire)
+            self.Wires = rest_wires
 
         for position, elements in self._position2elements.items():
             can_break: bool = False
@@ -158,29 +173,27 @@ class _Experiment:
 
         return self
 
-    # TODO 统一返回的行为，即始终返回列表之类的
     @_check_not_closed
     def get_element_from_position(
             self,
             x: num_type,
             y: num_type,
             z: num_type,
-    ) -> Union["_ElementBase", List["_ElementBase"]]:
+    ) -> List["ElementBase"]:
         ''' 通过坐标索引元件 '''
-        if not isinstance(x, (int, float)) or \
-                not isinstance(y, (int, float)) or \
-                not isinstance(z, (int, float)):
+        if not isinstance(x, (int, float)) \
+                or not isinstance(y, (int, float)) \
+                or not isinstance(z, (int, float)):
             raise TypeError
 
         position = (_tools.round_data(x), _tools.round_data(y), _tools.round_data(z))
         if position not in self._position2elements.keys():
             raise errors.ElementNotFound(f"{position} do not exist")
 
-        result: list = self._position2elements[position]
-        return result[0] if len(result) == 1 else result
+        return self._position2elements[position]
 
     @_check_not_closed
-    def get_element_from_index(self, index: int) -> "_ElementBase":
+    def get_element_from_index(self, index: int) -> "ElementBase":
         ''' 通过index (元件生成顺序) 索引元件, index从1开始 '''
         if not isinstance(index, int):
             raise TypeError
@@ -190,7 +203,7 @@ class _Experiment:
         return self.Elements[index - 1]
 
     @_check_not_closed
-    def get_element_from_identifier(self, identifier: str) -> "_ElementBase":
+    def get_element_from_identifier(self, identifier: str) -> "ElementBase":
         ''' 通过元件的id获取元件的引用 '''
         res = self._id2element.get(identifier)
         if res is None:
@@ -258,14 +271,17 @@ class _Experiment:
             no_print_info: bool = False,
     ) -> Self:
         ''' 以物实存档的格式导出实验
-            @param target_path: 将存档保存在此路径 (要求必须是file), 默认为 SAV_PATH
+            @param target_path: 将存档保存在此路径 (要求必须是文件的路径), 默认为 SAV_PATH
             @param no_print_info: 是否打印写入存档的元件数, 导线数(如果是电学实验的话)
         '''
-        if not isinstance(target_path, (str, type(None))) or not isinstance(no_print_info, bool):
+        if not isinstance(target_path, (str, type(None))) \
+                or not isinstance(no_print_info, bool):
             raise TypeError
 
         if target_path is None:
             target_path = self.SAV_PATH
+        else:
+            target_path = os.path.abspath(target_path)
 
         if self.open_mode in (OpenMode.load_by_sav_name, OpenMode.load_by_filepath, OpenMode.load_by_plar_app):
             status: str = "update"
@@ -284,14 +300,16 @@ class _Experiment:
         if not no_print_info:
             if self.experiment_type == ExperimentType.Circuit:
                 _colorUtils.color_print(
-                    f"Successfully {status} experiment \"{self.PlSav['InternalName']}\"! "
+                    f"Successfully {status} experiment \"{self.PlSav['InternalName']}\""
+                    f"(\"{target_path}\")! "
                     f"{self.get_elements_count()} elements, {self.get_wires_count()} wires.",
                     color=_colorUtils.COLOR.GREEN
                 )
             elif self.experiment_type == ExperimentType.Celestial \
                     or self.experiment_type == ExperimentType.Electromagnetism:
                 _colorUtils.color_print(
-                    f"Successfully {status} experiment \"{self.PlSav['InternalName']}\"! "
+                    f"Successfully {status} experiment \"{self.PlSav['InternalName']}\""
+                    f"(\"{target_path}\")! "
                     f"{self.get_elements_count()} elements.",
                     color=_colorUtils.COLOR.GREEN
                 )
@@ -376,17 +394,17 @@ class _Experiment:
 
     def __upload(
             self,
-            user: User,
+            user: _User,
             category: Optional[Category],
             image_path: Optional[str],
     ):
-        if image_path is not None and not isinstance(image_path, str) or \
-            category is not None and not isinstance(category, Category) or \
-            not isinstance(user, User):
+        if not isinstance(image_path, (str, type(None))) \
+            or not isinstance(category, (Category, type(None))) \
+            or not isinstance(user, _User):
             raise TypeError
         if image_path is not None and (not os.path.exists(image_path) or not os.path.isfile(image_path)):
             raise FileNotFoundError
-        if user.is_anonymous:
+        if not user.is_binded:
             raise PermissionError("you must register first")
 
         self.__write()
@@ -455,7 +473,7 @@ class _Experiment:
     @_check_not_closed
     def upload(
             self,
-            user: User,
+            user: _User,
             category: Category,
             image_path: Optional[str] = None,
     ) -> Self:
@@ -464,8 +482,8 @@ class _Experiment:
             @param category: 实验区还是黑洞区
             @param image_path: 图片路径
         '''
-        if not isinstance(category, Category) or \
-            image_path is not None and not isinstance(image_path, str):
+        if not isinstance(category, Category) \
+            or not isinstance(image_path, (str, type(None))):
             raise TypeError
         if self.PlSav["Summary"]["ID"] is not None:
             raise Exception(
@@ -494,7 +512,7 @@ class _Experiment:
     @_check_not_closed
     def update(
             self,
-            user: User,
+            user: _User,
             image_path: Optional[str] = None,
     ) -> Self:
         ''' 更新实验到物实
@@ -617,11 +635,11 @@ class _Experiment:
             x, y, z, elementXYZ为重新设置要合并的实验的坐标系原点在self的坐标系的位置
             不是电学实验时, elementXYZ参数无效
         '''
-        if not isinstance(other, _Experiment) or \
-                not isinstance(x, (int, float)) or \
-                not isinstance(y, (int, float)) or \
-                not isinstance(z, (int, float)) or \
-                not isinstance(elementXYZ, (bool, type(bool))):
+        if not isinstance(other, _Experiment) \
+                or not isinstance(x, (int, float)) \
+                or not isinstance(y, (int, float)) \
+                or not isinstance(z, (int, float)) \
+                or not isinstance(elementXYZ, (bool, type(bool))):
             raise TypeError
         if self.experiment_type != other.experiment_type:
             raise errors.ExperimentTypeError
@@ -640,11 +658,10 @@ class _Experiment:
             a_element = copy.deepcopy(a_element, memo={id(a_element.experiment): self})
             e_x, e_y, e_z = a_element.get_position()
             if self.experiment_type == ExperimentType.Circuit:
-                from .circuit.elementXYZ import xyzTranslate, translateXYZ
                 if elementXYZ and not a_element.is_elementXYZ:
-                    e_x, e_y, e_z = translateXYZ(e_x, e_y, e_z, a_element.is_bigElement)
+                    e_x, e_y, e_z = native_to_elementXYZ(e_x, e_y, e_z, a_element.is_bigElement)
                 elif not elementXYZ and a_element.is_elementXYZ:
-                    e_x, e_y, e_z = xyzTranslate(e_x, e_y, e_z, a_element.is_bigElement)
+                    e_x, e_y, e_z = elementXYZ_to_native(e_x, e_y, e_z, a_element.is_bigElement)
             a_element.set_position(e_x + x, e_y + y, e_z + z, elementXYZ)
             # set_Position已处理与_elements_position有关的操作
             self.Elements.append(a_element)
@@ -664,7 +681,8 @@ class _Experiment:
 
         return self
 
-class _ElementBase:
+class ElementBase:
+    ''' 三大类型实验的元件的基类 '''
     data: dict
     experiment: _Experiment
     _position: _tools.position
@@ -674,9 +692,9 @@ class _ElementBase:
 
     def set_position(self, x: num_type, y: num_type, z: num_type) -> Self:
         ''' 设置元件的位置 '''
-        if not isinstance(x, (int, float)) or \
-                not isinstance(y, (int, float)) or \
-                not isinstance(z, (int, float)):
+        if not isinstance(x, (int, float)) \
+                or not isinstance(y, (int, float)) \
+                or not isinstance(z, (int, float)):
             raise TypeError
 
         x, y, z = _tools.round_data(x), _tools.round_data(y), _tools.round_data(z)
@@ -699,7 +717,14 @@ class _ElementBase:
         return self
 
     @final
-    def get_position(self) -> tuple:
+    def _set_identifier(self, identifier: Optional[str] = None) -> None:
+        if identifier is None:
+            self.data["Identifier"] = _tools.randString(33)
+        else:
+            self.data["Identifier"] = identifier
+
+    @final
+    def get_position(self) -> _tools.position:
         ''' 获取元件的坐标 '''
         assert hasattr(self, '_position')
         return copy.deepcopy(self._position)
@@ -708,3 +733,57 @@ class _ElementBase:
     def get_index(self) -> int:
         ''' 获取元件的index (每创建一个元件, index就加1 (index从1开始)) '''
         return self.experiment.Elements.index(self) + 1
+
+class ElementXYZ:
+    # 元件坐标系对应物实坐标系中的x, y, z的单位一
+    _X_UNIT: float = 0.16
+    _Y_UNIT: float = 0.08
+    _Z_UNIT: float = 0.1
+    # big_element坐标修正
+    _Y_AMEND: float = 0.045
+
+    def __init__(self) -> None:
+        self._expe = get_current_experiment()
+        self.origin_status: bool = self._expe.is_elementXYZ
+
+    def __enter__(self) -> None:
+        if self._expe.experiment_type != ExperimentType.Circuit:
+            raise errors.ExperimentTypeError
+
+        self._expe.is_elementXYZ = True
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        if exc_type is None:
+            self._expe.is_elementXYZ = self.origin_status
+
+def elementXYZ_to_native(
+        x: num_type,
+        y: num_type,
+        z: num_type,
+        /,
+        is_bigElement: bool = False,
+) -> Tuple[num_type, num_type, num_type]:
+    ''' 将元件坐标系转换为物实的坐标系
+        @param is_bigElement: 是否为2体积的元件 (比如全加器)
+    '''
+    x *= ElementXYZ._X_UNIT
+    y *= ElementXYZ._Y_UNIT
+    z *= ElementXYZ._Z_UNIT
+    if is_bigElement:
+        y += ElementXYZ._Y_AMEND
+    return x, y, z
+
+def native_to_elementXYZ(
+        x: num_type,
+        y: num_type,
+        z: num_type,
+        is_bigElement: bool = False,
+) -> Tuple[num_type, num_type, num_type]:
+    ''' 将物实的坐标系转换为元件坐标系 '''
+    x /= ElementXYZ._X_UNIT
+    y /= ElementXYZ._Y_UNIT
+    z /= ElementXYZ._Z_UNIT
+    # 修改大体积逻辑电路元件的坐标
+    if is_bigElement:
+        y -= ElementXYZ._Y_AMEND
+    return x, y, z

{physicslab-2.0.0 → physicslab-2.0.2}/physicsLab/_tools.py

@@ -3,8 +3,9 @@ from random import choice
 from string import ascii_lowercase, ascii_letters, digits
 
 from collections import namedtuple
-from .typehint import Tuple, Union, num_type
+from ._typing import num_type
 
+# TODO 元件坐标系也应该由这玩意负责
 position = namedtuple("position", ["x", "y", "z"])
 
 def round_data(num: num_type) -> num_type:
@@ -12,13 +13,13 @@ def round_data(num: num_type) -> num_type:
         raise TypeError
     return round(num, 6)
 
-# 生成随机字符串
-def randString(strLength: int, lower: bool = False) -> str:
-    if not isinstance(strLength, int):
+def randString(length: int, is_lower: bool = False) -> str:
+    if not isinstance(length, int) \
+            or not isinstance(is_lower, bool):
         raise TypeError
 
-    if lower:
+    if is_lower:
         letters = ascii_lowercase
     else:
         letters = ascii_letters
-    return ''.join(choice(letters + digits) for _ in range(strLength))
+    return ''.join(choice(letters + digits) for _ in range(length))

{physicslab-2.0.0 → physicslab-2.0.2}/physicsLab/celestial/_planetbase.py

@@ -2,8 +2,8 @@
 from physicsLab import _tools
 from physicsLab import errors
 from physicsLab.enums import ExperimentType
-from physicsLab._core import get_current_experiment, _Experiment, _ElementBase
-from physicsLab.typehint import num_type, Self, override, final, NoReturn, Optional
+from physicsLab._core import get_current_experiment, _Experiment, ElementBase
+from physicsLab._typing import num_type, Self, override, final, NoReturn, Optional
 
 class _PlanetMeta(type):
     def __call__(
@@ -15,16 +15,16 @@ class _PlanetMeta(type):
             identifier: Optional[str] = None,
             **kwargs,
     ):
-        if not isinstance(x, (int, float)) or \
-                not isinstance(y, (int, float)) or \
-                not isinstance(z, (int, float)):
+        if not isinstance(x, (int, float)) \
+                or not isinstance(y, (int, float)) \
+                or not isinstance(z, (int, float)):
             raise TypeError
 
         _Expe = get_current_experiment()
         if _Expe.experiment_type != ExperimentType.Celestial:
             raise errors.ExperimentTypeError
 
-        self: "PlanetBase" = cls.__new__(cls) # type: ignore -> create subclass
+        self: "PlanetBase" = cls.__new__(cls)
         self.experiment = _Expe
 
         x, y, z = _tools.round_data(x), _tools.round_data(y), _tools.round_data(z)
@@ -32,10 +32,7 @@ class _PlanetMeta(type):
         self.__init__(x, y, z, *args, **kwargs)
         assert isinstance(self.data, dict)
 
-        if identifier is None:
-            self.data["Identifier"] = _tools.randString(33)
-        else:
-            self.data["Identifier"] = identifier
+        self._set_identifier(identifier)
         self.set_position(x, y, z)
         self.set_velocity(0, 0, 0)
         self.set_acceleration(0, 0, 0)
@@ -45,7 +42,7 @@ class _PlanetMeta(type):
 
         return self
 
-class PlanetBase(_ElementBase, metaclass=_PlanetMeta):
+class PlanetBase(ElementBase, metaclass=_PlanetMeta):
     ''' 星球基类 '''
     experiment: _Experiment
 
@@ -56,9 +53,9 @@ class PlanetBase(_ElementBase, metaclass=_PlanetMeta):
     @override
     def set_position(self, x: num_type, y: num_type, z: num_type) -> Self:
         ''' 设置位置坐标 '''
-        if not isinstance(x, (int, float)) or \
-                not isinstance(y, (int, float)) or \
-                not isinstance(z, (int, float)):
+        if not isinstance(x, (int, float)) \
+                or not isinstance(y, (int, float)) \
+                or not isinstance(z, (int, float)):
             raise TypeError
 
         x, y, z = _tools.round_data(x), _tools.round_data(y), _tools.round_data(z)
@@ -68,9 +65,9 @@ class PlanetBase(_ElementBase, metaclass=_PlanetMeta):
     def set_velocity(self, x_v: num_type, y_v: num_type, z_v: num_type) -> Self:
         ''' 设置速度
         '''
-        if not isinstance(x_v, (int, float)) or \
-                not isinstance(y_v, (int, float)) or \
-                not isinstance(z_v, (int, float)):
+        if not isinstance(x_v, (int, float)) \
+                or not isinstance(y_v, (int, float)) \
+                or not isinstance(z_v, (int, float)):
             raise TypeError
         self.data["Velocity"] = f"{x_v},{z_v},{y_v}"
         return self
@@ -78,9 +75,9 @@ class PlanetBase(_ElementBase, metaclass=_PlanetMeta):
     def set_acceleration(self, x_a: num_type, y_a: num_type, z_a: num_type) -> Self:
         ''' 设置加速度
         '''
-        if not isinstance(x_a, (int, float)) or \
-                not isinstance(y_a, (int, float)) or \
-                not isinstance(z_a, (int, float)):
+        if not isinstance(x_a, (int, float)) \
+                or not isinstance(y_a, (int, float)) \
+                or not isinstance(z_a, (int, float)):
             raise TypeError
         self.acceleration = _tools.position(x_a, y_a, z_a)
         self.data["Acceleration"] = f"{x_a},{z_a},{y_a}"