pyinsts 0.0.3__tar.gz

pyinsts-0.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [zhangxp93]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyinsts-0.0.3/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: pyinsts
+Version: 0.0.3
+Summary: PyVISA仪器控制库，支持Keysight和Rohde&Schwarz仪器
+Author-email: zhangxp93 <937097345@qq.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: pyvisa>=1.14.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: versioningit>=3.3.0
+Dynamic: license-file
+
+[**简体中文**](README.md) | [**English**](README_en.md)
+
+<div align="center">
+ <h1>
+ <strong>PyVISA仪器控制</strong>
+ </h1>
+<h5>
+  <strong>适用于 Windows、MacOs、Linux</strong><br>
+</h5>
+</div><br>
+
+___
+
+- **基于pyvisa库对仪器进行控制，支持USB、GPIB、TCP/IP等连接方式。**
+- **Rohde & Schwarz SCPI**
+- **KeySight SCPI**
+
+
+## 必要依赖库安装
+PyVISA 是一个用于控制和通信仪器的 Python 库,使用下面的代码安装:
+
+```
+pip install pyvisa
+```
+
+
+
+## 🏷[更新日志](CHANGELOG.md)
+

pyinsts-0.0.3/README.md

@@ -0,0 +1,29 @@
+[**简体中文**](README.md) | [**English**](README_en.md)
+
+<div align="center">
+ <h1>
+ <strong>PyVISA仪器控制</strong>
+ </h1>
+<h5>
+  <strong>适用于 Windows、MacOs、Linux</strong><br>
+</h5>
+</div><br>
+
+___
+
+- **基于pyvisa库对仪器进行控制，支持USB、GPIB、TCP/IP等连接方式。**
+- **Rohde & Schwarz SCPI**
+- **KeySight SCPI**
+
+
+## 必要依赖库安装
+PyVISA 是一个用于控制和通信仪器的 Python 库,使用下面的代码安装:
+
+```
+pip install pyvisa
+```
+
+
+
+## 🏷[更新日志](CHANGELOG.md)
+

pyinsts-0.0.3/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "pyinsts"
+version = "0.0.3"
+description = "PyVISA仪器控制库，支持Keysight和Rohde&Schwarz仪器"
+authors = [
+    { name = "zhangxp93", email = "937097345@qq.com" }
+]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "colorlog>=6.9.0",
+    "pyvisa>=1.14.1",
+    "pyyaml>=6.0.3",
+    "versioningit>=3.3.0",
+]
+
+
+[tool.uv.workspace]
+members = [
+    "test_app",
+]

pyinsts-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyinsts-0.0.3/src/_version.py

@@ -0,0 +1,15 @@
+def _get_version() -> str:
+
+    from importlib.resources import files
+    from pathlib import Path
+
+    import versioningit
+
+    module_path = files("pyinsts")
+    if isinstance(module_path, Path):
+        return versioningit.get_version(project_dir=Path(module_path).parent.parent)
+    else:
+        return "0.0"
+
+
+__version__ = "0.0.3"

pyinsts-0.0.3/src/pyinsts/common/__init__.py

@@ -0,0 +1,3 @@
+from .log_data import setup_logging
+
+__all__ = ["setup_logging"]

pyinsts-0.0.3/src/pyinsts/common/log_data.py

