py2docfx 0.1.1.dev1621229__py3-none-any.whl → 0.1.1.dev1621518__py3-none-any.whl

py2docfx/docfx_yaml/build_finished.py

@@ -93,14 +93,6 @@ def build_finished(app, exception):
         app.builder.outdir,  # Output Directory for Builder
         API_ROOT
     ))
-
-    def add_isrequired_if_needed(obj, key: str):
-        if key in obj['syntax'] and obj['type'] in ['class', 'function', 'method']:
-            for args in obj['syntax'][key]:
-                if 'isRequired' not in args and 'defaultValue' not in args:
-                    args['isRequired'] = True
-    
-
     ensuredir(normalized_outdir)
 
     toc_yaml = []
@@ -139,7 +131,6 @@ def build_finished(app, exception):
                     if 'syntax' not in obj:
                         obj['syntax'] = {}
                     merged_params = []
-                    merged_kwargs = []
                     if 'parameters' in app.env.docfx_info_field_data[obj['uid']]:
                         doc_params = app.env.docfx_info_field_data[obj['uid']].get(
                             'parameters', [])
@@ -148,29 +139,16 @@ def build_finished(app, exception):
                                 print("Documented params don't match size of params:"" {}".format(obj['uid']))   # lgtm [py/clear-text-logging-sensitive-data]
                             doc_params = remove_params_without_id(doc_params)
                             merged_params = merge_params(arg_params, doc_params)
-                    else:
-                        merged_params = arg_params
-
-                    if 'keywordOnlyArguments' in app.env.docfx_info_field_data[obj['uid']]:
-                        kwargs_from_inspect = obj.get('syntax', {}).get('keywordOnlyArguments', [])
-                        kwargs_from_doc = app.env.docfx_info_field_data[obj['uid']].get('keywordOnlyArguments', [])
-                        if kwargs_from_inspect and kwargs_from_doc:
-                            merged_kwargs = merge_params(kwargs_from_inspect, kwargs_from_doc)
 
                     obj['syntax'].update(
                         app.env.docfx_info_field_data[obj['uid']])
-
-                    # Merging parameters and keywordOnlyArguments is required,
-                    # becasue parameters and keywordOnlyArguments can be in both signature and docstring
-                    # For positionalOnlyArguments, it's not required, because it's only in signature so far
                     if merged_params:
                         obj['syntax']['parameters'] = merged_params
-                    if merged_kwargs:
-                        obj['syntax']['keywordOnlyArguments'] = merged_kwargs
 
-                    add_isrequired_if_needed(obj, 'parameters')
-                    add_isrequired_if_needed(obj, 'keywordOnlyArguments')
-                    add_isrequired_if_needed(obj, 'positionalOnlyArguments')
+                    if 'parameters' in obj['syntax'] and obj['type'] == 'method':
+                        for args in obj['syntax']['parameters']:
+                            if 'isRequired' not in args and 'defaultValue' not in args:
+                                args['isRequired'] = True
 
                     # Raise up summary
                     if 'summary' in obj['syntax'] and obj['syntax']['summary']:

py2docfx/docfx_yaml/common.py

@@ -97,9 +97,7 @@ def convert_member(obj, reference_mapping):
             'name': obj.get('fullName', '').split('.')[-1],
             'summary': obj.get('summary', None),
             'signature': obj.get('syntax', {}).get('content', None),
-            'positionalOnlyArguments': list(map(convert_parameter_partial, obj.get('syntax', {}).get('positionalOnlyArguments', []))),
             'parameters': list(map(convert_parameter_partial, obj.get('syntax', {}).get('parameters', []))),
-            'keywordOnlyArguments': list(map(convert_parameter_partial, obj.get('syntax', {}).get('keywordOnlyArguments', []))),
             'return': convert_return(obj.get('syntax', {}).get('return', {}), reference_mapping),
             'exceptions': obj.get('exceptions', None),
             'examples': obj.get('example', None),
@@ -169,9 +167,7 @@ def get_constructor_and_variables(syntax_object, reference_mapping):
     if syntax_object:
         constructor_object = {
             'syntax': syntax_object.get('content', None),
-            'positionalOnlyArguments': list(map(convert_parameter_partial, syntax_object.get('positionalOnlyArguments', []))),
-            'parameters': list(map(convert_parameter_partial, syntax_object.get('parameters', []))),
-            'keywordOnlyArguments': list(map(convert_parameter_partial, syntax_object.get('keywordOnlyArguments', []))),
+            'parameters': list(map(convert_parameter_partial, syntax_object.get('parameters', [])))
         }
 
         return remove_empty_values(constructor_object), list(map(convert_variable_partial, syntax_object.get('variables', [])))

py2docfx/docfx_yaml/process_doctree.py

@@ -110,72 +110,6 @@ def _resolve_reference_in_module_summary(lines):
         new_lines.append(new_line)
     return new_lines
 
