py2docfx 0.1.15.dev2025178__py3-none-any.whl → 0.1.15.dev2025736__py3-none-any.whl

py2docfx/docfx_yaml/process_doctree.py

@@ -111,38 +111,27 @@ def _resolve_reference_in_module_summary(lines):
         new_lines.append(new_line)
     return new_lines
 
-def getParameterArgs(argspec):
+def getParameterArgs(signature):
     args = []
-    for arg in argspec.args:
-        args.append({'id': arg})
-    if argspec.defaults:
-        for count, default in enumerate(argspec.defaults):
-            cut_count = len(argspec.defaults)
-            # Only add defaultValue when str(default) doesn't contain object address string
-            # (object at 0x)(lambda at 0x)(function *** at 0x)
-            # inspect.getargspec method will return wrong defaults which contain object address for some default values, like sys.stdout
-            # Match the defaults with the count
-            if ' at 0x' not in str(default):
-                args[len(args) - cut_count +
-                    count]['defaultValue'] = str(default)
-            else:
-                args[len(args) - cut_count +
-                    count]['isRequired'] = False
+    for param in signature.parameters.values():
+        if param.kind in [param.POSITIONAL_OR_KEYWORD, param.POSITIONAL_ONLY]:
+            arg = {'id': param.name}
+            if param.default is not param.empty:
+                if ' at 0x' not in str(param.default):
+                    arg['defaultValue'] = str(param.default)
+                else:
+                    arg['isRequired'] = False
+            args.append(arg)
     return args
 
-def getKeywordOnlyParameters(argspec):
+def getKeywordOnlyParameters(signature):
     keyword_only_args = []
-    # check if there is keyword only args
-    if argspec.kwonlyargs:
-        count = 0
-        for arg in argspec.kwonlyargs:
-            keyword_only_args.append({'id': arg})
-            # try get the default value for keyword only args
-            if argspec.kwonlydefaults:
-                kwarg_default = argspec.kwonlydefaults.get(arg, None)
-                if kwarg_default:
-                    keyword_only_args[count]['defaultValue'] = str(kwarg_default)
-            count += 1
+    for param in signature.parameters.values():
+        if param.kind == param.KEYWORD_ONLY:
+            kwarg = {'id': param.name}
+            if param.default is not param.empty:
+                kwarg['defaultValue'] = str(param.default)
+            keyword_only_args.append(kwarg)
     return keyword_only_args
 
 def getpositionalOnlyParameters(signature):
@@ -193,13 +182,10 @@ def _create_datam(app, cls, module, name, _type, obj, lines=None):
         if _type in [CLASS, METHOD, FUNCTION]:
             if not (_type  == CLASS and isinstance(type(obj).__call__, type(EnumMeta.__call__))):       
                 signature = inspect.signature(obj)
-                argspec = inspect.getfullargspec(obj)
-
-                args = getParameterArgs(argspec)
-                keyword_only_args = getKeywordOnlyParameters(argspec)
+                args = getParameterArgs(signature)
+                keyword_only_args = getKeywordOnlyParameters(signature)
                 positional_only_params = getpositionalOnlyParameters(signature)
-
-                # The args will contian both regular args and positional only params
+                # The args will contain both regular args and positional only params
                 # so we need to remove the positional only args from params
                 if positional_only_params:
                     args = removePositonalOnlyFromArgs(args, positional_only_params)
