py2docfx 0.1.9.dev1819899__py3-none-any.whl → 0.1.9.dev1824235__py3-none-any.whl

py2docfx/__main__.py

@@ -217,13 +217,10 @@ def parse_command_line_args(argv) -> (
 
 def install_required_packages(
         required_package_list: list[PackageInfo], github_token: str, ado_token: str):
-    start_time = time.time()
     for idx, package in enumerate(required_package_list):
         if package.install_type == package.InstallType.SOURCE_CODE:
             get_source(package, idx, vststoken=ado_token, githubtoken=github_token)
         install_package(package)
-    end_time = time.time()
-    print(f"<install_required_packages>{end_time-start_time}<install_required_packages/>")
 
 def donwload_package_generate_documents(
         package_info_list: list[PackageInfo],
@@ -254,9 +251,15 @@ def donwload_package_generate_documents(
         print(f"<merge_toc>{package.name},{end_time-start_time}<merge_toc/>")
 
         if output_doc_folder:
+            start_time = time.time()
             package.path.move_document_to_target(os.path.join(output_doc_folder, package.name))
+            end_time = time.time()
+            print(f"<move_document_to_target>{package.name},{end_time-start_time}<move_document_to_target/>")
     if output_doc_folder:
+        start_time = time.time()
         move_root_toc_to_target(YAML_OUTPUT_ROOT, output_doc_folder)
+        end_time = time.time()
+        print(f"<move_root_toc_to_target>{end_time-start_time}<move_root_toc_to_target/>")
 
 def prepare_out_dir(output_root: str | os.PathLike) -> os.PathLike | None:
     # prepare output_root\DOC_FOLDER_NAME (if folder contains files, raise exception)

py2docfx/convert_prepare/generate_document.py

@@ -1,5 +1,6 @@
 from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import os
+import time
 from py2docfx.convert_prepare.generate_conf import generate_conf
 from py2docfx.convert_prepare.git import checkout
 from py2docfx.convert_prepare.package_info import PackageInfo
@@ -9,6 +10,7 @@ from py2docfx.convert_prepare.subpackage import merge_subpackage_files
 CONF_TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "conf_templates")
 
 def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
+    start_time = time.time()
     # Copy manual written RST from target doc repo
     package_paths = pkg.path
     if output_root:
@@ -34,13 +36,20 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
     print("<CI INFO>: Listing RST files:")
     for rst_file in os.listdir(package_paths.doc_folder):
         print(rst_file)
-
     print("<CI INFO>: Running Sphinx build...")
+    end_time = time.time()
+    print(f"<pre_generate_conf>{pkg.name},{end_time-start_time}<pre_generate_conf/>")
+    start_time = time.time()
     generate_conf(pkg, package_paths.doc_folder, CONF_TEMPLATE_DIR)
+    end_time = time.time()
+    print(f"<generate_conf>{pkg.name},{end_time-start_time}<generate_conf/>")
+    start_time = time.time()
     run_converter(package_paths.doc_folder, package_paths.yaml_output_folder)
-
+    end_time = time.time()
+    print(f"<run_converter>{pkg.name},{end_time-start_time}<run_converter/>")
     subpackages_path_record = {}
     if pkg.build_in_subpackage:
+        start_time = time.time()
         subpackages_yaml_path = os.path.join(package_paths.yaml_output_folder, "subpackages")
         for (subpackage_name, subpackage_path) in subpackages_rst_record.items():
             subpackage_yaml_path = os.path.join(subpackages_yaml_path, subpackage_name)
@@ -48,3 +57,5 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
             run_converter(subpackage_path, subpackage_yaml_path)
 
         merge_subpackage_files(subpackages_path_record, package_paths.yaml_output_folder, pkg.name)
+        end_time = time.time()
+        print(f"<merge_subpackage_files>{pkg.name},{end_time-start_time}<merge_subpackage_files/>")

py2docfx/convert_prepare/get_source.py

@@ -2,7 +2,7 @@ import os.path as path
 import os
 import subprocess
 import sys
-
+import time
 import py2docfx.convert_prepare.git as git
 import py2docfx.convert_prepare.pip_utils as pip_utils
 import py2docfx.convert_prepare.pack as pack
@@ -75,6 +75,7 @@ def get_source(pkg: PackageInfo, cnt: int, vststoken=None, githubtoken=None):
     dist_dir = path.join("dist_temp", path_cnt)
 
     if pkg.install_type == PackageInfo.InstallType.SOURCE_CODE:
+        start_time = time.time()
         if pkg.url:
             repo_folder = path.join("source_repo", path_cnt)
             token = githubtoken if "github.com" in pkg.url else vststoken
@@ -89,16 +90,20 @@ def get_source(pkg: PackageInfo, cnt: int, vststoken=None, githubtoken=None):
         else:
             source_folder = pkg.folder
             sys.path.insert(0, source_folder)
-
+        end_time = time.time()
+        print(f"<download_source>{pkg.name},{end_time-start_time}<download_source/>")
     elif pkg.install_type == PackageInfo.InstallType.PYPI:
         full_name = pkg.get_combined_name_version()
+        start_time = time.time()
         pip_utils.download(
             full_name,
             dist_dir,
             extra_index_url=pkg.extra_index_url,
             prefer_source_distribution=pkg.prefer_source_distribution,
         )
-
+        end_time = time.time()
+        print(f"<download_pypi>{pkg.name},{end_time-start_time}<download/>")
+        start_time = time.time()
         # unpack the downloaded wheel file.
         downloaded_dist_file = path.join(dist_dir, os.listdir(dist_dir)[0])
         pack.unpack_dist(downloaded_dist_file)
@@ -107,9 +112,15 @@ def get_source(pkg: PackageInfo, cnt: int, vststoken=None, githubtoken=None):
             path.dirname(downloaded_dist_file),
             os.listdir(dist_dir)[0]
         )
+        end_time = time.time()
+        print(f"<unpack_pypi>{pkg.name},{end_time-start_time}<unpack/>")
     elif pkg.install_type == PackageInfo.InstallType.DIST_FILE:
+        start_time = time.time()
         pip_utils.download(pkg.location, dist_dir, prefer_source_distribution=False)
+        end_time = time.time()
+        print(f"<download_dist>{pkg.name},{end_time-start_time}<download/>")
 
+        start_time = time.time()
         # unpack the downloaded dist file.
         downloaded_dist_file = path.join(dist_dir, os.listdir(dist_dir)[0])
         pack.unpack_dist(downloaded_dist_file)
@@ -121,7 +132,12 @@ def get_source(pkg: PackageInfo, cnt: int, vststoken=None, githubtoken=None):
             path.dirname(downloaded_dist_file),
             os.listdir(dist_dir)[0]
         )