@@ -0,0 +1,96 @@
+"""
+日志处理
+"""
+import logging
+import os
+from logging.handlers import RotatingFileHandler
+import colorlog  # 导入 colorlog
+def setup_logging(log_file=None, log_level=logging.INFO, max_bytes=1 * 1024 * 1024, backup_count=5):
+    """
+    配置日志记录，包括日志轮换和控制台输出，支持彩色日志
+    :param log_file: 日志文件路径，如果为None则使用默认路径
+    :param log_level: 日志等级
+    :param max_bytes: 单个日志文件的最大字节数，默认为1MB
+    :param backup_count: 保留的日志文件备份数
+    """
+    if log_file is None:
+        log_file = os.getenv('LOG_FILE_PATH', 'docs/log/test.log')
+
+    # 确保日志文件夹存在
+    log_dir = os.path.dirname(log_file)
+    if not os.path.exists(log_dir):
+        os.makedirs(log_dir)
+
+    # 创建根记录器
+    logger = logging.getLogger()
+    logger.setLevel(log_level)
+
+    # 清除已有的处理器，避免重复添加
+    if logger.hasHandlers():
+        logger.handlers.clear()
+
+    # 创建文件处理器，支持日志轮换
+    file_handler = RotatingFileHandler(log_file, mode='w', maxBytes=max_bytes, backupCount=backup_count)
+    file_handler.setLevel(log_level)
+
+    # 创建控制台处理器，日志输出到控制台
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(log_level)
+
+    # 定义日志格式
+    log_format = '%(asctime)s - %(levelname)-8s - %(message)-60s - [%(filename)-15s:%(lineno)-4d]'
+    color_format = "%(log_color)s" + log_format
+
+    # 设置文件处理器的格式
+    file_formatter = logging.Formatter(log_format)
+    file_handler.setFormatter(file_formatter)
+
+    # 设置控制台处理器的彩色格式
+    color_formatter = colorlog.ColoredFormatter(
+        color_format,
+        log_colors={
+            'DEBUG': 'cyan',
+            'INFO': 'green',
+            'WARNING': 'yellow',
+            'ERROR': 'red',
+            'CRITICAL': 'bold_red',
+        }
+    )
+    console_handler.setFormatter(color_formatter)
+
+    # 将处理器添加到记录器中
+    logger.addHandler(file_handler)
+    logger.addHandler(console_handler)
+
+    # 添加日志分隔符
+    logger.info("=" * 60)
+    logger.info("新日志开始".center(60, ' '))
+    logger.info("=" * 60)
+
+
+def log_data(data):
+    """
+    记录数据的日志
+    """
+    logging.info(f"数据记录: {data}")
+
+
+# 通用异常处理装饰器
+def log_exceptions(func):
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            logging.error(f"{func.__name__} 执行时发生错误", exc_info=True)
+            raise e
+
+    return wrapper
+
+# 示例：调用日志设置
+if __name__ == "__main__":
+    setup_logging(log_file='/Users/zhangxianping/Desktop/pythonProject/SiCore_ChipTest/docs/log//test.log', log_level=logging.DEBUG)
+    log_data("这是一个测试数据记录")
+    logging.debug("这是一条调试信息")
+    logging.warning("这是一条警告信息")
+    logging.error("这是一条错误信息")
+    logging.critical("这是一条严重错误信息")

pyinsts-0.0.3/src/pyinsts/libs/__init__.py

@@ -0,0 +1,11 @@
+# libs/__init__.py
+from .baseinstrument import BaseInstrument
+from .rs import Fswp
+from .keysight import *
+
+__all__ = \
+    [
+    'BaseInstrument',
+    'Fswp',
+    'N9020b',
+    ]

pyinsts-0.0.3/src/pyinsts/libs/baseinstrument.py

