py2docfx 0.1.0.dev1524902__py3-none-any.whl → 0.1.0.dev1529344__py3-none-any.whl

py2docfx/convert_prepare/git.py

@@ -50,7 +50,7 @@ def clone(repo_location, branch, folder, extra_token=None):
                     branch,
                 ]
                 if extra_token:
-                    check_params[1:1] = [
+                    clone_params[1:1] = [
                         "-c",
                         "http.extraHeader='Authorization: Basic {}'".format(
                             extra_token

py2docfx/docfx_yaml/parameter_utils.py

@@ -7,30 +7,6 @@ from inspect import isclass
 TYPE_SEP_PATTERN = '(\[|\]|, |\(|\))'
 PARAMETER_NAME = "[*][*](.*?)[*][*]"
 PARAMETER_TYPE = "[(]((?:.|\n)*)[)]"
-SYSTEM_TYPE = "system type"
-TYPING_TYPE = "typing type"
-SUPPLEMENT_TYPE = "supplement type"
-
-def get_builtin_type_dict():
-    system_type_list = []
-    # loop through the attributes of the builtins module to get builtin types list
-    for attr in dir(builtins):
-        value = getattr(builtins, attr)
-        if isinstance(value, type):
-            system_type_list.append(value.__name__)
-
-    # get typing types list
-    typing_type_list = typing.__all__
-
-    type_dict = {}
-    for item in system_type_list:
-        type_dict[item] = SYSTEM_TYPE
-    for item in typing_type_list:
-        type_dict[item] = TYPING_TYPE
-
-    return type_dict
-
-builtin_type_dict = get_builtin_type_dict()
 
 def make_param(_id, _description, _type=None, _default_value=None, _required=None):
     ret = {}

py2docfx/docfx_yaml/translator.py

@@ -6,7 +6,6 @@
 
 import re
 import parameter_utils
-import return_type_utils
 
 from docutils import nodes
 from sphinx import addnodes
@@ -29,8 +28,6 @@ def translator(app, docname, doctree):
 
     transform_node = app.docfx_transform_node
 
-    class_obj_cache = app.env.domains['py'].objects
-
     def _remove_exception_xref_tag(exception_type):
         exception_type = exception_type.replace('<xref:', '')
         exception_type = exception_type.replace('>', '')
@@ -70,7 +67,7 @@ def translator(app, docname, doctree):
 
         uid = '{module}.{full_name}'.format(module=module, full_name=full_name)
         type = node.get('desctype')
-        return (uid, module, type)
+        return (uid, type)
 
     def _is_desc_of_enum_class(content_child):
         assert content_child.tagname == 'desc_content'
@@ -120,7 +117,7 @@ def translator(app, docname, doctree):
                 exception['description'] = exception['description'].strip(" ")
         return extractedExceptions
 
-    def _get_full_data(node, module_name):
+    def _get_full_data(node):
         data = {
             'parameters': [],
             'variables': [],
@@ -157,9 +154,18 @@ def translator(app, docname, doctree):
 
             if fieldtype in ['Return']:
                 for returntype_node in content:
-                    returntype = return_type_utils.get_return_type(class_obj_cache, returntype_node, module_name)
-                    for item in returntype:
-                        data['return'].setdefault('type', []).append(item)
+                    returntype_ret = transform_node(returntype_node)
+                    if returntype_ret:
+                        for returntype in re.split('[ \n]or[ \n]', returntype_ret):
+                            returntype = returntype.strip(" \n\r\t")
+                            _type_without_xref = returntype.replace('<xref:', '')
+                            _type_without_xref = _type_without_xref.replace('>', '')
+                            _type_without_xref, _added_reference = parameter_utils.resolve_type(_type_without_xref)
+                            if _added_reference:
+                                returntype = parameter_utils.resolve_xref_type(_added_reference)
+                            if returntype.find('<xref:') == -1:
+                                returntype = '<xref:' + returntype + '>'
+                            data['return'].setdefault('type', []).append(returntype)
 
             if fieldtype in ['Parameters', 'Variables', 'Keyword']:
                 if _is_single_paragraph(fieldbody):
@@ -215,7 +221,7 @@ def translator(app, docname, doctree):
             raise Exception('First child of attribute node isn\'t content, node: {0}'.format(node.astext()))
         return content_child
 
-    def extract_attribute(node, class_nodes, module_name):
+    def extract_attribute(node, class_nodes):
         def find_ancestor_class_content_node(node_class, node_module, node_ids, class_nodes):
             for class_node in class_nodes:
                 if isinstance(class_node.children[0], desc_signature):
@@ -291,7 +297,7 @@ def translator(app, docname, doctree):
         # if we need to change other attribute generator logic, 
         # better to get from extracted_content_data below too
         
-        extracted_content_data = extract_content(content_child, ATTRIBUTE_TYPE, module_name)
+        extracted_content_data = extract_content(content_child, ATTRIBUTE_TYPE)
         if not addedData:
             # If current attribute doesn't have correct signature child, fill in basic information
             # TODO: append fullName here, currently when fallback to here, 
@@ -362,7 +368,7 @@ def translator(app, docname, doctree):
                 signature += '()'
         return signature
 
-    def extract_content(node, api_type, module_name):
+    def extract_content(node, api_type):
         def merge_field_list_data(api_type, current_data, field_list_data):
             # If node is a class node and autoclass=both, class docstring params are first, __init__ docstring params come second.
             # If class hasn't init, the second param list will come from inherit base class
@@ -384,7 +390,7 @@ def translator(app, docname, doctree):
                 remarks_string = transform_node(child)
                 data['remarks'] = remarks_string
             elif isinstance(child, nodes.field_list):
-                merge_field_list_data(api_type, data, _get_full_data(child, module_name))
+                merge_field_list_data(api_type, data, _get_full_data(child))
             elif isinstance(child, addnodes.seealso):
                 data['seealso'] = transform_node(child)
             elif isinstance(child, nodes.admonition) and 'Example' in child[0].astext():
@@ -430,8 +436,8 @@ def translator(app, docname, doctree):
     class_nodes = extract_class_nodes_from_doctree(doctree)
     class_added_attributes = {}
     class_data = {}
-    for node in doctree.traverse(addnodes.desc):   
-        (uid, module_name, node_type) = _get_uid_and_type_from_desc(node)
+    for node in doctree.traverse(addnodes.desc):     
+        (uid, node_type) = _get_uid_and_type_from_desc(node)
         data = {}
         signature_child = node.children[node.first_child_matching_class(addnodes.desc_signature)]
         content_child = node.children[node.first_child_matching_class(addnodes.desc_content)]
@@ -447,7 +453,7 @@ def translator(app, docname, doctree):
                 attribute_class = attribute_sig_child['module'] + '.' + attribute_sig_child['class']
                 class_added_attributes.setdefault(attribute_class, OrderedDict())
                 # TODO: Merge attribute_data if same uid
-                attribute_data = extract_attribute(node, class_nodes, module_name)
+                attribute_data = extract_attribute(node, class_nodes)
 
                 #Check if attribute information is already added
                 if attribute_data['uid'] in class_added_attributes[attribute_class].keys():
@@ -463,7 +469,7 @@ def translator(app, docname, doctree):
                 raise Exception('Attribute doesn\'t have class information. Attribute_name: {0}'.format(attribute_sig_child['fullname']))
             continue
         
-        data.update(extract_content(content_child, node_type, module_name))
+        data.update(extract_content(content_child, node_type))
         data['content'] = extract_signature(signature_child)
 
         data['type'] = type_mapping(node_type) if node_type else 'unknown'

{py2docfx-0.1.0.dev1524902.dist-info → py2docfx-0.1.0.dev1529344.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.0.dev1524902
+Version: 0.1.0.dev1529344
 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.0.dev1524902.dist-info → py2docfx-0.1.0.dev1529344.dist-info}/RECORD

@@ -5,7 +5,7 @@ py2docfx/convert_prepare/environment.py,sha256=AwS4c4OSwVdxlExBLVo310HrVhFMhWQ2W
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
 py2docfx/convert_prepare/generate_document.py,sha256=sppAAAgpZVtsXvO5M5EEOR39JeRyJk5ie3Kh9z27PrA,2350
 py2docfx/convert_prepare/get_source.py,sha256=1XOdFABdzhmSld8-w72gaOQv8_xaUX7_VnFiSmvh3cc,4592
-py2docfx/convert_prepare/git.py,sha256=fY9urQQp5aMnlGnFrSvTTR0FPnIc-28b50W1NzIPpaw,5640
+py2docfx/convert_prepare/git.py,sha256=t79gy_XyC3dwWbCi-YpZOQWwCbrim46yHL_-Z_Og38w,5640
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
 py2docfx/convert_prepare/pack.py,sha256=vZS67_GzEhUmZWHU1dxm8gnWyRBs-kB6-KjX1d_FdOU,1260
 py2docfx/convert_prepare/package_info.py,sha256=RCN3enfwXeU_9H8xBHLalvbhUrGxMtmlX0F9omGoPjU,6856
@@ -62,11 +62,10 @@ py2docfx/docfx_yaml/convert_package.py,sha256=R8dTHQXjoztHQ3bkBBchPx0k179IVr_e71
 py2docfx/docfx_yaml/directives.py,sha256=zVVuNM_6AU9G6sbqL1UAyHHgPe7bkBWbthXI-PO5ez0,879
 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=JApPeLfwkpXZ3qJO3vh52rJtBHjWAb27_pYAb2Z3j-0,8737
+py2docfx/docfx_yaml/parameter_utils.py,sha256=jj1TE-SbZt5KS-8WMzqysfXGDFX-WnSZOT3Ia_2dklQ,8025
 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=kJwGiXkiJgK3HPcVNX4qmt2Xwd77_DXS9Vd7LyGCFZo,25366
+py2docfx/docfx_yaml/translator.py,sha256=k5D80ulmgm3QB-aLfk7dbeeO1iYxxhBkVJn8-cafMzg,25863
 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
@@ -78,8 +77,6 @@ py2docfx/docfx_yaml/tests/test_translator_contents.py,sha256=lVCWbBIQk2oPFqsKK9g
 py2docfx/docfx_yaml/tests/test_translator_data.py,sha256=zSVs3AT_TeAx1mrEYNTpy3Xy-FPrwwi93ly2EFclw5U,984
 py2docfx/docfx_yaml/tests/test_translator_exceptions.py,sha256=A2zAcJOBGchDBNIDr15uD3lzLfVldJKYSAl0e1CD5Ds,10481
 py2docfx/docfx_yaml/tests/test_translator_fieldlists.py,sha256=tDJ1l0c16oYfAlEIcidqEMwaXcX83Fg-rajpLtb2Wnk,1198
-py2docfx/docfx_yaml/tests/test_translator_numpy_returns.py,sha256=nmC70WUqCRcB1tkRG9iq8mBuIcZKwGhK09StEvq0zf8,2970
-py2docfx/docfx_yaml/tests/test_translator_rst_returns.py,sha256=BL3nOMMTPzNPJk-P9oMANiXnJ7ocuiecbFHH4DU1n40,2942
 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
@@ -100,10 +97,6 @@ py2docfx/docfx_yaml/tests/roots/test-translator-exceptions/conf.py,sha256=avcbnI
 py2docfx/docfx_yaml/tests/roots/test-translator-exceptions/refered_objects.py,sha256=zTnP-R7nxTxZr2yHurKKQSPFSY9gz3_vmFI0OotI3_U,124
 py2docfx/docfx_yaml/tests/roots/test-translator-fieldlists/code_with_multiple_fieldlists.py,sha256=llu95FRqwjtwrMdR1enMB1Lso59CYJBmUPQy6LvGGAA,502
 py2docfx/docfx_yaml/tests/roots/test-translator-fieldlists/conf.py,sha256=KrvMHOj1LCdodwNwUsdCI_OMM-Bf_lpiUREk4egQWms,388
-py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_numpy.py,sha256=OGHOCBmRENAp4_MLYgyUsU2z7cm_hQx6Jtb8PSIs1Uo,748
-py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_rst.py,sha256=sQ1gV9lN33NjXFetGrUNLD6qCJF9v7BMYBQnDLa2Kdo,644
-py2docfx/docfx_yaml/tests/roots/test-translator-returns/conf.py,sha256=A-QZx8-7Zg3_6X42F3LSyG5Nx0AoYkbKB2QbnM33PB0,402
-py2docfx/docfx_yaml/tests/roots/test-translator-returns/refered_objects.py,sha256=IBbbX_O91I9SSZvM0Tw7UQDk3EosMbl_91R932swp4U,53
 py2docfx/docfx_yaml/tests/roots/test-translator-signatures/code_with_docstring.py,sha256=ZHqPbmGiTBy_y852lQzKYaRlxGATM-OfPVmjAvLcP_E,471
 py2docfx/docfx_yaml/tests/roots/test-translator-signatures/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
 py2docfx/docfx_yaml/tests/roots/test-translator-signatures/refered_objects.py,sha256=DJaX52mnHw9W3GSqKh75CYK87g4CczXNNjFO496Ai2U,79
@@ -112,7 +105,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.0.dev1524902.dist-info/METADATA,sha256=mFsJzeDpiD4Y66Xkj4lTDuAw4N2KPyM6vlm_L3klQ2c,601
-py2docfx-0.1.0.dev1524902.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-py2docfx-0.1.0.dev1524902.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.0.dev1524902.dist-info/RECORD,,
+py2docfx-0.1.0.dev1529344.dist-info/METADATA,sha256=2Z3RFLMpfABFhOX-8ipH78fSpyWZ6J9b1VlbYlDGSYw,601
+py2docfx-0.1.0.dev1529344.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+py2docfx-0.1.0.dev1529344.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.0.dev1529344.dist-info/RECORD,,

py2docfx/docfx_yaml/return_type_utils.py

@@ -1,165 +0,0 @@
-import sys
-import parameter_utils
-
-def split_by(symbol, text):
-    return [item.strip() for item in text.split(symbol)]
-
-def is_part_of_name(character) -> bool:
-    # an upper or lower case letter and an underscore would be a valid type name
-    return character.isalpha() or character.isnumeric() or character == '_' or character == '.'
-
-def endswith_mathching(class_obj_cache, type_name, refuri):
-
-    matches = [item for item in class_obj_cache if item.endswith('.' + type_name)]
-
-    # if there is no match, return the refuri if it ends with type_name
-    if len(matches) == 0:
-        if refuri.endswith("." + type_name):
-            return refuri
-        else:
-            return type_name
-
-    # if there is only one match, return the match
-    if len(matches) == 1:
-        return matches[0]
-
-    # if there are multiple matches, get a list of canonicals, return the first one
-    if len(matches) > 1:
-        canonicals = [m for m in matches if not class_obj_cache[m].aliased]
-        return canonicals[0]
-
-def full_text_matching(match_string, class_obj_cache, type_dict):
-    # check for class_obj_cache first, because we want user defined type to be prioritized
-    if match_string in class_obj_cache:
-        return f'<xref:{match_string}>'
-    if match_string in type_dict:
-        if type_dict[match_string] == parameter_utils.TYPING_TYPE:
-            return f'<xref:typing.{match_string}>'
-        else:
-            return f'<xref:{match_string}>'
-    return None
-
-def proceed_type_name(class_obj_cache, type_name, module_name, refuri):
-    """
-    Priority Ranking:
-    1. refuri full text matching
-    2. refuri sys.modules matching
-    3. type name full text matching
-    4. module name + type name full text matching
-    5. type name endswith matching
-
-    The reason why we always want to use refuri to be top priority is because
-    refuri will mostly have more information.
-    For example, ~some_module.SomeClass
-    Refuri will be some_module.SomeClass, while type name will only be SomeClass
-
-    Sometimes, there will be empty refuri or error refuri, in that case, we will 1 and 2 would find no match
-    and type name matching would be the fallback option.
-    For example, in numpy style docstring
-    Refuri could be some_module.SomeClass.Any]] and type name is Any
-
-    4, module name + type name full text matching, is a reasonalbe guess that the user is trying to reference
-    a type that is user defined in the same module, but the user did not use the full name.
-
-    If all 1 to 4 fails, we will use endswith matching as the final fallback option.
-    """
-
-    if type_name in ["", "or"]:
-        return type_name
-
-    # if # in refuri, it means that sphinx has resolved the type name
-    # take the part after # as the type name
-    if len(refuri.split('#')) > 1:
-        type_name = refuri.split('#')[-1]
-        return f'<xref:{type_name}>'
-
-    type_dict = parameter_utils.builtin_type_dict
-
-    # try get the match using refuri
-    refuri_matching_result = full_text_matching(refuri, class_obj_cache, type_dict)
-
-    # if the module name of refuri is not the same as module name of the current file
-    # and the module name of refuri can be found in sys.modules (means it is imported in source code)
-    # we can assume that writer was intenionally crossreferencing to another module
-    # return the refuri
-    refuri_module_name = refuri[0:refuri.rfind('.')] if '.' in refuri else None
-    if refuri_module_name:
-        if refuri_module_name != module_name and refuri_module_name in sys.modules:
-            return f'<xref:{refuri}>'
-
-    # try get the match using type name
-    type_name_matching_result = full_text_matching(type_name, class_obj_cache, type_dict)
-
-    # if both type name and refuri have a match, return the one from refuri
-    # because we want user defined type to be prioritized
-    if type_name_matching_result and refuri_matching_result:
-        return refuri_matching_result
-    elif type_name_matching_result:
-        return type_name_matching_result
-    elif refuri_matching_result:
-        return refuri_matching_result
-
-    # try get the match using module name + type name
-    fullname_matching_result = full_text_matching(module_name + "." + type_name, class_obj_cache, type_dict)
-    if fullname_matching_result is not None:
-        return fullname_matching_result
-
-    # try get the match using endswith matching mode
-    endwith_matching_result = endswith_mathching(class_obj_cache, type_name, refuri)
-    if endwith_matching_result is not None:
-        return f'<xref:{endwith_matching_result}>'
-
-    return f'<xref:{type_name}>'
-
-def proceed_return_type(class_obj_cache, return_node, module_name):
-    node_text = return_node.astext()
-    symbol_index_list = [] # symbols are "[" and "]" etc.
-    
-    # record the full reference name from sphinx
-    # primirily from refuri, some nodes do not have refuri but have reftarget instead
-    # if there is no refuri or reftarget, leave resolved_type_from_sphinx to be an empty string
-    resolved_type_from_sphinx = ""
-    if return_node.tagname == 'reference':
-        if "reftarget" in return_node.attributes:
-            resolved_type_from_sphinx = return_node.attributes["reftarget"]
-        elif "refid" in return_node.attributes:
-            resolved_type_from_sphinx = return_node.attributes["refid"]
-        elif "refuri" in return_node.attributes:
-            resolved_type_from_sphinx = return_node.attributes["refuri"]
-
-    # find all the symbols in the node text
-    for i, character in enumerate(node_text):
-        if not is_part_of_name(character):
-            symbol_index_list.append(i)
-
-    # if there is just one symbol or empty in the node text, return the node text
-    if node_text.strip() in ["[", "]", "(", ")", ",", "", "or"]:
-        return node_text
-
-    # if there is no symbol in the node text, which means it is a simple type name
-    # return proceeded type name
-    if len(symbol_index_list) == 0:
-        return proceed_type_name(class_obj_cache, node_text, module_name, resolved_type_from_sphinx)
-
-    # if there is a symbol in the node text, which means it is a complex type name
-    # use index list to split the node text into several parts and proceed each part
-    type_name = ""
-    for i,symbol_index in enumerate(symbol_index_list):
-        if i == 0:
-            temp_type_name = proceed_type_name(class_obj_cache, node_text[:symbol_index], module_name, resolved_type_from_sphinx) + node_text[symbol_index]
-        else:
-            temp_type_name = proceed_type_name(class_obj_cache, node_text[symbol_index_list[i-1]+1:symbol_index], module_name, resolved_type_from_sphinx) + node_text[symbol_index]
-        type_name += temp_type_name
-
-    # the last symbol index might not be at the end of the node text srting
-    # so we need to proceed the rest of the node text
-    if symbol_index_list[-1] < len(node_text) - 1:
-        type_name += proceed_type_name(class_obj_cache, node_text[symbol_index_list[-1] + 1:], module_name, resolved_type_from_sphinx)
-
-    return type_name
-
-def get_return_type(class_obj_cache ,return_node, module_name):
-    type_string = ""
-    for child_node in return_node:
-        type_string += proceed_return_type(class_obj_cache, child_node, module_name)
-    return type_string.lstrip("~").replace("\n", " ").split(" or ")

py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_numpy.py

@@ -1,37 +0,0 @@
-from refered_objects import referee
-from refered_objects import List
-from collections.abc import MutableMapping
-
-class dummyClass():
-
-    def complex_type(self):
-        """
-        Returns
-        -------
-        Any[Dict[str, Any]]
-        """
-        pass
-
-    def user_designated_builtin_type(self):
-        """
-        Returns
-        -------
-        ~collections.abc.MutableMapping
-        """
-        pass
-
-    def user_defined_type_with_same_name_as_builtin_type(self):
-        """
-        Returns
-        -------
-        ~refered_objects.List
-        """
-        pass
-
-    def user_defined_type(self):
-        """
-        Returns
-        -------
-        ~refered_objects.referee
-        """
-        pass

py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_rst.py

@@ -1,29 +0,0 @@
-from refered_objects import referee
-from refered_objects import List
-from collections.abc import MutableMapping
-
-class dummyClass():
-
-    def complex_type(self):
-        """
-        :rtype: Any[Dict[str, Any]]
-        """
-        pass
-
-    def user_designated_builtin_type(self):
-        """
-        :rtype: ~collections.abc.MutableMapping
-        """
-        pass
-
-    def user_defined_type_with_same_name_as_builtin_type(self):
-        """
-        :rtype: ~refered_objects.List
-        """
-        pass
-
-    def user_defined_type(self):
-        """
-        :rtype: ~refered_objects.referee
-        """
-        pass

py2docfx/docfx_yaml/tests/roots/test-translator-returns/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'
-]
-
-nitpicky = True
-
-autodoc_default_options = {
-    'inherited-members': True
-}
-
-napoleon_preprocess_types = True

py2docfx/docfx_yaml/tests/roots/test-translator-returns/refered_objects.py

@@ -1,5 +0,0 @@
-class List():
-    pass
-
-class referee():
-    pass

py2docfx/docfx_yaml/tests/test_translator_numpy_returns.py

@@ -1,81 +0,0 @@
-import pytest
-
-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='translator-returns')
-def test_numpy_return_complex_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_numpy.dummyClass.complex_type'
-    objectToGenXmlType = 'function'
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:typing.Any>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]")
-
-@pytest.mark.sphinx('yaml', testroot='translator-returns')
-def test_numpy_return_user_designated_builtin_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_numpy.dummyClass.user_designated_builtin_type'
-    objectToGenXmlType = 'function'
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:collections.abc.MutableMapping>")
-
-@pytest.mark.sphinx('dummy', testroot='translator-returns')
-def test_numpy_return_user_defined_type_with_same_name_as_builtin_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_numpy.dummyClass.user_defined_type_with_same_name_as_builtin_type'
-    objectToGenXmlType = 'function'
-    referedApis = [
-        ('refered_objects.List', 'class')
-    ]   
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    prepare_refered_objects(app, referedApis)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:refered_objects.List>")
-
-@pytest.mark.sphinx('yaml', testroot='translator-returns')
-def test_numpy_return_user_defined_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_numpy.dummyClass.user_defined_type'
-    objectToGenXmlType = 'function'
-    referedApis = [
-        ('refered_objects.List', 'class')
-    ]   
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    prepare_refered_objects(app, referedApis)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:refered_objects.referee>")

py2docfx/docfx_yaml/tests/test_translator_rst_returns.py

@@ -1,81 +0,0 @@
-import pytest
-
-from translator import translator
-
-from .utils.test_utils import prepare_app_envs,prepare_refered_objects,load_rst_transform_to_doctree
-
-@pytest.mark.sphinx('dummy', testroot='translator-returns')
-def test_rst_return_complex_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_rst.dummyClass.complex_type'
-    objectToGenXmlType = 'function'
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:typing.Any>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]")
-
-@pytest.mark.sphinx('yaml', testroot='translator-returns')
-def test_rst_return_user_designated_builtin_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_rst.dummyClass.user_designated_builtin_type'
-    objectToGenXmlType = 'function'
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:collections.abc.MutableMapping>")
-
-@pytest.mark.sphinx('dummy', testroot='translator-returns')
-def test_rst_return_user_defined_type_with_same_name_as_builtin_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_rst.dummyClass.user_defined_type_with_same_name_as_builtin_type'
-    objectToGenXmlType = 'function'
-    referedApis = [
-        ('refered_objects.List', 'class')
-    ]   
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    prepare_refered_objects(app, referedApis)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:refered_objects.List>")
-
-@pytest.mark.sphinx('yaml', testroot='translator-returns')
-def test_rst_return_user_defined_type(app):
-    # Test data definition
-    objectToGenXml = 'code_with_returns_rst.dummyClass.user_defined_type'
-    objectToGenXmlType = 'function'
-    referedApis = [
-        ('refered_objects.List', 'class')
-    ]   
-
-    # Arrange
-    prepare_app_envs(app, objectToGenXml)
-    prepare_refered_objects(app, referedApis)
-    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
-    
-    # Act
-    translator(app, '', doctree)
-
-    # Assert
-    return_type = app.env.docfx_info_field_data[objectToGenXml]['return']['type'][0]
-    assert(return_type == "<xref:refered_objects.referee>")