py2docfx 0.1.1.dev1592393__py3-none-any.whl → 0.1.1.dev1602141__py3-none-any.whl

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,35 @@
+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_numpy_style_default(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')

py2docfx/docfx_yaml/translator.py

@@ -376,6 +376,9 @@ 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.dev1592393.dist-info → py2docfx-0.1.1.dev1602141.dist-info}/METADATA

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

@@ -66,12 +66,13 @@ py2docfx/docfx_yaml/parameter_utils.py,sha256=vCol5q2SJd1ymuyJdE_-62Tau9RP7PewQd
 py2docfx/docfx_yaml/process_doctree.py,sha256=sI3Hs-fpC8IE9kQldcrVlw4lALQgOOv0KT9Ht5BneeQ,17170
 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=Lfybbd28xflbq_CBH-8vCc3PkMNtoPPQJyKbPm_ywHs,25627
+py2docfx/docfx_yaml/translator.py,sha256=XJJ8MuGMyqUia4tRwMONP0KY7oE5E2cH9YNP4r2ox2M,25904
 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=0_D8rL4uhMnROU41oYnCaRpX1lqeQ9aebi4E8PD17d4,1550
 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
@@ -83,6 +84,8 @@ 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
@@ -112,7 +115,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.dev1592393.dist-info/METADATA,sha256=eciH7tuSk2d-cW9xPD3UrgWvKvOSC-lywQy1I4wICSE,601
-py2docfx-0.1.1.dev1592393.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-py2docfx-0.1.1.dev1592393.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.1.dev1592393.dist-info/RECORD,,
+py2docfx-0.1.1.dev1602141.dist-info/METADATA,sha256=o_QVJO824H-qP7TCUW7mNQl4hQsk5Vmwe26SaDuPVDk,601
+py2docfx-0.1.1.dev1602141.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+py2docfx-0.1.1.dev1602141.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.1.dev1602141.dist-info/RECORD,,