+        end_time = time.time()
+        print(f"<unpack_dist>{pkg.name},{end_time-start_time}<unpack/>")
     else:
         raise ValueError(f"Unknown install type: {pkg.install_type}")
 
+    start_time = time.time()
     update_package_info(pkg, source_folder)
+    end_time = time.time()
+    print(f"<update_package_info>{pkg.name},{end_time-start_time}<update/>")

py2docfx/convert_prepare/pip_utils.py

@@ -1,4 +1,5 @@
 import subprocess
+import time
 from py2docfx import PACKAGE_ROOT
 PYPI = "pypi"
 

py2docfx/convert_prepare/sphinx_caller.py

@@ -10,7 +10,7 @@ from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.paths import folder_is_hidden
 from py2docfx.convert_prepare.subpackage import (get_subpackages,
                                         move_rst_files_to_subfolder)
-
+import time
 DEBUG_SPHINX_FLAG = 'PY2DOCFX_DEBUG_SPHINX'
 
 def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageInfo):
@@ -95,5 +95,8 @@ def run_converter(rst_path, out_path, conf_path = None):
             env_tmp["PYTHONPATH"] = f"{package_root_parent};{python_path_current}" if python_path_current else package_root_parent
         else:
             env_tmp["PYTHONPATH"] = f"{package_root_parent}:{python_path_current}" if python_path_current else package_root_parent
+        start_time = time.time()
         subprocess.run(sphinx_param, check=True, cwd=PACKAGE_ROOT, env=env_tmp)
+        end_time = time.time()
+        print(f"<run_sphinx>{out_path},{end_time-start_time}<run_sphinx/>")
     return outdir

{py2docfx-0.1.9.dev1819899.dist-info → py2docfx-0.1.9.dev1824235.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.9.dev1819899
+Version: 0.1.9.dev1824235
 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.9.dev1819899.dist-info → py2docfx-0.1.9.dev1824235.dist-info}/RECORD

