pytest-dsl 0.15.0__py3-none-any.whl → 0.15.2__py3-none-any.whl

pytest_dsl/__init__.py

@@ -54,6 +54,13 @@ from pytest_dsl.core.keyword_loader import (
     group_keywords_by_source, scan_project_custom_keywords
 )
 
+# 关键字工具
+from pytest_dsl.core.keyword_utils import (
+    KeywordInfo, KeywordListOptions, KeywordFormatter, KeywordLister,
+    keyword_lister, list_keywords, get_keyword_info, search_keywords,
+    generate_html_report
+)
+
 # 便捷导入的别名
 Executor = DSLExecutor
 Validator = DSLValidator
@@ -77,6 +84,11 @@ __all__ = [
     'load_all_keywords', 'categorize_keyword', 'get_keyword_source_info',
     'group_keywords_by_source', 'scan_project_custom_keywords',
 
+    # 关键字工具
+    'KeywordInfo', 'KeywordListOptions', 'KeywordFormatter', 'KeywordLister',
+    'keyword_lister', 'list_keywords', 'get_keyword_info', 'search_keywords',
+    'generate_html_report',
+
     # Hook系统
     'hookimpl', 'hookspec', 'DSLHookSpecs',
     'hook_manager', 'DSLHookManager', 'HookManager',

pytest_dsl/cli.py

@@ -16,11 +16,8 @@ from pytest_dsl.core.yaml_loader import load_yaml_variables_from_args
 from pytest_dsl.core.auto_directory import (
     SETUP_FILE_NAME, TEARDOWN_FILE_NAME, execute_hook_file
 )
-from pytest_dsl.core.keyword_loader import (
-    load_all_keywords, categorize_keyword, get_keyword_source_info,
-    group_keywords_by_source, scan_project_custom_keywords
-)
-from pytest_dsl.core.keyword_manager import keyword_manager
+from pytest_dsl.core.keyword_loader import load_all_keywords
+from pytest_dsl.core.keyword_utils import list_keywords as utils_list_keywords
 
 
 def read_file(filename):
@@ -139,431 +136,25 @@ def parse_args():
         return args
 
 
-
-
-
-def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
-                             project_custom_keywords=None):
-    """格式化关键字信息为文本格式"""
-    lines = []
-
-    # 关键字名称和类别
-    category = categorize_keyword(
-        keyword_name, keyword_info, project_custom_keywords
-    )
-    category_names = {
-        'builtin': '内置',
-        'custom': '自定义',
-        'project_custom': '项目自定义',
-        'remote': '远程'
-    }
-
-    if show_category:
-        category_display = category_names.get(category, '未知')
-        lines.append(f"关键字: {keyword_name} [{category_display}]")
-    else:
-        lines.append(f"关键字: {keyword_name}")
-
-    # 远程关键字特殊标识
-    if keyword_info.get('remote', False):
-        alias = keyword_info.get('alias', '未知')
-        original_name = keyword_info.get('original_name', keyword_name)
-        lines.append(f"  远程服务器: {alias}")
-        lines.append(f"  原始名称: {original_name}")
-
-    # 项目自定义关键字特殊标识
-    if category == 'project_custom' and project_custom_keywords:
-        custom_info = project_custom_keywords[keyword_name]
-        lines.append(f"  文件位置: {custom_info['file']}")
-
-        # 对于项目自定义关键字，使用从AST中提取的参数信息
-        custom_parameters = custom_info.get('parameters', [])
-        if custom_parameters:
-            lines.append("  参数:")
-            for param_info in custom_parameters:
-                param_name = param_info['name']
-                param_mapping = param_info.get('mapping', '')
-                param_desc = param_info.get('description', '')
-                param_default = param_info.get('default', None)
-
-                # 构建参数描述
-                param_parts = []
-                if param_mapping and param_mapping != param_name:
-                    param_parts.append(f"{param_name} ({param_mapping})")
-                else:
-                    param_parts.append(param_name)
-
-                param_parts.append(f": {param_desc}")
-
-                # 添加默认值信息
-                if param_default is not None:
-                    param_parts.append(f" (默认值: {param_default})")
-
-                lines.append(f"    {''.join(param_parts)}")
-        else:
-            lines.append("  参数: 无")
-    else:
-        # 参数信息（对于其他类型的关键字）
-        parameters = keyword_info.get('parameters', [])
-        if parameters:
-            lines.append("  参数:")
-            for param in parameters:
-                param_name = getattr(param, 'name', str(param))
-                param_mapping = getattr(param, 'mapping', '')
-                param_desc = getattr(param, 'description', '')
-                param_default = getattr(param, 'default', None)
-
-                # 构建参数描述
-                param_info = []
-                if param_mapping and param_mapping != param_name:
-                    param_info.append(f"{param_name} ({param_mapping})")
-                else:
-                    param_info.append(param_name)
-
-                param_info.append(f": {param_desc}")
-
-                # 添加默认值信息
-                if param_default is not None:
-                    param_info.append(f" (默认值: {param_default})")
-
-                lines.append(f"    {''.join(param_info)}")
-        else:
-            lines.append("  参数: 无")
-
-    # 函数文档
-    func = keyword_info.get('func')
-    if func and hasattr(func, '__doc__') and func.__doc__:
-        lines.append(f"  说明: {func.__doc__.strip()}")
-
-    return '\n'.join(lines)
-
-
-def format_keyword_info_json(keyword_name, keyword_info,
-                             project_custom_keywords=None):
-    """格式化关键字信息为JSON格式"""
-    category = categorize_keyword(
-        keyword_name, keyword_info, project_custom_keywords
-    )
-    source_info = get_keyword_source_info(keyword_info)
-
-    keyword_data = {
-        'name': keyword_name,
-        'category': category,
-        'source_info': source_info,
-        'parameters': []
-    }
-
-    # 远程关键字特殊信息
-    if keyword_info.get('remote', False):
-        keyword_data['remote'] = {
-            'alias': keyword_info.get('alias', ''),
-            'original_name': keyword_info.get('original_name', keyword_name)
-        }
-
-    # 项目自定义关键字特殊信息
-    if category == 'project_custom' and project_custom_keywords:
-        custom_info = project_custom_keywords[keyword_name]
-        keyword_data['file_location'] = custom_info['file']
-
-        # 对于项目自定义关键字，使用从AST中提取的参数信息
-        for param_info in custom_info.get('parameters', []):
-            keyword_data['parameters'].append(param_info)
-    else:
-        # 参数信息（对于其他类型的关键字）
-        parameters = keyword_info.get('parameters', [])
-        for param in parameters:
-            param_data = {
-                'name': getattr(param, 'name', str(param)),
-                'mapping': getattr(param, 'mapping', ''),
-                'description': getattr(param, 'description', '')
-            }
-
-            # 添加默认值信息
-            param_default = getattr(param, 'default', None)
-            if param_default is not None:
-                param_data['default'] = param_default
-
-            keyword_data['parameters'].append(param_data)
-
-    # 函数文档
-    func = keyword_info.get('func')
-    if func and hasattr(func, '__doc__') and func.__doc__:
-        keyword_data['documentation'] = func.__doc__.strip()
-
-    return keyword_data
-
-
-def generate_html_report(keywords_data, output_file):
-    """生成HTML格式的关键字报告"""
-    from jinja2 import Environment, FileSystemLoader, select_autoescape
-    import os
-
-    # 准备数据
-    summary = keywords_data['summary']
-    keywords = keywords_data['keywords']
-
-    # 按类别分组
-    categories = {}
-    for keyword in keywords:
-        category = keyword['category']
-        if category not in categories:
-            categories[category] = []
-        categories[category].append(keyword)
-
-    # 按来源分组（用于更详细的分组视图）
-    source_groups = {}
-    for keyword in keywords:
-        source_info = keyword.get('source_info', {})
-        category = keyword['category']
-        source_name = source_info.get('name', '未知来源')
-
-        # 构建分组键
-        if category == 'plugin':
-            group_key = f"插件 - {source_name}"
-        elif category == 'builtin':
-            group_key = "内置关键字"
-        elif category == 'project_custom':
-            group_key = f"项目自定义 - {keyword.get('file_location', source_name)}"
-        elif category == 'remote':
-            group_key = f"远程 - {source_name}"
-        else:
-            group_key = f"自定义 - {source_name}"
-
-        if group_key not in source_groups:
-            source_groups[group_key] = []
-        source_groups[group_key].append(keyword)
-
-    # 按位置分组（用于全部关键字视图，保持向后兼容）
-    location_groups = {}
-    for keyword in keywords:
-        # 优先使用file_location，然后使用source_info中的name
-        location = keyword.get('file_location')
-        if not location:
-            source_info = keyword.get('source_info', {})
-            location = source_info.get('name', '内置/插件')
-
-        if location not in location_groups:
-            location_groups[location] = []
-        location_groups[location].append(keyword)
-
-    # 类别名称映射
-    category_names = {
-        'builtin': '内置',
-        'plugin': '插件',
-        'custom': '自定义',
-        'project_custom': '项目自定义',
-        'remote': '远程'
-    }
-
-    # 设置Jinja2环境
-    template_dir = os.path.join(os.path.dirname(__file__), 'templates')
-
-    env = Environment(
-        loader=FileSystemLoader(template_dir),
-        autoescape=select_autoescape(['html', 'xml'])
-    )
-
-    # 加载模板
-    template = env.get_template('keywords_report.html')
-
-    # 渲染模板
-    html_content = template.render(
-        summary=summary,
-        keywords=keywords,
-        categories=categories,
-        source_groups=source_groups,
-        location_groups=location_groups,
-        category_names=category_names
-    )
-
-    # 写入文件
-    with open(output_file, 'w', encoding='utf-8') as f:
-        f.write(html_content)
-
-    print(f"HTML报告已生成: {output_file}")
-
-
 def list_keywords(output_format='json', name_filter=None,
                   category_filter='all', output_file=None,
                   include_remote=False):