@@ -391,6 +377,7 @@ def process_docstring(app, _type, name, obj, options, lines):
     """
     # Use exception as class
     py2docfx_logger = get_package_logger(__name__)
+
     def check_convert_package_type(obj, _type):
         if _type == MODULE:
             filename = getattr(obj, '__file__', None)

py2docfx/docfx_yaml/tests/test_method_arguments.py

@@ -1,24 +1,18 @@
 import pytest
-
-from sphinx.testing import restructuredtext
-from sphinx.io import SphinxStandaloneReader
-from sphinx import addnodes
 from translator import translator
+from .utils.test_utils import prepare_app_envs, load_rst_transform_to_doctree, do_autodoc
 
-from .utils.test_utils import prepare_app_envs,prepare_refered_objects,load_rst_transform_to_doctree, do_autodoc
 @pytest.mark.sphinx('dummy', testroot='method-arguments')
 def test_method_with_three_type_of_arguments(app):
     # Test data definition
     objectToGenXml = 'code_with_all_arg_types.TestClass'
     objectToGenXmlType = 'class'
-
     # Arrange
     prepare_app_envs(app, objectToGenXml)
     doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
     
     # Act
     translator(app, '', doctree)
-
     # Assert
     argumentsDetail = app.env.docfx_yaml_classes[objectToGenXml][1]['syntax']
     parameters = argumentsDetail.get('parameters', None)

py2docfx/docfx_yaml/tests/test_process_doctree.py

@@ -0,0 +1,120 @@
+import pytest
+import inspect
+from sphinx.config import Config
+from docfx_yaml.process_doctree import (
+    getParameterArgs,
+    getKeywordOnlyParameters
+)
+from unittest.mock import Mock
+from docfx_yaml.process_doctree import process_docstring
+from sphinx.config import ENUM
+
+# Test data for getParameterArgs
+@pytest.mark.parametrize("func, expected_args", [
+    (lambda a, b=2, *, c=3, d=4: None, [
+        {'id': 'a', 'isRequired': True},
+        {'id': 'b', 'defaultValue': '2'}
+    ]),
+    (lambda x, y, z=5: None, [
+        {'id': 'x', 'isRequired': True},
+        {'id': 'y', 'isRequired': True},
+        {'id': 'z', 'defaultValue': '5'}
+    ])
+])
+def test_getParameterArgs(func, expected_args):
+    signature = inspect.signature(func)
+    args = getParameterArgs(signature)
+    assert args == expected_args
+
+# Test data for getKeywordOnlyParameters
+@pytest.mark.parametrize("func, expected_kwonlyargs", [
+    (lambda a, b=2, *, c=3, d=4: None, [
+        {'id': 'c', 'defaultValue': '3'},
+        {'id': 'd', 'defaultValue': '4'}
+    ]),
+    (lambda x, y, *, z=5: None, [
+        {'id': 'z', 'defaultValue': '5'}
+    ])
+])
+def test_getKeywordOnlyParameters(func, expected_kwonlyargs):
+    signature = inspect.signature(func)
+    kwonlyargs = getKeywordOnlyParameters(signature)
+    assert kwonlyargs == expected_kwonlyargs
+
+
+@pytest.fixture
+def app():
+    app = Mock()
+    app.config = Config()
+    app.config.autoclass_content = 'both'
+    app.config.autodoc_functions = True
+    app.env = Mock()
+    app.env.docfx_yaml_packages = {}
+    app.env.docfx_yaml_modules = {}
+    app.env.docfx_yaml_classes = {}
+    app.env.docfx_yaml_functions = {}
+    app.env.docfx_info_uid_types = {}
+    return app
+
+
+def test_process_docstring_class(app):
+    class DummyClass:
+        """This is a dummy class."""
+        def method(self):
+            pass
+
+    process_docstring(app, 'class', 'test_module.DummyClass', DummyClass, {}, [])
+
+    assert 'test_module.DummyClass' in app.env.docfx_yaml_classes
+    assert len(app.env.docfx_yaml_classes['test_module.DummyClass']) == 1
+    datam = app.env.docfx_yaml_classes['test_module.DummyClass'][0]
+    assert datam['type'] == 'class'
+    assert datam['name'] == 'DummyClass'
+    assert datam['fullName'] == 'test_module.DummyClass'
+
+
+def test_process_docstring_function(app):
+    def dummy_function():
+        """This is a dummy function."""
+        pass
+
+    process_docstring(app, 'function', 'test_module.dummy_function', dummy_function, {}, [])
+
+    assert 'test_module.dummy_function' in app.env.docfx_yaml_functions
+    assert len(app.env.docfx_yaml_functions['test_module.dummy_function']) == 1
+    datam = app.env.docfx_yaml_functions['test_module.dummy_function'][0]
+    assert datam['type'] == 'function'
+    assert datam['name'] == 'dummy_function'
+    assert datam['fullName'] == 'test_module.dummy_function'
+
+
+def test_process_docstring_decorated_method(app):
+    class DecoratedClass:
+        """This is a decorated class."""
+        @staticmethod
+        def decorated_method(a, b=2, *, c=3):
+            """This is a decorated method."""
+            pass
+
+    process_docstring(app, 'class', 'test_module.DecoratedClass', DecoratedClass, {}, [])
+
+    assert 'test_module.DecoratedClass' in app.env.docfx_yaml_classes
+    assert len(app.env.docfx_yaml_classes['test_module.DecoratedClass']) == 1
+    datam = app.env.docfx_yaml_classes['test_module.DecoratedClass'][0]
+    assert datam['type'] == 'class'
+    assert datam['name'] == 'DecoratedClass'
+    assert datam['fullName'] == 'test_module.DecoratedClass'
+
+    process_docstring(app, 'method', 'test_module.DecoratedClass.decorated_method', DecoratedClass.decorated_method, {}, [])
+
+    method_syntax_list = [m for m in app.env.docfx_yaml_classes['test_module.DecoratedClass'] if m['name'] == 'decorated_method']
+    assert len(method_syntax_list) == 1
+    method_syntax = method_syntax_list[0]['syntax']
+    assert method_syntax['parameters'] == [
+        {'id': 'a', 'isRequired': True},
+        {'id': 'b', 'defaultValue': '2'}
+    ]
+    assert method_syntax['keywordOnlyParameters'] == [
+        {'id': 'c', 'defaultValue': '3'}
+    ]
+    assert 'positionalOnlyParameters' not in method_syntax

{py2docfx-0.1.15.dev2025178.dist-info → py2docfx-0.1.15.dev2025736.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.15.dev2025178
+Version: 0.1.15.dev2025736
 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.15.dev2025178.dist-info → py2docfx-0.1.15.dev2025736.dist-info}/RECORD

@@ -69,7 +69,7 @@ py2docfx/docfx_yaml/logger.py,sha256=gz416vqSqmsD91qLOCLAzomczlCfWqGXFJFRzLlVbJE
 py2docfx/docfx_yaml/miss_reference.py,sha256=Btoj9wAvA4u_wU7JHH0Cei3910N8a7MS34OUqJvXAd4,2443
 py2docfx/docfx_yaml/nodes.py,sha256=tBDi35jLJArlobl07DKOkmH2qz7dudXLp_kTUfR_r2w,412
 py2docfx/docfx_yaml/parameter_utils.py,sha256=zGSIQrUfbXf9PUK-W_1K83Uo5Zk797Zlze6aMurbHIA,8706
-py2docfx/docfx_yaml/process_doctree.py,sha256=n2D-DCR7JmqVXm0oeuYZVnHIaHJZOegM8-kHXXx8IZ4,17857
+py2docfx/docfx_yaml/process_doctree.py,sha256=RUbq2DkkKl-KjKiuQrZhuvi8Q_ZjUdW4oi6CTWpMkxc,17229
 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=LSzNl4C-07bLbUZ5myfyWwh25cTNIIBih77Cp4tBWvo,25999
@@ -80,8 +80,9 @@ py2docfx/docfx_yaml/yaml_builder.py,sha256=S3xty_ILxEUsw1J9VCwUkSLLYAUfQDm3fYbci
 py2docfx/docfx_yaml/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/docfx_yaml/tests/conftest.py,sha256=CykkZxaDZ-3a1EIQdGBieSmHL9FdyTE2xTJZe9QgKcg,1214
 py2docfx/docfx_yaml/tests/test_build_finished.py,sha256=PSyWuY_XWmNeSjQl4kBwHUWpEhQHuEXQCZPWtFZ7vb4,8433
-py2docfx/docfx_yaml/tests/test_method_arguments.py,sha256=Cvj9aoADtacKciVN8nempXW-KQL8nujSa9GNVuk6l_8,1578
+py2docfx/docfx_yaml/tests/test_method_arguments.py,sha256=syfO626qaAh8pIy_ErzO5OeHR5FDlhGDvnBtUnZoU7k,1429
 py2docfx/docfx_yaml/tests/test_numpy_syntax.py,sha256=ssb3J_-Jzjybhh4eycCA_LkXbGflyZyIUAiTjlEYLiw,863
+py2docfx/docfx_yaml/tests/test_process_doctree.py,sha256=1BdXLRB0lQA_NUqCJAW4h1xsK7sfZQdQw_8KAzTjjQM,4326
 py2docfx/docfx_yaml/tests/test_translator_attributes.py,sha256=qZCsQGffq31k3UzpXkJpycplOXIq9gi2SxY6vu0DTfw,5224
 py2docfx/docfx_yaml/tests/test_translator_contents.py,sha256=lVCWbBIQk2oPFqsKK9gIb-b5DixutMabWjP7x03oj4s,1746
 py2docfx/docfx_yaml/tests/test_translator_data.py,sha256=zSVs3AT_TeAx1mrEYNTpy3Xy-FPrwwi93ly2EFclw5U,984
@@ -4207,7 +4208,7 @@ py2docfx/venv/venv1/Lib/site-packages/win32comext/taskscheduler/test/test_addtas
 py2docfx/venv/venv1/Lib/site-packages/win32comext/taskscheduler/test/test_localsystem.py,sha256=08ojAS48W6RLsUbRD45j0SJhg_Y2NFHZT6qjT4Vrig0,75
 py2docfx/venv/venv1/Scripts/pywin32_postinstall.py,sha256=mx4WVp1hD_8xgkSXttNtto1BVDECZOc3FCClrR1SjFM,25736
 py2docfx/venv/venv1/Scripts/pywin32_testall.py,sha256=hyGLMKILn3_W0q-McP1VJnNFW_z5yk_gesTMQDlUocM,3847
-py2docfx-0.1.15.dev2025178.dist-info/METADATA,sha256=D7CgqnEa-FAMgSBmDMkm-B5bCCKQ7Vw4hWWml2JZVwQ,550
-py2docfx-0.1.15.dev2025178.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-py2docfx-0.1.15.dev2025178.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.15.dev2025178.dist-info/RECORD,,
+py2docfx-0.1.15.dev2025736.dist-info/METADATA,sha256=opT_4AXLSQGPyL_bUDPAbfDDmWTi6K7oy9scD6AbLT4,550
+py2docfx-0.1.15.dev2025736.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+py2docfx-0.1.15.dev2025736.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.15.dev2025736.dist-info/RECORD,,