-def getParameterArgs(argspec):
-    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
-    return args
-
-def getkeywordOnlyArguments(argspec):
-    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
-    return keyword_only_args
-
-def getpositionalOnlyArguments(signature):
-    positional_only_args = []
-    # check if there is positional only args
-    positional_only_arg_list = [param
-            for param in signature.parameters.values()
-            if param.kind == param.POSITIONAL_ONLY]
-    if positional_only_arg_list:
-        count = 0
-        for po_arg in positional_only_arg_list:
-            if po_arg.name != 'self':
-                positional_only_args.append({'id': po_arg.name})
-
-                try:
-                    default_value = str(po_arg.default)
-                except KeyError:
-                    # if the default value is not available, set it to inspect._empty
-                    default_value = "<class 'inspect._empty'>"
-                
-                if default_value != "<class 'inspect._empty'>":
-                    positional_only_args[count]['defaultValue'] = default_value
-                
-                count += 1
-    return positional_only_args
-
-def removePositonalOnlyArgsFromArgs(args, positional_only_args):
-    # Create a set of ids from positional_only_args for efficient lookup
-    positional_only_args_ids = set(obj['id'] for obj in positional_only_args)
-
-    # Filter out objects from args array whose id is in the set of positional_only_args_ids
-    filtered_a = [obj for obj in args if obj['id'] not in positional_only_args_ids]
-
-    return filtered_a
 
 def _create_datam(app, cls, module, name, _type, obj, lines=None):
     """
@@ -186,23 +120,26 @@ def _create_datam(app, cls, module, name, _type, obj, lines=None):
         lines = []
     short_name = name.split('.')[-1]
     args = []
-    keyword_only_args = []
-    positional_only_args = []
+
     try:
         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 = getkeywordOnlyArguments(argspec)
-                positional_only_args = getpositionalOnlyArguments(signature)
-
-                # The args will contian both regular args and positional only args
-                # so we need to remove the positional only args from args
-                if positional_only_args:
-                    args = removePositonalOnlyArgsFromArgs(args, positional_only_args)
-
+            if not (_type  == CLASS and isinstance(type(obj).__call__, type(EnumMeta.__call__))):                             
+                argspec = inspect.getfullargspec(obj)  # noqa
+                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
     except Exception as e:
         print("Can't get argspec for {}: {}. Exception: {}".format(type(obj), name, e))
 
@@ -223,14 +160,9 @@ def _create_datam(app, cls, module, name, _type, obj, lines=None):
         if summary:
             datam['summary'] = summary.strip(" \n\r\r")
 
-    if args or keyword_only_args or positional_only_args:
+    if args:
         datam['syntax'] = {}
-        if args:
-            datam['syntax']['parameters'] = args
-        if keyword_only_args:
-            datam['syntax']['keywordOnlyArguments'] = keyword_only_args
-        if positional_only_args:
-            datam['syntax']['positionalOnlyArguments'] = positional_only_args
+        datam['syntax']['parameters'] = args
     if cls:
         datam[CLASS] = cls
     if _type in [CLASS, MODULE, PACKAGE]:

py2docfx/docfx_yaml/translator.py

@@ -123,7 +123,6 @@ def translator(app, docname, doctree):
     def _get_full_data(node, module_name):
         data = {
             'parameters': [],
-            'keywordOnlyArguments': [],
             'variables': [],
             'exceptions': [],
             'return': {},
@@ -166,20 +165,16 @@ def translator(app, docname, doctree):
                 if _is_single_paragraph(fieldbody):
                     #_data = parse_parameter(ret_data, fieldtype)
                     _data = parameter_utils.parse_parameter(content[0], fieldtype, app)
-                    if fieldtype == 'Parameters':
+                    if fieldtype in ['Parameters', 'Keyword']:
                         data['parameters'].append(_data)
-                    elif fieldtype == 'Keyword':
-                        data['keywordOnlyArguments'].append(_data)
                     else:
                         _data['id'] = _parse_variable_id(content[0].astext())
                         data['variables'].append(_data)
                 else:
                     for child in content[0]:
                         _data = parameter_utils.parse_parameter(child[0], fieldtype, app)
-                        if fieldtype in ['Parameters']:
+                        if fieldtype in ['Parameters', 'Keyword']:
                             data['parameters'].append(_data)
-                        elif fieldtype == 'Keyword':
-                            data['keywordOnlyArguments'].append(_data)
                         else:
                             _data['id'] = _parse_variable_id(child.astext())
                             data['variables'].append(_data)
@@ -376,9 +371,6 @@ def translator(app, docname, doctree):
                 if 'parameters' in current_data and 'parameters' in field_list_data:
                     current_data['parameters'].extend(field_list_data['parameters'])
                     field_list_data.pop('parameters')
-                if 'keywordOnlyArguments' in current_data and 'keywordOnlyArguments' in field_list_data:
-                    current_data['keywordOnlyArguments'].extend(field_list_data['keywordOnlyArguments'])
-                    field_list_data.pop('keywordOnlyArguments')
                 if 'variables' in current_data and 'variables' in field_list_data:
                     current_data['variables'].extend(field_list_data['variables'])
                     field_list_data.pop('variables')

{py2docfx-0.1.1.dev1621229.dist-info → py2docfx-0.1.1.dev1621518.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.1.dev1621229
+Version: 0.1.1.dev1621518
 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.1.dev1621229.dist-info → py2docfx-0.1.1.dev1621518.dist-info}/RECORD

@@ -52,9 +52,9 @@ py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure
 py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_03_31/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_03_31/models.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/docfx_yaml/__init__.py,sha256=KCEizAXv-SXtrYhvFfLHdBWDhz51AA9uagaeTL-Itpo,100
-py2docfx/docfx_yaml/build_finished.py,sha256=qgkKrewCoHltR0Cb05ybsHTNkXL832d0G-IqSqnoKRY,15243
+py2docfx/docfx_yaml/build_finished.py,sha256=jf8--IvekegnTs6Qx9H31TlDNZA6E5yPWaInmHH9QbA,13996
 py2docfx/docfx_yaml/build_init.py,sha256=lAw-fnBVQbySfZ7Sut_NpFQUjnqLOmnGQrTBBH2RXcg,1860
-py2docfx/docfx_yaml/common.py,sha256=tk2dVLtj1v0HKI_vDXaB_1_2_PTNblHPM1_M8-lIfGQ,6833
+py2docfx/docfx_yaml/common.py,sha256=Tl6OPSIcvPjFw1AvWt5Mun8pQr9NtUGQnk4zh474Py0,6316
 py2docfx/docfx_yaml/convert_class.py,sha256=boKDaxnXbnLxja62UFXi3eChGDB_WBW6ouUUJgOhdpE,2098
 py2docfx/docfx_yaml/convert_enum.py,sha256=Kyx48WRl-48O7uv4s-Np1oD9uAd3AXL5uHb7jUsnfFg,2022
 py2docfx/docfx_yaml/convert_module.py,sha256=8UVjPn4krVfu7CgETAEBesYZyLdPthVXg7MXknni6aQ,2088
@@ -63,16 +63,15 @@ py2docfx/docfx_yaml/directives.py,sha256=zVVuNM_6AU9G6sbqL1UAyHHgPe7bkBWbthXI-PO
 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=vCol5q2SJd1ymuyJdE_-62Tau9RP7PewQdKSimcfQuo,8700
-py2docfx/docfx_yaml/process_doctree.py,sha256=cOI_viU46LqDDgy32D_-r1HF1KBnQW10cbbh3O4CMgk,17615
+py2docfx/docfx_yaml/process_doctree.py,sha256=iKs1fsyo-1_P3RzpZBzD8G9hcOTGO78esWNZLXvSx2g,14866
 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=XJJ8MuGMyqUia4tRwMONP0KY7oE5E2cH9YNP4r2ox2M,25904
+py2docfx/docfx_yaml/translator.py,sha256=kJwGiXkiJgK3HPcVNX4qmt2Xwd77_DXS9Vd7LyGCFZo,25366
 py2docfx/docfx_yaml/utils.py,sha256=m5jC_qP2NKqzUx_z0zgZ-HAmxQdNTpJYKkL_F9vGeII,1555
 py2docfx/docfx_yaml/writer.py,sha256=0ZqyVGDHa4Cr3NsuOPRf4pGUStl6g6IBxpSgIZeDT9I,34683
 py2docfx/docfx_yaml/yaml_builder.py,sha256=qSxXVS4iFCc1ZdL5QzLrv8hy3LHIQCrhO4WcTp01vag,2575
 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_method_arguments.py,sha256=BWqRNmebchH_XHDhSPPUc5Gn-TIJlQ3w_vuavXAziUY,1566
 py2docfx/docfx_yaml/tests/test_numpy_syntax.py,sha256=ssb3J_-Jzjybhh4eycCA_LkXbGflyZyIUAiTjlEYLiw,863
 py2docfx/docfx_yaml/tests/test_translator_attributes.py,sha256=qZCsQGffq31k3UzpXkJpycplOXIq9gi2SxY6vu0DTfw,5224
 py2docfx/docfx_yaml/tests/test_translator_contents.py,sha256=lVCWbBIQk2oPFqsKK9gIb-b5DixutMabWjP7x03oj4s,1746
@@ -84,8 +83,6 @@ py2docfx/docfx_yaml/tests/test_translator_rst_returns.py,sha256=BL3nOMMTPzNPJk-P
 py2docfx/docfx_yaml/tests/test_translator_signatures.py,sha256=DM51EOb4UXLkrO1-4cQQQvvX210goAsnxKJH-4A2U2Q,1537
 py2docfx/docfx_yaml/tests/test_writer_table.py,sha256=UnGYXQ-QVxin_e-HGZAHdg1LSFV0qc480ZNsqPN9OYc,1444
 py2docfx/docfx_yaml/tests/test_writer_uri.py,sha256=L9eFHZndD6H7nkznJ9Bw0v8xh9IegDlhhGFHBz9EHmM,1745
-py2docfx/docfx_yaml/tests/roots/test-method-arguments/code_with_all_arg_types.py,sha256=o-ijRie5aHcBGWXW8HP92-457IOjnkl8IZAO_xuMn14,320
-py2docfx/docfx_yaml/tests/roots/test-method-arguments/conf.py,sha256=L8vIFmO546PCQks50Gif_uTBwC3cppohXrQaogfyRF8,410
 py2docfx/docfx_yaml/tests/roots/test-numpy-syntax/code_with_numpy.py,sha256=-7ZN5VPVQfj0-jwPZW_jkIe78B17j5cbXA4f2ZgQIFc,219
 py2docfx/docfx_yaml/tests/roots/test-numpy-syntax/conf.py,sha256=SczEhbCZ_zuTYW1ZyrB2VJ4FRh6B-q58SN7ZZ5INCeM,394
 py2docfx/docfx_yaml/tests/roots/test-translator-attributes/code_with_docstring.py,sha256=5JDlpC9Pm-8Bob2Qvqq58Nudk4n26nhHdOiNULrSXeY,326
@@ -115,7 +112,7 @@ py2docfx/docfx_yaml/tests/roots/test-writer-table/conf.py,sha256=avcbnIOV2mlGQwh
 py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py,sha256=bzWTZpY2yf_By2bOSl1GFaY3BsZpkAvwQuGztlcHKkQ,537
 py2docfx/docfx_yaml/tests/roots/test-writer-uri/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
 py2docfx/docfx_yaml/tests/utils/test_utils.py,sha256=d0OYSUQ6NyoZx5mlLdNGGNhiNmmQhjVT4hQ6jY3VE_M,3383
-py2docfx-0.1.1.dev1621229.dist-info/METADATA,sha256=w73TIXU0po8mXnpsmDFoT-h91D8YbtwLhr2lLUDupzY,601
-py2docfx-0.1.1.dev1621229.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-py2docfx-0.1.1.dev1621229.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.1.dev1621229.dist-info/RECORD,,
+py2docfx-0.1.1.dev1621518.dist-info/METADATA,sha256=ZI1UYOi4HcUthiEJQtLgnY9kLvTngJ_uO68Ca0xsy08,601
+py2docfx-0.1.1.dev1621518.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+py2docfx-0.1.1.dev1621518.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.1.dev1621518.dist-info/RECORD,,

py2docfx/docfx_yaml/tests/roots/test-method-arguments/code_with_all_arg_types.py

@@ -1,10 +0,0 @@
-class TestClass:
-    def test_method(self,
-                    positional_only_arg = 10,
-                    /,
-                    parameter_with_default_value=True,
-                    *,
-                    keyword_only_arg = "keyword_only_arg_default_value",
-                    **kwargs):
-        pass
-    

py2docfx/docfx_yaml/tests/roots/test-method-arguments/conf.py

@@ -1,24 +0,0 @@
-import os
-import sys
-
-sys.path.insert(0, os.path.abspath('.'))
-
-extensions = ["sphinx.ext.autodoc","sphinx.ext.napoleon", "yaml_builder"]
-
-class includeTest:
-    pass
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-autodoc_mock_imports = [
-    'dummy'
-]
-
-pygments_style = 'sphinx'
-
-napoleon_use_admonition_for_examples = True
-
-nitpicky = True
-
-napoleon_preprocess_types=True

py2docfx/docfx_yaml/tests/test_method_arguments.py

@@ -1,35 +0,0 @@
-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,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)
-    keywordOnlyArguments = argumentsDetail.get('keywordOnlyArguments', None)
-    positionalOnlyArguments = argumentsDetail.get('positionalOnlyArguments', None)
-    assert (parameters != None)
-    assert (keywordOnlyArguments != None)
-    assert (positionalOnlyArguments != None)
-    assert (parameters[1]['id'] == 'parameter_with_default_value')
-    assert (parameters[1]['defaultValue'] == 'True')
-    assert (keywordOnlyArguments[0]['id'] == 'keyword_only_arg')
-    assert (keywordOnlyArguments[0]['defaultValue'] == 'keyword_only_arg_default_value')
-    assert (positionalOnlyArguments[0]['id'] == 'positional_only_arg')
-    assert (positionalOnlyArguments[0]['defaultValue'] == '10')