@@ -0,0 +1,232 @@
+import logging
+import time
+
+import pyvisa
+from typing import Callable, Optional
+import os
+import inspect
+from functools import wraps
+
+from pyvisa import VisaIOError
+
+from src.pyinsts.libs.data import load_config
+
+
+def handle_instrument_error(func: Callable) -> Callable:
+    """仪器操作错误处理装饰器"""
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            logging.error(f"{args[0].model} {func.__name__}失败: {e}")
+            raise
+
+    return wrapper
+
+
+class BaseInstrument:
+    """基础仪器控制类"""
+
+    def __init__(self, address: Optional[str] = None, config_path: str = "config.yaml",
+                 model: str = "E5052B"):
+        """初始化仪器连接
+
+        Args:
+            address: 仪器地址，例如："USB0::0x0957::0x0E09::MY47402409::0::INSTR"
+            config_path: 配置文件路径
+            model: 仪器型号
+        """
+        # 设置基本属性
+        self.model = model
+        self.address = self._get_instrument_address(address, config_path)
+        
+        # 设置默认超时参数
+
+        self.opc_timeout = 100  # 默认OPC超时时间100秒
+
+
+        self.opc_poll_interval = 0.01  # 默认OPC轮询间隔0.01秒
+
+        # 连接仪器
+        self.idn = self._connect_instrument()
+
+    # def __del__(self):
+    #     """
+    #     del的调用时机不确定，依赖于Python的垃圾回收机制。
+    #     :return:
+    #     """
+    #     self.close()
+
+
+    def _get_instrument_address(self, address: str, config_path: str) -> str:
+        """获取仪器地址
+
+        优先使用传入的地址，否则从配置文件读取
+        支持.yaml和.json格式的配置文件
+        """
+        if address:
+            return address
+
+        # 处理配置文件路径
+        if not os.path.isabs(config_path):
+            # 获取继承类的文件所在目录
+            derived_class_file = inspect.getmodule(self.__class__).__file__
+            derived_class_dir = os.path.dirname(
+                os.path.abspath(derived_class_file))
+            config_path = os.path.join(derived_class_dir, config_path)
+
+        # 如果没有指定扩展名，先尝试.yaml，再尝试.json
+        if not os.path.splitext(config_path)[1]:
+            yaml_path = config_path + '.yaml'
+            json_path = config_path + '.json'
+            
+            if os.path.exists(yaml_path):
+                config_path = yaml_path
+            elif os.path.exists(json_path):
+                config_path = json_path
+                
+        config = load_config(config_path)
+        address = config.get("instruments", {}).get(self.model)
+        if not address:
+            raise ValueError(f"未找到{self.model}的仪器地址配置")
+
+        return address
+
+    @handle_instrument_error
+    def _connect_instrument(self) -> None:
+        """建立仪器连接,返回仪器标识"""
+        max_retries = 3  # 最大重试次数
+
+        retry_count = 0
+        
+        while retry_count < max_retries:
+            try:
+                print(f"型号:{self.model}, 地址:{self.address}")
+                self.rm = pyvisa.ResourceManager()
+                self.instrument = self.rm.open_resource(self.address)
+
+                self.instrument.write('*CLS')
+                logging.info('清除仪器寄存器信息')
+
+
+                # 验证连接
+                idn = self.instrument.query("*IDN?")
+                logging.info(f'仪器标识:{idn}, 成功连接{self.model}')
+                return idn
+            except(pyvisa.VisaIOError, pyvisa.VisaTypeError, TimeoutError):
+                retry_count += 1
+                if retry_count < max_retries:
+                    logging.info(f"等待1秒后重试...")
+                    time.sleep(1)
+                    # 确保之前的连接被关闭
+                    if hasattr(self, 'instrument'):
+                        self.instrument.close()
+                    if hasattr(self, 'rm'):
+                        self.rm.close()
+                else:
+                    logging.error(f"连接失败次数超过最大重试次数({max_retries})")
+                    raise
+
+        return None
+
+
+    @handle_instrument_error
+    def write(self, command: str,
+              check_complete: bool = False) -> None:
+        """写入命令
+
+        Args:
+            command: SCPI命令
+            check_complete: 是否等待命令完成
+
+        example:
+            self.write(f'SENSE1:FREQ:CENT 1GHz')
+        """
+        self.instrument.timeout = 100000
+        self.instrument.write(command)
+        if check_complete:
+            self.wait_opc()
+        logging.debug(f"{self.model} 写入: {command}")
+
+    @handle_instrument_error
+    def query(self, command: str,
+              check_complete: bool = False) -> str:
+        """查询命令
+
+        Args:
+            command: SCPI命令
+            check_complete: 是否等待命令完成
+
+        Returns:
+            查询结果
+
+        example:
+            result = self.query("*IDN?")
+            print(result)
+        """
+        self.instrument.timeout = 20000
+        try:
+            result = self.instrument.query(command)
+            if check_complete:
+                self.wait_opc()
+            logging.debug(f"{self.model} 查询: {command}, 结果: {result}")
+            return result
+        except VisaIOError as e:
+            logging.error(f"{self.model} 查询失败: {e}")
+            raise
+    
+    @handle_instrument_error
+    def set_opc_timeout(self, timeout: float=0.1, poll_interval: float = None):
+        """临时设置OPC超时时间
+        
+        Args:
+            timeout: 新的超时时间(秒)
+            poll_interval: 新的轮询间隔(秒)，可选
+        """
+        self.opc_timeout = timeout
+        if poll_interval is not None:
+            self.opc_poll_interval = poll_interval
+        logging.info(f"{self.model} 设置超时时间: {timeout}秒, 轮询间隔: {poll_interval or self.opc_poll_interval}秒")
+
+    @handle_instrument_error
+    def wait_opc(self, timeout=None, opc_poll_interval=None):
+        """等待OPC完成
+        Args:
+            timeout: 超时时间(秒)，默认使用self.timeout
+            opc_poll_interval: 轮询间隔(秒)，默认使用self.poll_interval
+        """
+        self.opc_timeout = timeout or self.opc_timeout
+        try:
+            start_time = time.time()
+            logging.info(f"开始等待opc?")
+
+            while True:
+                try:
+                    opc = self.instrument.query("*OPC?")
+                    if opc.strip() == '1':
+                        logging.info("opc运行完成")
+                        break
+                except VisaIOError as e:
+                    logging.warning(f"OPC查询失败: {str(e)}")
+                    # break  # 通信异常时终止
+
+                elapsed = time.time() - start_time
+                if elapsed >= self.opc_timeout:
+                    logging.warning(f"运行超时（已耗时：{elapsed:.1f}秒）")
+                    break
+                time.sleep(opc_poll_interval or self.opc_poll_interval)
+            end_time = time.time()
+            total_time = end_time - start_time
+            logging.info(f"总运行时间: {total_time:.2f}秒")
+            return total_time  # 返回时间供外部使用
+        except Exception as e:
+            logging.error(f"发生错误: {str(e)}")
+            return str(e)
+
+    @handle_instrument_error
+    def close(self) -> None:
+        """关闭仪器连接"""
+        self.instrument.close()
+        logging.info(f"{self.model} 连接已关闭")
+

