pytest-dsl 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

pytest_dsl/cli.py

@@ -69,7 +69,7 @@ def parse_args():
         )
         list_parser.add_argument(
             '--output', '-o', type=str, default=None,
-            help='输出文件路径（仅对 json 格式有效，默认为 keywords.json）'
+            help='输出文件路径（json格式默认为keywords.json，html格式默认为keywords.html）'
         )
         list_parser.add_argument(
             '--filter', type=str, default=None,
@@ -77,7 +77,10 @@ def parse_args():
         )
         list_parser.add_argument(
             '--category',
-            choices=['builtin', 'plugin', 'custom', 'project_custom', 'remote', 'all'],
+            choices=[
+                'builtin', 'plugin', 'custom', 
+                'project_custom', 'remote', 'all'
+            ],
             default='all',
             help='关键字类别：builtin(内置)、plugin(插件)、custom(自定义)、'
                  'project_custom(项目自定义)、remote(远程)、all(全部，默认)'
@@ -105,7 +108,8 @@ def parse_args():
             parser.add_argument(
                 '--category',
                 choices=[
-                    'builtin', 'plugin', 'custom', 'project_custom', 'remote', 'all'
+                    'builtin', 'plugin', 'custom', 
+                    'project_custom', 'remote', 'all'
                 ],
                 default='all'
             )
@@ -136,7 +140,7 @@ def parse_args():
 
 def load_all_keywords(include_remote=False):
     """加载所有可用的关键字
-    
+
     Args:
         include_remote: 是否包含远程关键字，默认为False
     """
@@ -152,28 +156,28 @@ def load_all_keywords(include_remote=False):
 
     # 扫描本地关键字
     scan_local_keywords()
-    
+
     # 扫描项目中的自定义关键字（.resource文件中定义的）
     project_custom_keywords = scan_project_custom_keywords()
     if project_custom_keywords:
         print(f"发现 {len(project_custom_keywords)} 个项目自定义关键字")
-        
+
         # 加载.resource文件中的关键字到关键字管理器
         from pytest_dsl.core.custom_keyword_manager import (
             custom_keyword_manager
         )
         from pathlib import Path
-        
+
         project_root = Path(os.getcwd())
         resource_files = list(project_root.glob('**/*.resource'))
-        
+
         for resource_file in resource_files:
             try:
                 custom_keyword_manager.load_resource_file(str(resource_file))
                 print(f"已加载资源文件: {resource_file}")
             except Exception as e:
                 print(f"加载资源文件失败 {resource_file}: {e}")
-    
+
     # 根据参数决定是否加载远程关键字
     if include_remote:
         print("正在扫描远程关键字...")
@@ -181,11 +185,11 @@ def load_all_keywords(include_remote=False):
         # 目前远程关键字是通过DSL文件中的@remote导入指令动态加载的
     else:
         print("跳过远程关键字扫描")
-    
+
     return project_custom_keywords
 
 
-def categorize_keyword(keyword_name, keyword_info, 
+def categorize_keyword(keyword_name, keyword_info,
                        project_custom_keywords=None):
     """判断关键字的类别"""
     # 优先使用存储的来源信息
@@ -199,11 +203,11 @@ def categorize_keyword(keyword_name, keyword_info,
             return 'custom'
         elif source_type == 'project_custom':
             return 'project_custom'
-    
+
     # 向后兼容：使用原有的判断逻辑
     if keyword_info.get('remote', False):
         return 'remote'
-    
+
     # 检查是否是项目自定义关键字（DSL文件中定义的）
     if project_custom_keywords and keyword_name in project_custom_keywords:
         return 'project_custom'
@@ -222,7 +226,7 @@ def get_keyword_source_info(keyword_info):
     """获取关键字的详细来源信息"""
     source_type = keyword_info.get('source_type', 'unknown')
     source_name = keyword_info.get('source_name', '未知')
-    
+
     return {
         'type': source_type,
         'name': source_name,
@@ -234,7 +238,7 @@ def get_keyword_source_info(keyword_info):
 
 def group_keywords_by_source(keywords_dict, project_custom_keywords=None):
     """按来源分组关键字
-    
+
     Returns:
         dict: 格式为 {source_group: {source_name: [keywords]}}
     """
@@ -245,33 +249,33 @@ def group_keywords_by_source(keywords_dict, project_custom_keywords=None):
         'project_custom': {},
         'remote': {}
     }
-    
+
     for keyword_name, keyword_info in keywords_dict.items():
         category = categorize_keyword(
             keyword_name, keyword_info, project_custom_keywords
         )
         source_info = get_keyword_source_info(keyword_info)
-        
+
         # 特殊处理项目自定义关键字
         if category == 'project_custom' and project_custom_keywords:
             custom_info = project_custom_keywords[keyword_name]
             source_name = custom_info['file']
         else:
             source_name = source_info['name']
-        
+
         if source_name not in groups[category]:
             groups[category][source_name] = []
-        
+
         groups[category][source_name].append({
             'name': keyword_name,
             'info': keyword_info,
             'source_info': source_info
         })
-    
+
     return groups
 
 
-def format_keyword_info_text(keyword_name, keyword_info, show_category=True, 
+def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
                              project_custom_keywords=None):
     """格式化关键字信息为文本格式"""
     lines = []
@@ -281,9 +285,9 @@ def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
         keyword_name, keyword_info, project_custom_keywords
     )
     category_names = {
-        'builtin': '内置', 
-        'custom': '自定义', 
-        'project_custom': '项目自定义', 
+        'builtin': '内置',
+        'custom': '自定义',
+        'project_custom': '项目自定义',
         'remote': '远程'
     }
 
@@ -304,7 +308,7 @@ def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
     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:
@@ -321,13 +325,13 @@ def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
                     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("  参数: 无")
@@ -348,13 +352,13 @@ def format_keyword_info_text(keyword_name, keyword_info, show_category=True,
                     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("  参数: 无")
@@ -393,7 +397,7 @@ def format_keyword_info_json(keyword_name, keyword_info,
     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)
@@ -406,12 +410,12 @@ def format_keyword_info_json(keyword_name, keyword_info,
                 '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)
 
     # 函数文档
@@ -426,11 +430,11 @@ 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:
@@ -438,14 +442,14 @@ def generate_html_report(keywords_data, output_file):
         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}"
@@ -457,11 +461,11 @@ def generate_html_report(keywords_data, output_file):
             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:
@@ -470,11 +474,11 @@ def generate_html_report(keywords_data, output_file):
         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': '内置',
@@ -483,18 +487,18 @@ def generate_html_report(keywords_data, output_file):
         '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,
@@ -504,16 +508,16 @@ def generate_html_report(keywords_data, output_file):
         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, 
+                  category_filter='all', output_file=None,
                   include_remote=False):
     """罗列所有关键字信息"""
     import json
@@ -561,18 +565,18 @@ def list_keywords(output_format='json', name_filter=None,
     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
 
@@ -590,13 +594,13 @@ def list_keywords(output_format='json', name_filter=None,
         grouped = group_keywords_by_source(
             filtered_keywords, project_custom_keywords
         )
-        
+
         for category in [
             'builtin', 'plugin', 'custom', 'project_custom', 'remote'
         ]:
             if category not in grouped or not grouped[category]:
                 continue
-                
+
             cat_names = {
                 'builtin': '内置关键字',
                 'plugin': '插件关键字',
@@ -605,11 +609,11 @@ def list_keywords(output_format='json', name_filter=None,
                 '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']
@@ -637,11 +641,11 @@ def list_keywords(output_format='json', name_filter=None,
             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:
@@ -679,7 +683,7 @@ def list_keywords(output_format='json', name_filter=None,
         # 确定输出文件名
         if output_file is None:
             output_file = 'keywords.html'
-        
+
         # 生成HTML报告
         try:
             generate_html_report(keywords_data, output_file)
@@ -850,7 +854,9 @@ def main_list_keywords():
     )
     parser.add_argument(
         '--category',
-        choices=['builtin', 'plugin', 'custom', 'project_custom', 'remote', 'all'],
+        choices=[
+            'builtin', 'plugin', 'custom', 'project_custom', 'remote', 'all'
+        ],
         default='all',
         help='关键字类别：builtin(内置)、plugin(插件)、custom(自定义)、'
              'project_custom(项目自定义)、remote(远程)、all(全部，默认)'
@@ -873,103 +879,103 @@ def main_list_keywords():
 
 def scan_project_custom_keywords(project_root=None):
     """扫描项目中.resource文件中的自定义关键字
-    
+
     Args:
         project_root: 项目根目录，默认为当前工作目录
-        
+
     Returns:
         dict: 自定义关键字信息，格式为 
               {keyword_name: {'file': file_path, 'node': ast_node}}
     """
     if project_root is None:
         project_root = os.getcwd()
-    
+
     project_root = Path(project_root)
     custom_keywords = {}
-    
+
     # 查找所有.resource文件
     resource_files = list(project_root.glob('**/*.resource'))
-    
+
     if not resource_files:
         return custom_keywords
-    
+
     lexer = get_lexer()
     parser = get_parser()
-    
+
     for file_path in resource_files:
         try:
             # 读取并解析文件
             content = read_file(str(file_path))
             ast = parser.parse(content, lexer=lexer)
-            
+
             # 查找自定义关键字定义
             keywords_in_file = extract_custom_keywords_from_ast(
                 ast, str(file_path)
             )
             custom_keywords.update(keywords_in_file)
-            
+
         except Exception as e:
             print(f"解析资源文件 {file_path} 时出错: {e}")
-    
+
     return custom_keywords
 
 
 def extract_custom_keywords_from_ast(ast, file_path):
     """从AST中提取自定义关键字定义
-    
+
     Args:
         ast: 抽象语法树
         file_path: 文件路径
-        
+
     Returns:
         dict: 自定义关键字信息
     """
     custom_keywords = {}
-    
+
     if ast.type != 'Start' or len(ast.children) < 2:
         return custom_keywords
-    
+
     # 遍历语句节点
     statements_node = ast.children[1]
     if statements_node.type != 'Statements':
         return custom_keywords
-    
+
     for node in statements_node.children:
         # 支持两种格式：CustomKeyword（旧格式）和Function（新格式）
         if node.type in ['CustomKeyword', 'Function']:
             keyword_name = node.value
-            
+
             # 提取参数信息
             params_node = node.children[0] if node.children else None
             parameters = []
-            
+
             if params_node:
                 for param in params_node:
                     param_name = param.value
                     param_default = None
-                    
+
                     # 检查是否有默认值
                     if param.children and param.children[0]:
                         param_default = param.children[0].value
-                    
+
                     param_info = {
                         'name': param_name,
                         'mapping': param_name,
                         'description': f'自定义关键字参数 {param_name}'
                     }
-                    
+
                     if param_default is not None:
                         param_info['default'] = param_default
-                    
+
                     parameters.append(param_info)
-            
+
             custom_keywords[keyword_name] = {
                 'file': file_path,
                 'node': node,
                 'type': 'project_custom',
                 'parameters': parameters
             }
-    
+
     return custom_keywords