@@ -1,10 +1,10 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=GGbOyvqJm1encGUpH8xSSuo46_kz0P_AyJcvc_7gjBo,11881
+py2docfx/__main__.py,sha256=GqWpjtCsIlKzE9_FDFBV4fJbKvgyFoYUvMYJqUfZBKI,12074
 py2docfx/convert_prepare/__init__.py,sha256=XxtxrP0kmW3ZBHIAoxsPDEHzcgeC0WSnole8Lk6CjKs,11
 py2docfx/convert_prepare/environment.py,sha256=AwS4c4OSwVdxlExBLVo310HrVhFMhWQ2Wh9RJPJKH1c,894
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
-py2docfx/convert_prepare/generate_document.py,sha256=wkZvdSFT32u6lgAlrL-PmrvVb5sFPq8pue804QVQ75A,2432
-py2docfx/convert_prepare/get_source.py,sha256=o13Ka_zBjekF_7lhHkyi6GSy4E5cWTnnItbf60JwylI,4954
+py2docfx/convert_prepare/generate_document.py,sha256=svoD_KJa-BrsbetdsQ-CLdSfdrv2jYeMeqxGCYNKmY8,3025
+py2docfx/convert_prepare/get_source.py,sha256=AqAEROzdUbzdg5a889PVbFTD3LG93f3PYst-bngEHAw,5818
 py2docfx/convert_prepare/git.py,sha256=xGJp2nDWLfVljrxyPnFKPoLIqmBh6by-QdITogIuxi0,5893
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
 py2docfx/convert_prepare/pack.py,sha256=vZS67_GzEhUmZWHU1dxm8gnWyRBs-kB6-KjX1d_FdOU,1260
@@ -12,10 +12,10 @@ py2docfx/convert_prepare/package_info.py,sha256=V-xasck6ZfqJdUjlGHtkC1iE-DCBDAMK
 py2docfx/convert_prepare/package_info_extra_settings.py,sha256=u5B5e8hc0m9PA_-0kJzq1LtKn-xzZlucwXHTFy49mDg,1475
 py2docfx/convert_prepare/params.py,sha256=PXMB8pLtb4XbfI322avA47q0AO-TyBE6kZf7FU8I6v4,1771
 py2docfx/convert_prepare/paths.py,sha256=964RX81Qf__rzXgEATfqBNFCKTYVjLt9J7WCz2TnNdc,485
-py2docfx/convert_prepare/pip_utils.py,sha256=W8PJQQSZXUW7W_mdBxaK6KRuxMEskO1-Hw6hjRazqTY,1127
+py2docfx/convert_prepare/pip_utils.py,sha256=HaXvpUAW1z_tj6uzOmOYccQ4wMVRhRFbqyoP7UmNpBI,1140
 py2docfx/convert_prepare/repo_info.py,sha256=6ASJlhBwf6vZTSENgrWCVlJjlJVhuBxzdQyWEdWAC4c,117
 py2docfx/convert_prepare/source.py,sha256=6-A7oof3-WAQcQZZVpT9pKiFLH4CCIZeYqq0MN0O3gw,1710
-py2docfx/convert_prepare/sphinx_caller.py,sha256=CQjDmZRKxTIT83Ah8LSwhdSTObCqYesTVcTRFIXtenY,4275
+py2docfx/convert_prepare/sphinx_caller.py,sha256=GsnJr16OOOeyIBjDLzkdNV3vqRWIpPpNs51L6pasrAI,4429
 py2docfx/convert_prepare/subpackage.py,sha256=mXAi_07pXvnPkSLZfykDh_7VeFxfLy74pYlzhMO8N_Q,5183
 py2docfx/convert_prepare/conf_templates/conf.py_t,sha256=VL5K6xUTIw2cb4GFjDXu5iCZFPA2Kb36KLvier78HFg,3811
 py2docfx/convert_prepare/conf_templates/master_doc.rst_t,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -123,7 +123,7 @@ py2docfx/docfx_yaml/tests/roots/test-writer-uri/conf.py,sha256=avcbnIOV2mlGQwhMQ
 py2docfx/docfx_yaml/tests/roots/test-writer-versions/code_with_version_directives.py,sha256=UuizbrJPaG_PcaH18BvbI9KQevOaLd4SslpnzMSqcrE,1030
 py2docfx/docfx_yaml/tests/roots/test-writer-versions/conf.py,sha256=SCEKrm9VigArfdgf-GAieJD-40d0ctT6urmGIjFOZLM,404
 py2docfx/docfx_yaml/tests/utils/test_utils.py,sha256=d0OYSUQ6NyoZx5mlLdNGGNhiNmmQhjVT4hQ6jY3VE_M,3383
-py2docfx-0.1.9.dev1819899.dist-info/METADATA,sha256=xegSgi5VxHh1X3qy-wA2VAvThEtwbDdFza1cd6INmBA,600
-py2docfx-0.1.9.dev1819899.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-py2docfx-0.1.9.dev1819899.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.9.dev1819899.dist-info/RECORD,,
+py2docfx-0.1.9.dev1824235.dist-info/METADATA,sha256=2W60ZNkXPqNBYBeJhF4e59lT2LsJ50_NVRJuP8ShkPE,600
+py2docfx-0.1.9.dev1824235.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+py2docfx-0.1.9.dev1824235.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.9.dev1824235.dist-info/RECORD,,