-    """罗列所有关键字信息"""
-    import json
-
+    """罗列所有关键字信息（简化版，调用统一的工具函数）"""
     print("正在加载关键字...")
-    project_custom_keywords = load_all_keywords(include_remote=include_remote)
-
-    # 获取所有注册的关键字
-    all_keywords = keyword_manager._keywords
-
-    if not all_keywords:
-        print("未发现任何关键字")
-        return
-
-    # 过滤关键字
-    filtered_keywords = {}
 
-    for name, info in all_keywords.items():
-        # 名称过滤
-        if name_filter and name_filter.lower() not in name.lower():
-            continue
-
-        # 远程关键字过滤
-        if not include_remote and info.get('remote', False):
-            continue
-
-        # 类别过滤
-        if category_filter != 'all':
-            keyword_category = categorize_keyword(
-                name, info, project_custom_keywords
-            )
-            if keyword_category != category_filter:
-                continue
-
-        filtered_keywords[name] = info
-
-    if not filtered_keywords:
-        if name_filter:
-            print(f"未找到包含 '{name_filter}' 的关键字")
-        else:
-            print(f"未找到 {category_filter} 类别的关键字")
-        return
-
-    # 输出统计信息
-    total_count = len(filtered_keywords)
-    category_counts = {}
-    source_counts = {}
-
-    for name, info in filtered_keywords.items():
-        cat = categorize_keyword(name, info, project_custom_keywords)
-        category_counts[cat] = category_counts.get(cat, 0) + 1
-
-        # 统计各来源的关键字数量
-        source_info = get_keyword_source_info(info)
-        source_name = source_info['name']
-        if cat == 'project_custom' and project_custom_keywords:
-            custom_info = project_custom_keywords[name]
-            source_name = custom_info['file']
-
-        source_key = f"{cat}:{source_name}"
-        source_counts[source_key] = source_counts.get(source_key, 0) + 1
-
-    if output_format == 'text':
-        print(f"\n找到 {total_count} 个关键字:")
-        for cat, count in category_counts.items():
-            cat_names = {
-                'builtin': '内置', 'plugin': '插件', 'custom': '自定义',
-                'project_custom': '项目自定义', 'remote': '远程'
-            }
-            print(f"  {cat_names.get(cat, cat)}: {count} 个")
-        print("-" * 60)
-
-        # 按类别和来源分组显示
-        grouped = group_keywords_by_source(
-            filtered_keywords, project_custom_keywords
+    # 使用统一的工具函数
+    try:
+        utils_list_keywords(
+            output_format=output_format,
+            name_filter=name_filter,
+            category_filter=category_filter,
+            include_remote=include_remote,
+            output_file=output_file,
+            print_summary=True
         )
-
-        for category in [
-            'builtin', 'plugin', 'custom', 'project_custom', 'remote'
-        ]:
-            if category not in grouped or not grouped[category]:
-                continue
-
-            cat_names = {
-                'builtin': '内置关键字',
-                'plugin': '插件关键字',
-                'custom': '自定义关键字',
-                'project_custom': '项目自定义关键字',
-                'remote': '远程关键字'
-            }
-            print(f"\n=== {cat_names[category]} ===")
-
-            for source_name, keyword_list in grouped[category].items():
-                if len(grouped[category]) > 1:  # 如果有多个来源，显示来源名
-                    print(f"\n--- {source_name} ---")
-
-                for keyword_data in keyword_list:
-                    name = keyword_data['name']
-                    info = keyword_data['info']
-                    print()
-                    print(format_keyword_info_text(
-                        name, info, show_category=False,
-                        project_custom_keywords=project_custom_keywords
-                    ))
-
-    elif output_format == 'json':
-        keywords_data = {
-            'summary': {
-                'total_count': total_count,
-                'category_counts': category_counts,
-                'source_counts': source_counts
-            },
-            'keywords': []
-        }
-
-        for name in sorted(filtered_keywords.keys()):
-            info = filtered_keywords[name]
-            keyword_data = format_keyword_info_json(
-                name, info, project_custom_keywords
-            )
-            keywords_data['keywords'].append(keyword_data)
-
-        json_output = json.dumps(keywords_data, ensure_ascii=False, indent=2)
-
-        # 确定输出文件名
-        if output_file is None:
-            output_file = 'keywords.json'
-
-        # 写入到文件
-        try:
-            with open(output_file, 'w', encoding='utf-8') as f:
-                f.write(json_output)
-            print(f"关键字信息已保存到文件: {output_file}")
-            print(f"共 {total_count} 个关键字")
-            for cat, count in category_counts.items():
-                cat_names = {
-                    'builtin': '内置', 'plugin': '插件', 'custom': '自定义',
-                    'project_custom': '项目自定义', 'remote': '远程'
-                }
-                print(f"  {cat_names.get(cat, cat)}: {count} 个")
-        except Exception as e:
-            print(f"保存文件失败: {e}")
-            # 如果写入文件失败，则回退到打印
-            print(json_output)
-
-    elif output_format == 'html':
-        keywords_data = {
-            'summary': {
-                'total_count': total_count,
-                'category_counts': category_counts,
-                'source_counts': source_counts
-            },
-            'keywords': []
-        }
-
-        for name in sorted(filtered_keywords.keys()):
-            info = filtered_keywords[name]
-            keyword_data = format_keyword_info_json(
-                name, info, project_custom_keywords
-            )
-            keywords_data['keywords'].append(keyword_data)
-
-        # 确定输出文件名
-        if output_file is None:
-            output_file = 'keywords.html'
-
-        # 生成HTML报告
-        try:
-            generate_html_report(keywords_data, output_file)
-            print(f"共 {total_count} 个关键字")
-            for cat, count in category_counts.items():
-                cat_names = {
-                    'builtin': '内置', 'plugin': '插件', 'custom': '自定义',
-                    'project_custom': '项目自定义', 'remote': '远程'
-                }
-                print(f"  {cat_names.get(cat, cat)}: {count} 个")
-        except Exception as e:
-            print(f"生成HTML报告失败: {e}")
-            raise
+    except Exception as e:
+        print(f"列出关键字失败: {e}")
+        raise
 
 
 def load_yaml_variables(args):
@@ -776,8 +367,5 @@ def main_list_keywords():
     )
 
 
-
-
-
 if __name__ == '__main__':
     main()