pyinsts-0.0.3/src/pyinsts/libs/data/__init__.py

@@ -0,0 +1,3 @@
+from .load_config import load_config
+
+__all__ = ['load_config']

pyinsts-0.0.3/src/pyinsts/libs/data/load_config.py

@@ -0,0 +1,47 @@
+import os
+import json
+import yaml
+import logging
+
+
+def load_config(config_path="config.yaml"):
+    """加载配置文件，支持YAML和JSON格式
+    
+    Args:
+        config_path: 配置文件路径(.yaml或.json)
+        
+    Returns:
+        配置字典
+    """
+    if not os.path.exists(config_path):
+        logging.error(f"配置文件未找到: {config_path}")
+        raise FileNotFoundError(f"配置文件未找到: {config_path}")
+        
+    file_ext = os.path.splitext(config_path)[1].lower()
+    
+    with open(config_path, "r", encoding="utf-8") as file:
+        try:
+            if file_ext in ['.yaml', '.yml']:
+                return yaml.safe_load(file)
+            elif file_ext == '.json':
+                return json.load(file)
+            else:
+                error_msg = f"不支持的配置文件格式: {file_ext}"
+                logging.error(error_msg)
+                raise ValueError(error_msg)
+        except (yaml.YAMLError, json.JSONDecodeError) as e:
+            error_msg = f"配置文件格式错误: {e}"
+            logging.error(error_msg)
+            raise ValueError(error_msg)
+
+def get_config_path(config_path):
+    """获取当前工作目录"""
+    # 获取当前工作目录
+    current_dir = os.getcwd()
+    # 拼接配置文件的路径
+    config_path = os.path.join(current_dir, config_path)
+    return config_path
+
+
+if __name__ == '__main__':
+    config = get_config_path("config.yaml")