py2docfx 0.1.22.dev2258230__py3-none-any.whl → 0.1.22.dev2259826__py3-none-any.whl

py2docfx/docfx_yaml/process_doctree.py

@@ -12,28 +12,13 @@ from utils import transform_string
 from enum import EnumMeta
 from importlib import import_module
 from logger import get_package_logger
+from type_mapping import map_type_transformations, PACKAGE, METHOD, FUNCTION, DATA, MODULE, CLASS, EXCEPTION, ATTRIBUTE, PROPERTY, PYDANTIC_MODEL, PYDANTIC_FIELD, PYDANTIC_SETTINGS, PYDANTIC_VALIDATOR, PYDANTIC_CONFIG
 
-PACKAGE = 'package'
-METHOD = 'method'
-FUNCTION = 'function'
-DATA = 'data'
-MODULE = 'module'
-CLASS = 'class'
-EXCEPTION = 'exception'
-ATTRIBUTE = 'attribute'
-PROPERTY = 'property'
 REFMETHOD = 'meth'
 REFFUNCTION = 'func'
 REF_PATTERN = ':(py:)?(func|class|meth|mod|ref):`~?[a-zA-Z_\.<> ]*?`'
 INITPY = '__init__.py'
 
-#Pydantic specific types
-PYDANTIC_MODEL = 'pydantic_model'
-PYDANTIC_FIELD = 'pydantic_field'
-PYDANTIC_SETTINGS = 'pydantic_settings'
-PYDANTIC_VALIDATOR = 'pydantic_validator'
-PYDANTIC_CONFIG = 'pydantic_config'
-
 def _fullname(obj):
     """
     Get the fullname from a Python object
@@ -395,13 +380,8 @@ def process_docstring(app, _type, name, obj, options, lines):
                 return PACKAGE
         return _type
 
-    # Type transformations
-    if _type == EXCEPTION or _type in {PYDANTIC_MODEL, PYDANTIC_SETTINGS, PYDANTIC_CONFIG}:
-        _type = CLASS
-    elif _type == PROPERTY or _type == PYDANTIC_FIELD:
-        _type = ATTRIBUTE
-    elif _type == PYDANTIC_VALIDATOR:
-        _type = METHOD
+    # Apply type transformations using shared mapping function
+    _type = map_type_transformations(_type)
 
     _type = check_convert_package_type(obj, _type)
     cls, module = _get_cls_module(_type, name)

py2docfx/docfx_yaml/translator.py

@@ -15,35 +15,15 @@ from sphinx.util.docfields import _is_single_paragraph
 from collections import OrderedDict
 from nodes import remarks
 from logger import get_package_logger
+from type_mapping import (
+    translator_type_mapping, CLASS_TYPE, EXCEPTION_TYPE, ATTRIBUTE_TYPE,
+    PYDANTIC_MODEL_TYPE, PYDANTIC_SETTINGS_TYPE, PYDANTIC_FIELD_TYPE, PYDANTIC_CONFIG_TYPE,
+    types_contain_constructor, types_contain_attributes, attribute_types
+)
 
 TYPE_SEP_PATTERN = '(\[|\]|, |\(|\))'
 PARAMETER_NAME = "[*][*](.*?)[*][*]"
 PARAMETER_TYPE = "[(]((?:.|\n)*)[)]"
-CLASS_TYPE = 'class'
-EXCEPTION_TYPE = 'exception'
-ATTRIBUTE_TYPE = 'attribute'
-
-# Pydantic specific types
-PYDANTIC_MODEL_TYPE = "pydantic_model"
-PYDANTIC_SETTINGS_TYPE = "pydantic_settings"
-PYDANTIC_FIELD_TYPE = "pydantic_field"
-PYDANTIC_CONFIG_TYPE = "pydantic_config"
-
-types_contain_constructor = {
-    CLASS_TYPE,
-    PYDANTIC_MODEL_TYPE,
-    PYDANTIC_SETTINGS_TYPE,
-    EXCEPTION_TYPE,
-    PYDANTIC_CONFIG_TYPE,
-}
-types_contain_attributes = {
-    CLASS_TYPE,
-    PYDANTIC_MODEL_TYPE,
-    PYDANTIC_SETTINGS_TYPE,
-    EXCEPTION_TYPE,
-    PYDANTIC_CONFIG_TYPE,
-}
-attribute_types = {PYDANTIC_FIELD_TYPE, ATTRIBUTE_TYPE}
 
 def translator(app, docname, doctree):
 
@@ -64,15 +44,6 @@ def translator(app, docname, doctree):
         else:
             return para_field.astext()
 
-    def type_mapping(type_name):
-        mapping = {
-            "staticmethod": "method",
-            "classmethod": "method",
-            "exception": "class",
-        }
-
-        return mapping[type_name] if type_name in mapping else type_name
-
     def _get_uid_and_type_from_desc(node):
         assert node.tagname == 'desc'
         if node.attributes['domain'] != 'py':
@@ -493,7 +464,7 @@ def translator(app, docname, doctree):
         data.update(extract_content(content_child, node_type, module_name))
         data['content'] = extract_signature(signature_child)
 
-        data['type'] = type_mapping(node_type) if node_type else 'unknown'
+        data['type'] = translator_type_mapping(node_type) if node_type else 'unknown'
         if _is_property_node(signature_child):
             data['type'] = ATTRIBUTE_TYPE
 

py2docfx/docfx_yaml/type_mapping.py

@@ -0,0 +1,102 @@
+# -*- coding: utf-8 -*-
+#
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+"""
+Type mapping utilities for converting various documentation types to standardized forms.
+"""
+
+# Standard types
+PACKAGE = 'package'
+METHOD = 'method'
+FUNCTION = 'function'
+DATA = 'data'
+MODULE = 'module'
+CLASS = 'class'
+EXCEPTION = 'exception'
+ATTRIBUTE = 'attribute'
+PROPERTY = 'property'
+
+# Pydantic specific types
+PYDANTIC_MODEL = 'pydantic_model'
+PYDANTIC_FIELD = 'pydantic_field'
+PYDANTIC_SETTINGS = 'pydantic_settings'
+PYDANTIC_VALIDATOR = 'pydantic_validator'
+PYDANTIC_CONFIG = 'pydantic_config'
+
+# Translator-style constants (for compatibility)
+CLASS_TYPE = 'class'
+EXCEPTION_TYPE = 'exception'
+ATTRIBUTE_TYPE = 'attribute'
+PYDANTIC_MODEL_TYPE = "pydantic_model"
+PYDANTIC_SETTINGS_TYPE = "pydantic_settings"
+PYDANTIC_FIELD_TYPE = "pydantic_field"
+PYDANTIC_CONFIG_TYPE = "pydantic_config"
+
+# Type groupings for translator functionality
+types_contain_constructor = {
+    CLASS_TYPE,
+    PYDANTIC_MODEL_TYPE,
+    PYDANTIC_SETTINGS_TYPE,
+    EXCEPTION_TYPE,
+    PYDANTIC_CONFIG_TYPE,
+}
+
+types_contain_attributes = {
+    CLASS_TYPE,
+    PYDANTIC_MODEL_TYPE,
+    PYDANTIC_SETTINGS_TYPE,
+    EXCEPTION_TYPE,
+    PYDANTIC_CONFIG_TYPE,
+}
+
+attribute_types = {PYDANTIC_FIELD_TYPE, ATTRIBUTE_TYPE}
+
+
+def map_type_transformations(type_name):
+    """
+    Apply type transformations to convert various documentation types to standardized forms.
+    Used by process_doctree.py for initial type processing.
+    
+    Args:
+        type_name (str): The original type name
+        
+    Returns:
+        str: The transformed type name
+    """
+    # Type transformations
+    if type_name == EXCEPTION or type_name in {PYDANTIC_MODEL, PYDANTIC_SETTINGS, PYDANTIC_CONFIG}:
+        return CLASS
+    elif type_name == PROPERTY or type_name == PYDANTIC_FIELD:
+        return ATTRIBUTE
+    elif type_name == PYDANTIC_VALIDATOR:
+        return METHOD
+    
+    # Return original type if no transformation needed
+    return type_name
+
+
+def translator_type_mapping(type_name):
+    """
+    Apply type mapping transformations for translator processing.
+    Used by translator.py for docstring processing.
+    Includes both original translator mappings and process_doctree transformations.
+    
+    Args:
+        type_name (str): The original type name
+        
+    Returns:
+        str: The mapped type name
+    """
+    # First apply the process_doctree style transformations
+    transformed_type = map_type_transformations(type_name)
+    
+    # Then apply the original translator mappings
+    mapping = {
+        "staticmethod": "method",
+        "classmethod": "method",
+    }
+
+    return mapping[transformed_type] if transformed_type in mapping else transformed_type

{py2docfx-0.1.22.dev2258230.dist-info → py2docfx-0.1.22.dev2259826.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py2docfx
-Version: 0.1.22.dev2258230
+Version: 0.1.22.dev2259826
 Summary: A package built based on Sphinx which download source code package and generate yaml files supported by docfx.
 Author: Microsoft Corporation
 License: MIT License

{py2docfx-0.1.22.dev2258230.dist-info → py2docfx-0.1.22.dev2259826.dist-info}/RECORD

@@ -69,10 +69,11 @@ py2docfx/docfx_yaml/logger.py,sha256=brzFbSgQq3o3n2sy-2pk849AVpaUn1rhJfIs44IYa0Y
 py2docfx/docfx_yaml/miss_reference.py,sha256=NHoQtas0kvFsJXaR4fsk7kHjwV4aJobrr_Q30HaUc_I,2450
 py2docfx/docfx_yaml/nodes.py,sha256=tBDi35jLJArlobl07DKOkmH2qz7dudXLp_kTUfR_r2w,412
 py2docfx/docfx_yaml/parameter_utils.py,sha256=04wQCtbS-G2hWM5UGkL22s10LZLUbqbh3RM9rWGOToI,10897
-py2docfx/docfx_yaml/process_doctree.py,sha256=1WBZ_FrAryXbn84usaELKABTKcQ7ya4oMgiTNB3MW5M,17575
+py2docfx/docfx_yaml/process_doctree.py,sha256=xz4Whx19pprCo12jrZD2rLTVtM1dJsHSsURQOlF6xl0,17207
 py2docfx/docfx_yaml/return_type_utils.py,sha256=nmdCUOvwdYk2jF6RqmOvU6gjXmXUTPUeCqyHPdKZNUQ,7483
 py2docfx/docfx_yaml/settings.py,sha256=JQZNwFebczl-zn8Yk2taAGANRi-Hw8hywtDWxqXXFyQ,373
-py2docfx/docfx_yaml/translator.py,sha256=-KIN8nVMfekOmbp0Dh9CkF-fOiZAaqV3NHR04Honbqw,26282
+py2docfx/docfx_yaml/translator.py,sha256=hLSl8WkTMB_Oq5XuzCP4fDRWSOWzpNJN7Gzvy_SkXck,25664
+py2docfx/docfx_yaml/type_mapping.py,sha256=rgnkxbPRzr3C1NDLjXdAyYg1Zh-y0QcFutlzWvtJaC8,2954
 py2docfx/docfx_yaml/utils.py,sha256=sJ6aWF9wwIWIoZL6WWsd3FQD-zb3PWrJ5QTWP7PCarY,1567
 py2docfx/docfx_yaml/write_utils.py,sha256=q5qoYWw6GVDV8a3E8IxcSLWnN9sAer42VFRgadHBkgk,305
 py2docfx/docfx_yaml/writer.py,sha256=aDxz8Vc8ln0a9PKi08DIILvgMIfXqN5wArDcAQ8Iy8E,35980
@@ -3915,7 +3916,7 @@ py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/convert.py,sha256=0wSJMU0m
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/pack.py,sha256=o3iwjfRHl7N9ul-M2kHbewLJZnqBLAWf0tzUCwoiTMw,3078
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/tags.py,sha256=Rv2ySVb8-qX3osKp3uJgxcIMXkjt43XUD0-zvC6KvnY,4775
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/unpack.py,sha256=Y_J7ynxPSoFFTT7H0fMgbBlVErwyDGcObgme5MBuz58,1021
-py2docfx-0.1.22.dev2258230.dist-info/METADATA,sha256=GCKXgKosRdM58oa0w95u8rK4nH0zMQCTNMYhLbdZ_XQ,548
-py2docfx-0.1.22.dev2258230.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-py2docfx-0.1.22.dev2258230.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.22.dev2258230.dist-info/RECORD,,
+py2docfx-0.1.22.dev2259826.dist-info/METADATA,sha256=xTi8c6UJVwYuNDSY5O8A6dbR8WmuBwTblt8Ynk1NQlg,548
+py2docfx-0.1.22.dev2259826.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+py2docfx-0.1.22.dev2259826.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.22.dev2259826.dist-info/RECORD,,