physicsLab 2.0.5__tar.gz → 2.0.6__tar.gz

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

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

{physicslab-2.0.5 → physicslab-2.0.6}/README.md

@@ -115,7 +115,10 @@ sys.path.append("/your/path/of/physicsLab") # 将字符串替换为你想添加
 * 主仓库(github): https://github.com/GoodenoughPhysicsLab/physicsLab
 * 备份仓库(gitee): https://gitee.com/script2000/physicsLab
 
-## contribute
-`physicsLab`没有强行要求代码风格, 但需要注意与上下文保持一致
+## 贡献代码
+`physicsLab`使用`black`工具自动格式化代码风格
+```sh
+black physicsLab --exclude="mido|vendor"
+```
 
 你可以从更新文档、bugfix、写[测试代码](./test_pl)开始入手

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

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
-''' Python API for Physics-Lab-AR '''
+"""Python API for Physics-Lab-AR"""
 
 from .physicsLab_version import __version__
+
 # 操作实验
 from .element import search_experiment, Experiment
 from ._core import (
@@ -11,14 +12,19 @@ from ._core import (
     native_to_elementXYZ,
     ElementXYZ,
 )
+
 # 实验, 标签类型
 from .enums import ExperimentType, Category, Tag, OpenMode, WireColor, GetUserMode
+
 # 电学实验
 from .circuit import *
+
 # 天体物理实验
 from .celestial import *
+
 # 电与磁实验
 from .electromagnetism import *
+
 # `physicsLab`自定义异常类
 from .errors import *
 from . import _warn

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

@@ -1,24 +1,24 @@
 # -*- coding: utf-8 -*-
-''' 在命令行打印出有颜色的字
-    为physicsLab最基础, 最底层的设施,
-    所以不能依赖physicsLab的任何其他设施, 包括 errors.py
-
-    Usage:
-        >>> from physicsLab._colorUtils import *
-        >>> cprint(Red("test")) # 输出红色字
-        # 支持变参函数, 一次性打印多个不同颜色的Object
-        # 但不像python的print一样支持sep参数 [设计如此]
-        >>> cprint(Green("test"), "test", Yellow("test"), 1111, 3.14)
-        >>> cprint(Blue("test")) # 还支持以下颜色
-        >>> cprint(Magenta("test"))
-        >>> cprint(Cyan("test"))
-        >>> cprint(White("test"))
-        >>> cprint(Black("test"))
-        >>> cprint(Red("test"), file=sys.stderr) # 输出到stderr
-        >>> cprint(Red("test"), end='') # 支持print那样指定end
-        # 如果你不希望打印出颜色字 (即使使用了Red("xxx")之类的), 请使用python原生print
-        >>> print(Green("test"), "test", Yellow("test")) # 此时打印无颜色
-'''
+"""在命令行打印出有颜色的字
+为physicsLab最基础, 最底层的设施,
+所以不能依赖physicsLab的任何其他设施, 包括 errors.py
+
+Usage:
+    >>> from physicsLab._colorUtils import *
+    >>> cprint(Red("test")) # 输出红色字
+    # 支持变参函数, 一次性打印多个不同颜色的Object
+    # 但不像python的print一样支持sep参数 [设计如此]
+    >>> cprint(Green("test"), "test", Yellow("test"), 1111, 3.14)
+    >>> cprint(Blue("test")) # 还支持以下颜色
+    >>> cprint(Magenta("test"))
+    >>> cprint(Cyan("test"))
+    >>> cprint(White("test"))
+    >>> cprint(Black("test"))
+    >>> cprint(Red("test"), file=sys.stderr) # 输出到stderr
+    >>> cprint(Red("test"), end='') # 支持print那样指定end
+    # 如果你不希望打印出颜色字 (即使使用了Red("xxx")之类的), 请使用python原生print
+    >>> print(Green("test"), "test", Yellow("test")) # 此时打印无颜色
+"""
 
 import platform
 from physicsLab._typing import final
@@ -26,12 +26,17 @@ from physicsLab._typing import final
 # 设置终端的编码为UTF-8
 import io
 import sys
+
 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")
 
 # 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)
+_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
@@ -68,8 +73,9 @@ if _USE_WIN32_COLOR_API:
     ]
     _SetConsoleTextAttribute.restype = wintypes.BOOL
 
-    _stdout_handle = _GetStdHandle(-11) # STD_OUTPUT_HANDLE
-    _stderr_handle = _GetStdHandle(-12) # STD_ERROR_HANDLE
+    _stdout_handle = _GetStdHandle(-11)  # STD_OUTPUT_HANDLE
+    _stderr_handle = _GetStdHandle(-12)  # STD_ERROR_HANDLE
+
 
 class _Color:
     fore: int
@@ -78,7 +84,9 @@ class _Color:
         if type(self) is _Color:
             raise NotImplementedError("_Color class can't be instantiated directly")
         if not isinstance(msg, str):
-            raise TypeError(f"Parameter msg must be of type `str`, but got value `{msg}` of type {type(msg).__name__}")
+            raise TypeError(
+                f"Parameter msg must be of type `str`, but got value `{msg}` of type {type(msg).__name__}"
+            )
 
         self.msg = msg
 
@@ -89,6 +97,7 @@ class _Color:
     def cprint(self, file):
         if _USE_WIN32_COLOR_API:
             import ctypes
+
             # 临时更改终端打印字符的属性
             csbi = _CONSOLE_SCREEN_BUFFER_INFO()
             if file is sys.stdout:
@@ -99,7 +108,7 @@ class _Color:
                 _SetConsoleTextAttribute(_stderr_handle, self.fore)
             else:
                 assert False
-            print(self.msg, flush=True, end='', file=file)
+            print(self.msg, flush=True, end="", file=file)
             # 恢复终端打印字符的属性
             if file is sys.stdout:
                 _SetConsoleTextAttribute(_stdout_handle, csbi.wAttributes)
@@ -108,7 +117,8 @@ class _Color:
             else:
                 assert False
         else:
-            print(f"\033[{self.fore}m{self.msg}\033[0m", end='', file=file)
+            print(f"\033[{self.fore}m{self.msg}\033[0m", end="", file=file)
+
 
 class Black(_Color):
     if _USE_WIN32_COLOR_API:
@@ -116,49 +126,57 @@ class Black(_Color):
     else:
         fore = 30
 
+
 class Red(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 4
     else:
         fore = 31
 
+
 class Green(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 2
     else:
         fore = 32
 
+
 class Yellow(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 6
     else:
         fore = 33
 
+
 class Blue(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 1
     else:
         fore = 34
 
+
 class Magenta(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 5
     else:
         fore = 35
 
+
 class Cyan(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 3
     else:
         fore = 36
 
+
 class White(_Color):
     if _USE_WIN32_COLOR_API:
         fore = 7
     else:
         fore = 37
 
-def cprint(*args, end='\n', file = sys.stdout) -> None:
+
+def cprint(*args, end="\n", file=sys.stdout) -> None:
     # 先刷新再打印, 避免在Windows下打印缓冲区的内容还未输出就被改变了Attribute
     # e.g.
     # print("test")
@@ -174,8 +192,8 @@ def cprint(*args, end='\n', file = sys.stdout) -> None:
         if isinstance(arg, _Color):
             arg.cprint(file=file)
         else:
-            print(arg, end='', file=file)
-    print(end, end='', file=file)
+            print(arg, end="", file=file)
+    print(end, end="", file=file)
     # 再次刷新，确保终端的输出已经输出
     # e.g.
     # cprint(Green("test"), file=sys.stderr)