physicsLab 2.0.4__tar.gz → 2.0.5__tar.gz

{physicslab-2.0.4 → physicslab-2.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: physicsLab
-Version: 2.0.4
+Version: 2.0.5
 Summary: Python API for Quantum-Physics App
 Home-page: https://github.com/GoodenoughPhysicsLab/physicsLab
 Author: Arendelle

physicslab-2.0.5/README.md

@@ -0,0 +1,121 @@
+# physicsLab
+
+![输入图片说明](./cover.jpg)
+
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![build](https://github.com/gaogaotiantian/viztracer/workflows/build/badge.svg)](https://github.com/GoodenoughPhysicsLab/physicsLab/actions)
+![support-version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+
+## 介绍
+当我们在[物理实验室AR](https://www.turtlesim.com/)纯手动做实验的时候, 往往会遇到一些琐碎、麻烦但又不得不做的事情, 比如：重复的搭建某些电路, 调整元件的位置, 电路内部结构的重复。这些问题都可以通过使用`physicsLab`生成这些电路结构来轻易解决！于是我写了`physicsLab`, 让你能用`Python`在物实做实验。
+
+而在参与物实社区的时候, 有时候又会遇到一些手动很麻烦的情况, 我们就可以使用`physicsLab.web`来通过网络api操作物实社区。
+
+## 部分方便且惊艳的功能展示
+*  同时支持通过存档的文件名与**存档名**访问存档
+*  不受实验室大小地随意摆放元件 (比如在实验室外悬空的元件)
+*  将midi转换为物实对应的电路
+*  修改物实的实验封面
+*  获取用户的所有头像或实验用过的所有封面
+
+更多好用的功能等你来发现
+
+## 功能支持
+* 跨平台支持, 只要`Python3.8+`能在该平台上运行并且能够读写文件, 比如`Windows7+`, `Linux`, `MacOS`, `Android`
+* 支持物实**所有**实验类型：电学, 天体物理, 电与磁
+* 支持物实**全部**元件
+* 大多数物实网络api封装的支持 (直接与物实服务器进行交互)
+
+## 稳定&兼容
+自版本`2.0.0`及之后, `physicsLab`会逐步增加兼容的考虑与支持。承诺`stable`的api将永远不会移除, 行为几乎不会改变, 除非物实更改了一些api的行为导致physicsLab的底层api的行为被迫发生改变或者更改几乎没有任何影响。
+
+* v2.0.0: 承诺`ExperimentOpenedError, ExperimentClosedError, ExperimentExistError, ExperimentNotExistError`会`stable`
+* v2.0.1: 承诺三大实验所有元件的类名会`stable`
+* v2.0.3: 承诺`class Experiment`会`stable`
+* v2.0.4: 承诺`class User, anonymous_login, email_login, token_login`会`stable`
+* Note: v2.0.4 将部分函数抛出TypeError的行为替换为了abort(), 因为我认为这个异常永远不应该被捕获。这是一个极小的breaking change但我认为有利于让physicsLab变得更好, 并且对使用者的影响微乎其微。
+* v2.0.5: 承诺`__version__`会`stable`
+
+## 版本发布
+`physicsLab`的版本发布采取快照的方式, `physicsLab`仅会维护`trunk`
+
+## 安装教程
+1.  请确保你的电脑有[Python](https://www.python.org)（>=3.8）与[物理实验室AR](https://www.turtlesim.com/)（简称`物实`）（也可以联系物理实验室的开发者[John-Chen](https://gitee.com/civitasjohn)）
+
+2.  在cmd或shell输入以下载physicsLab：
+```shell
+pip install physicsLab
+```
+在某些非正常情况, 你可能无法顺利使用`pip`, 此时你可以换为该命令来解决该问题：
+```shell
+python -m pip install physicsLab
+```
+> Note: 在`Windows`下你可以输入`py`来使用`Python`, `Linux, MacOS`下可能需要输入`python3`或者`python3.x`（`python`加上你的`Python`版本）来使用`python`
+
+3.  有一个并非必需的功能：播放midi（仅在Windows下可用）。你可以输入下面命令的任意一条：
+```shell
+pip install plmidi
+pip install pygame
+```
+点击跳转至[plmidi](https://github.com/GoodenoughPhysicsLab/plmidi)
+
+4.  物实存档使用了中文字符, 默认编码为`utf-8`。但在一些非正常情况, 存档的编码可能被改变。虽然`physicsLab`有一定的处理存档编码问题的能力, 但如果还是出现了问题, 请输入该命令：
+```bash
+pip install chardet
+```
+此时`physicsLab`会自动调用`chardet`来处理更加棘手的文件编码问题。
+
+5.  如果下载成功, 就可以查看[快速开始](docs/quick_start.md), 开始你的使用了
+> Note: 每次通过`physicsLab`生成了一个新的存档之后, 都需要重新加载物实的本地存档, 即点击`从本地读取`, 再次点击进入对应存档
+
+### 新手解惑: 为什么我明明安装了physicsLab, python却告诉我无法找到？
+`pip`安装的包会被放在`site-packages`文件夹下  
+这大概率是因为pip安装的包所对应的`site-packages`与你使用的`Python`对应的`site-packages`不一样导致的  
+解决方案：找到ide调用的`python`对应的`site-packages`, 然后把`physicsLab`与`physicsLab.egg-info`复制过去  
+同时我推荐去学一下`Python`的虚拟环境`venv`, 有效解决此问题  
+
+如果此方法失效了, 虽然这一定不是这个方法的问题, 但你还可以在python的开头写上这两行代码来解决这个问题：  
+```python
+import sys
+sys.path.append("/your/path/of/physicsLab") # 将字符串替换为你想添加的路径
+```
+这个方法很丑陋但很简单好用, 可以帮你快速解决问题, 毕竟能跑起来就很不错了  
+其原理是`Python`会在`sys.path`这个列表里面的路径去寻找`Python Package`, 若未找到则会报错。因此该方法的原理就是把`Python`找不到的路径加进去, `Python`就找到了  
+注：每次运行的时候的`sys.path`都是临时的, 因此该方法必须让`Python`在每次运行的时候都执行一遍  
+
+## 特殊说明事项
+* 如果`physicsLab`抛出`AssertionError`, 请**报告 bug** (请在issue中附上最小复现)
+
+* 目前`physicsLab`在`windows`上的支持最好, 在其他操作系统上仅支持手动导入/导出存档（默认在`physicsLabSav`文件夹中）。
+
+* 在安卓上要使用`physicsLab`的话, 可以通过`qpython`或者`Termux`(推荐) 进行使用
+  * 在`qpython v3.2.5`中大大削减了python在文件路径操作方面的权限, 这意味着在qpython上使用physicsLab生成的存档将很难被物实导入, 因为物实没权限访问不了, 但此问题在[qpython v3.2.3](https://github.com/qpython-android/qpython/releases/tag/v3.2.3)中不存在, 推荐下载该版本。
+  * `Termux`的话, 需要设置输出存档的路径到`/storage/emulated/0/` (不同安卓设备路径可能不同), 或者手动`mv`一下生成的存档, 这样才能让物实访问对应的存档。
+  * 不过由于安卓权限的问题, 用起来肯定没有电脑上方便。
+
+* 由于`physicsLab`使用中文注释而且物实的存档也使用了中文, 因此我建议你手动在`Python`代码的第一行添加如下注释:
+```Python
+# -*- coding: utf-8 -*-
+```
+不过由于编码导致问题的情况似乎很少
+
+## 优点
+*  `physicsLab`拥有优秀的与物实存档交互的能力, 你甚至可以使用程序完成部分工作之后你再继续完成或者让程序在你已完成的实验的基础上继续完成。
+  如此灵活的功能使得`physicsLab`即使是在`Python`的`shell`上也能出色的完成工作！
+*  `physicsLab`为纯`Python`库, 其c拓展部分(播放midi的部分)被放到了`plmidi`中, 但`plmidi`不是必须需要的。纯`Python`库通常意味着更容易使用, 更少的问题。
+*  封装了物实里的大量元件, 即使是***未解锁的元件***也可以轻易用脚本生成, 甚至一些常用的电路也被封装好了！
+*  物理实验室存档的位置有点隐蔽, 但用该脚本生成实验时, 你无须亲自寻找这个文件在哪里。
+*  外部依赖少
+*  相比于手动做实验, 代码复用率更高, 许多逻辑电路已经被封装, 只需简单的一行调用即可生成。
+*  程序有利于大型实验的创作
+*  改存档做出来的实验往往有十分惊艳的效果！
+
+## 其他
+* 一些零七八碎的内容: [other physicsLab](https://gitee.com/script2000/temporary-warehouse/tree/master/other%20physicsLab)
+* 主仓库(github): https://github.com/GoodenoughPhysicsLab/physicsLab
+* 备份仓库(gitee): https://gitee.com/script2000/physicsLab
+
+## contribute
+`physicsLab`没有强行要求代码风格, 但需要注意与上下文保持一致
+
+你可以从更新文档、bugfix、写[测试代码](./test_pl)开始入手

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/__init__.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 ''' Python API for Physics-Lab-AR '''
 
+from .physicsLab_version import __version__
 # 操作实验
 from .element import search_experiment, Experiment
 from ._core import (

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/_colorUtils.py

@@ -30,8 +30,11 @@ sys.stdin = io.TextIOWrapper(sys.stdin.buffer, encoding="utf-8")
 sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding="utf-8")
 sys.stderr = io.TextIOWrapper(sys.stderr.buffer, encoding="utf-8")
 
-import ctypes
-if platform.system() == "Windows":
+# Windows 11 默认支持ANSI转义, 因此只有Windows 10及以下才使用Win32 API
+_USE_WIN32_COLOR_API = platform.system() == "Windows" and (sys.getwindowsversion().major, sys.getwindowsversion().minor, sys.getwindowsversion().build) < (10, 0, 22000)
+
+if _USE_WIN32_COLOR_API:
+    import ctypes
     from ctypes import wintypes
 
     class _CONSOLE_SCREEN_BUFFER_INFO(ctypes.Structure):
@@ -84,7 +87,8 @@ class _Color:
 
     @final
     def cprint(self, file):
-        if platform.system() == "Windows":
+        if _USE_WIN32_COLOR_API:
+            import ctypes
             # 临时更改终端打印字符的属性
             csbi = _CONSOLE_SCREEN_BUFFER_INFO()
             if file is sys.stdout:
@@ -104,52 +108,52 @@ class _Color:
             else:
                 assert False
         else:
-            print(f"\033[{self.fore}m{self.msg}\033[39m", end='', file=file)
+            print(f"\033[{self.fore}m{self.msg}\033[0m", end='', file=file)
 
 class Black(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 0
     else:
         fore = 30
 
 class Red(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 4
     else:
         fore = 31
 
 class Green(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 2
     else:
         fore = 32
 
 class Yellow(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 6
     else:
         fore = 33
 
 class Blue(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 1
     else:
         fore = 34
 
 class Magenta(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 5
     else:
         fore = 35
 
 class Cyan(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 3
     else:
         fore = 36
 
 class White(_Color):
-    if platform.system() == "Windows":
+    if _USE_WIN32_COLOR_API:
         fore = 7
     else:
         fore = 37

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/circuit/_circuit_core.py

@@ -71,10 +71,12 @@ class Wire:
     __slots__ = ("Source", "Target", "color")
 
     def __init__(self, source_pin: Pin, target_pin: Pin, color: WireColor = WireColor.blue) -> None:
-        if not isinstance(source_pin, Pin) \
-                or not isinstance(target_pin, Pin) \
-                or not isinstance(color, WireColor):
-            raise TypeError
+        if not isinstance(source_pin, Pin):
+            errors.type_error(f"Parameter source_pin must be of type `Pin`, but got value {source_pin} of type `{type(source_pin).__name__}`")
+        if not isinstance(target_pin, Pin):
+            errors.type_error(f"Parameter target_pin must be of type `Pin`, but got value {target_pin} of type `{type(target_pin).__name__}`")
+        if not isinstance(color, WireColor):
+            errors.type_error(f"Parameter color must be of type `WireColor`, but got value {color} of type `{type(color).__name__}`")
 
         if source_pin.element_self.experiment is not target_pin.element_self.experiment:
             raise errors.InvalidWireError("can't link wire in two experiment")
@@ -114,8 +116,10 @@ class Wire:
 
 def crt_wire(*pins: Pin, color: WireColor = WireColor.blue) -> List[Wire]:
     ''' 连接导线 '''
-    if not all(isinstance(a_pin, Pin) for a_pin in pins) or not isinstance(color, WireColor):
-        raise TypeError
+    if not all(isinstance(a_pin, Pin) for a_pin in pins):
+            errors.type_error(f"Parameter pins must be of type `tuple[Pin]`")
+    if not isinstance(color, WireColor):
+            errors.type_error(f"Parameter color must be of type `WireColor`, but got value {color} of type `{type(color).__name__}`")
     if len(pins) <= 1:
         raise ValueError("pins must be more than 1")
 
@@ -134,8 +138,10 @@ def crt_wire(*pins: Pin, color: WireColor = WireColor.blue) -> List[Wire]:
 
 def del_wire(source_pin: Pin, target_pin: Pin) -> None:
     ''' 删除导线'''
-    if not isinstance(source_pin, Pin) or not isinstance(target_pin, Pin):
-        raise TypeError
+    if not isinstance(source_pin, Pin):
+        errors.type_error(f"Parameter source_pin must be of type `Pin`, but got value {source_pin} of type `{type(source_pin).__name__}`")
+    if not isinstance(target_pin, Pin):
+        errors.type_error(f"Parameter target_pin must be of type `Pin`, but got value {target_pin} of type `{type(target_pin).__name__}`")
 
     _expe = get_current_experiment()
     if _expe.experiment_type != ExperimentType.Circuit:
@@ -217,10 +223,12 @@ class CircuitBase(ElementBase, metaclass=_CircuitMeta):
     @final
     def set_rotation(self, x_r: num_type = 0, y_r: num_type = 0, z_r: num_type = 180) -> Self:
         ''' 设置元件的角度 '''
-        if not isinstance(x_r, (int, float)) \
-                or not isinstance(y_r, (int, float)) \
-                or not isinstance(z_r, (int, float)):
-            raise TypeError
+        if not isinstance(x_r, (int, float)):
+            errors.type_error(f"Parameter x_r must be of type `int | float`, but got value {x_r} of type `{type(x_r).__name__}`")
+        if not isinstance(y_r, (int, float)):
+            errors.type_error(f"Parameter y_r must be of type `int | float`, but got value {y_r} of type `{type(y_r).__name__}`")
+        if not isinstance(z_r, (int, float)):
+            errors.type_error(f"Parameter z_r must be of type `int | float`, but got value {z_r} of type `{type(z_r).__name__}`")
 
         x_r, y_r, z_r = round_data(x_r), round_data(y_r), round_data(z_r)
         self.data["Rotation"] = f"{x_r},{z_r},{y_r}"
@@ -236,11 +244,14 @@ class CircuitBase(ElementBase, metaclass=_CircuitMeta):
     ) -> Self:
         ''' 设置元件的位置
         '''
-        if not isinstance(x, (int, float)) \
-                or not isinstance(y, (int, float)) \
-                or not isinstance(z, (int, float)) \
-                or not isinstance(elementXYZ, (bool, type(None))):
-            raise TypeError
+        if not isinstance(x, (int, float)):
+            errors.type_error(f"Parameter x must be of type `int | float`, but got value {x} of type `{type(x).__name__}`")
+        if not isinstance(y, (int, float)):
+            errors.type_error(f"Parameter y must be of type `int | float`, but got value {y} of type `{type(y).__name__}`")
+        if not isinstance(z, (int, float)):
+            errors.type_error(f"Parameter z must be of type `int | float`, but got value {z} of type `{type(z).__name__}`")
+        if not isinstance(elementXYZ, (bool, type(None))):
+            errors.type_error(f"Parameter elementXYZ must be of type `Optional[bool]`, but got value {elementXYZ} of type `{type(elementXYZ).__name__}`")
 
         x, y, z = round_data(x), round_data(y), round_data(z)
         self._position = _tools.position(x, y, z)
@@ -294,7 +305,7 @@ class CircuitBase(ElementBase, metaclass=_CircuitMeta):
             @param name: 将元件重命名为name
         '''
         if not isinstance(name, str):
-            raise TypeError
+            errors.type_error(f"Parameter name must be of type `str`, but got value {name} of type `{type(name).__name__}`")
 
         self.data["Label"] = name
         return self

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/circuit/elements/otherCircuit.py

@@ -455,13 +455,18 @@ class Simple_Instrument(CircuitBase):
             is_ideal: Optional[bool] = None,
             is_pulse: Optional[bool] = None,
     ) -> Self:
-        if not isinstance(rated_oltage, (int, float, type(None))) \
-                or not isinstance(volume, (int, float, type(None))) \
-                or not isinstance(bpm, (int, type(None))) \
-                or not isinstance(instrument, (int, type(None))) \
-                or not isinstance(is_ideal, (bool, type(None))) \
-                or not isinstance(is_pulse, (bool, type(None))):
-            raise TypeError
+        if not isinstance(rated_oltage, (int, float, type(None))):
+            errors.type_error(f"Parameter rated_oltage must be of type `Optional[int | float]`, but got value {rated_oltage} of type `{type(rated_oltage).__name__}`")
+        if not isinstance(volume, (int, float, type(None))):
+            errors.type_error(f"Parameter volume must be of type `Optional[int | float]`, but got value {volume} of type `{type(volume).__name__}`")
+        if not isinstance(bpm, (int, type(None))):
+            errors.type_error(f"Parameter bpm must be of type `Optional[int]`, but got value {bpm} of type `{type(bpm).__name__}`")
+        if not isinstance(instrument, (int, type(None))):
+            errors.type_error(f"Parameter instrument must be of type `Optional[int]`, but got value {instrument} of type `{type(instrument).__name__}`")
+        if not isinstance(is_ideal, (bool, type(None))):
+            errors.type_error(f"Parameter is_ideal must be of type `Optional[bool]`, but got value {is_ideal} of type `{type(is_ideal).__name__}`")
+        if not isinstance(is_pulse, (bool, type(None))):
+            errors.type_error(f"Parameter is_pulse must be of type `Optional[bool]`, but got value {is_pulse} of type `{type(is_pulse).__name__}`")
 
         if rated_oltage is not None:
             self.properties["额定电压"] = rated_oltage

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/circuit/elements/sensor.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from physicsLab import errors
 from .._circuit_core import _TwoPinMixIn, CircuitBase, Pin
 from physicsLab._core import _Experiment
 from .logicCircuit import _LogicBase
@@ -51,7 +52,7 @@ class _MemsBase(CircuitBase):
     @final
     def ranges(self, value: num_type) -> num_type:
         if not isinstance(value, (int, float)):
-            raise TypeError(f"ranges must be of type `int | float`, but got {type(value).__name__}")
+            errors.type_error(f"ranges must be of type `int | float`, but got value {value} of type `{type(value).__name__}`")
 
         self.properties["量程"] = value
         return value
@@ -69,7 +70,7 @@ class _MemsBase(CircuitBase):
     @final
     def shifting(self, value: num_type) -> num_type:
         if not isinstance(value, (int, float)):
-            raise TypeError(f"shifting must be of type `int | float`, but got {type(valure).__name__}")
+            errors.type_error(f"shifting must be of type `int | float`, but got value {value} of type `{type(value).__name__}`")
 
         self.properties["偏移"] = value
         return value
@@ -87,7 +88,7 @@ class _MemsBase(CircuitBase):
         ''' 响应系数
         '''
         if not isinstance(value, (int, float)):
-            raise TypeError(f"response_factor must be of type `int | float`, but got {type(value).__name__}")
+            errors.type_error(f"response_factor must be of type `int | float`, but got value {value} of type `{type(value).__name__}`")
 
         self.properties["响应系数"] = value
         return value

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/errors.py

@@ -6,13 +6,13 @@
 
     * 不可恢复的错误:
         当某些错误发生的时候, physicsLab认为程序抽象机已经崩溃, 无法继续运行
+        也就是说, 当该错误发生时, 仅表明程序出现了bug, 因此坚决不给用户捕获异常的可能
         因此一旦这些错误发生, physicsLab会调用os.abort来终止程序, 而不是抛出一个异常
-        因为抽象机崩溃的情况下, 程序已经无法继续运行, 最需要的是修bug, 因此坚决不给用户捕获异常的可能
         被视为 不可恢复的错误 的有:
         * assertion_error: 断言错误, physicsLab认为其为不可恢复的错误, 因此请不要使用 AssertionError
         * type_error: 断言错误, physicsLab认为其为不可恢复的错误, 因此请不要使用 TypeError
         除此之外, physicsLab自定义了不可恢复错误发生时的打印输出格式
-        这些格式比Python的traceback可读性更好
+        这些格式比Python自带的traceback可读性更好
 '''
 
 import os

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/lib/logic_circuit/wires.py

@@ -23,13 +23,13 @@ class UnitPin:
     def __getitem__(self, item: slice) -> "UnitPin":
         ...
 
-    def __getitem__(self, item):
+    def __getitem__(self, item: Union[int, slice]):
         if isinstance(item, int):
             return self.pins[item]
         elif isinstance(item, slice):
             return UnitPin(self.lib_self, *self.pins[item])
         else:
-            raise TypeError
+            errors.type_error(f"Parameter item must be of type `int | slice`, but got value {item} of type `{type(item).__name__}`")
 
     def __iter__(self):
         return iter(self.pins)

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/music/music.py

@@ -394,8 +394,10 @@ class Note:
                 isinstance(instrument, int) and
                 isinstance(velocity, (int, float)) and 0 < velocity <= 1 and
                 (rising_falling is None or isinstance(rising_falling, bool))
-        ) or time <= 0:
+        ):
             raise TypeError
+        if time <= 0:
+            raise ValueError
 
         if isinstance(pitch, int):
             if not 0 < pitch <= 128:

physicslab-2.0.5/physicsLab/physicsLab_version.py

@@ -0,0 +1,38 @@
+from typing import Tuple
+
+class _Version:
+    def __init__(self, major: int, minor: int, patch: int) -> None:
+        if major < 0 \
+                or minor < 0 \
+                or patch < 0:
+            raise ValueError
+
+        self.major = major
+        self.minor = minor
+        self.patch = patch
+
+    def __str__(self) -> str:
+        return f"{self.major}.{self.minor}.{self.patch}"
+
+    def to_tuple(self) -> Tuple[int, int, int]:
+        return self.major, self.minor, self.patch
+
+    def __eq__(self, value: object) -> bool:
+        return self.to_tuple() == value
+
+    def __ne__(self, value: object) -> bool:
+        return self.to_tuple() != value
+
+    def __gt__(self, value: object) -> bool:
+        return self.to_tuple() > value
+
+    def __ge__(self, value: object) -> bool:
+        return self.to_tuple() >= value
+
+    def __lt__(self, value: object) -> bool:
+        return self.to_tuple() < value
+
+    def __le__(self, value: object) -> bool:
+        return self.to_tuple() <= value
+
+__version__ = _Version(2, 0, 5)

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/plAR.py

@@ -4,11 +4,10 @@ import os
 import json
 import platform
 
-from getpass import getuser
 from typing import Optional, Tuple
 
 if platform.system() == "Windows":
-    WIN_PLAR_HOME_DIR = f"C:\\Users\\{getuser()}\\AppData\\LocalLow\\CIVITAS\\Quantum Physics"
+    WIN_PLAR_HOME_DIR = f"{os.environ['USERPROFILE']}\\AppData\\LocalLow\\CIVITAS\\Quantum Physics"
 
 _plar_version_mem: Optional[Tuple[int, int, int]] = None
 

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/web/_threadpool.py

@@ -7,11 +7,13 @@
 import queue
 from threading import Thread
 from enum import Enum, unique
+from physicsLab import errors
 from physicsLab._typing import List, Callable, Self, Any
 
 class CanceledError(Exception):
     ''' Task have been canceled '''
-    pass
+    def __repr__(self) -> str:
+        return "Task have been canceled"
 
 class _EndOfQueue:
     def __new__(cls):
@@ -53,7 +55,7 @@ class ThreadPool:
         ''' @param max_workers: 最大线程数
         '''
         if not isinstance(max_workers, int):
-            raise TypeError
+            errors.type_error(f"Parameter `max_workers` must be of type `int`, but got value `{max_workers}` of type `{type(max_workers).__name__}`")
         if max_workers <= 0:
             raise ValueError
 
@@ -61,7 +63,7 @@ class ThreadPool:
         self.task_queue = queue.SimpleQueue()
         self.threads: List[Thread] = []
 
-    def _office(self):
+    def _office(self) -> None:
         ''' workers work here '''
         while True:
             try:
@@ -84,7 +86,7 @@ class ThreadPool:
             @param func: function to be submitted
         '''
         if not callable(func):
-            raise TypeError
+            errors.type_error(f"Parameter func must be of `callable`, but got value {func} of type `{type(func)}`")
 
         task = _Task(func, args, kwargs)
         self.task_queue.put_nowait(task)
@@ -100,6 +102,22 @@ class ThreadPool:
         '''
         self.task_queue.put_nowait(_EndOfQueue)
 
+    def cancel_all_pending_tasks(self) -> None:
+        ''' cancel all pending tasks
+        '''
+        while True:
+            try:
+                task = self.task_queue.get_nowait()
+            except queue.Empty:
+                break
+
+            if task.status == _Status.wait:
+                task.status = _Status.cancelled
+            else:
+                errors.unreachable()
+
+        self.submit_end()
+
     def wait(self) -> None:
         ''' blocking until all tasks are done
         '''

{physicslab-2.0.4 → physicslab-2.0.5}/physicsLab/web/api.py

@@ -211,6 +211,8 @@ class User(_User):
         return await _async_wrapper(self.unban, target_id, reason)
 
 def anonymous_login() -> User:
+    ''' 匿名登录物实
+    '''
     plar_version = plAR.get_plAR_version()
     if plar_version is not None:
         plar_version = int(f"{plar_version[0]}{plar_version[1]}{plar_version[2]}")
@@ -236,10 +238,12 @@ def anonymous_login() -> User:
     return User(_check_response(response))
 
 def email_login(email: str, password: str) -> User:
+    ''' 通过邮箱登录物实
+    '''
     if not isinstance(email, str):
-        raise TypeError(f"Parameter email must be of type `str`, but got {type(email).__name__}")
+        errors.type_error(f"Parameter email must be of type `str`, but got value {email} of type `{type(email).__name__}`")
     if not isinstance(password, str):
-        raise TypeError(f"Parameter password must be of type `str`, but got {type(password).__name__}")
+        errors.type_error(f"Parameter password must be of type `str`, but got value {password} of type `{type(password).__name__}`")
 
     plar_version = plAR.get_plAR_version()
     if plar_version is not None:
@@ -266,10 +270,12 @@ def email_login(email: str, password: str) -> User:
     return User(_check_response(response))
 
 def token_login(token: str, auth_code: str) -> User:
+    ''' 通过token登录物实
+    '''
     if not isinstance(token, str):
-        raise TypeError(f"Parameter email must be of type `str`, but got {type(token).__name__}")
+        errors.type_error(f"Parameter email must be of type `str`, but got value {token} of type `{type(token).__name__}`")
     if not isinstance(auth_code, str):
-        raise TypeError(f"Parameter password must be of type `str`, but got {type(auth_code).__name__}")
+        errors.type_error(f"Parameter password must be of type `str`, but got value {auth_code} of type `{type(auth_code).__name__}`")
 
     plar_version = plAR.get_plAR_version()
     if plar_version is not None: