py2docfx 0.1.9.dev1929293__py3-none-any.whl → 0.1.9.dev1931282__py3-none-any.whl

py2docfx/__main__.py

@@ -1,229 +1,22 @@
 from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import asyncio
-import argparse
 import logging
 import os
-import stat
 import sys
-import shutil
 
 from py2docfx import PACKAGE_ROOT
-from py2docfx.docfx_yaml.logger import get_logger, get_package_logger, get_warning_error_count, output_log_by_log_level
+from py2docfx.convert_prepare.arg_parser import parse_command_line_args
 from py2docfx.convert_prepare.constants import SOURCE_REPO, TARGET_REPO, DIST_TEMP, LOG_FOLDER
 from py2docfx.convert_prepare.generate_document import generate_document
 from py2docfx.convert_prepare.get_source import YAML_OUTPUT_ROOT
 from py2docfx.convert_prepare.post_process.merge_toc import merge_toc, move_root_toc_to_target
-from py2docfx.convert_prepare.params import load_file_params, load_command_params
 from py2docfx.convert_prepare.package_info import PackageInfo
+from py2docfx.convert_prepare.utils import temp_folder_clean_up, prepare_out_dir
 import py2docfx.convert_prepare.environment as py2docfxEnvironment
+import py2docfx.docfx_yaml.logger as py2docfxLogger
 
 os.chdir(PACKAGE_ROOT)
 
-def get_parser() -> argparse.ArgumentParser:
-    parser = argparse.ArgumentParser(
-        description=(
-            """A command line tool to run Sphinx with docfx-yaml extension, 
-                        transform python source code packages to yamls supported in docfx"""
-        )
-    )
-
-    parser.add_argument(
-        "-o"
-        "--output-root-folder",
-        default=None,
-        dest="output_root",
-        help="The output folder storing generated documents, use cwd if not assigned",
-    )
-    parser.add_argument(
-        "--github-token",
-        default=None,
-        dest="github_token",
-        help="Allow pipeline to clone Github source code repo",
-    )
-    parser.add_argument(
-        "--ado-token",
-        default=None,
-        dest="ado_token",
-        help="Allow pipeline to clone Azure DevOps source code repo",
-    )
-    parser.add_argument(
-        "-f",
-        "--param-file-path",
-        dest="param_file_path",
-        help="The json file contains package infomation",
-    )
-    parser.add_argument(
-        "-j",
-        "--param-json",
-        default=None,
-        dest="param_json",
-        help="The json string contains package infomation",
-    )
-    parser.add_argument(
-        "-t",
-        "--install-type",
-        action="store",
-        dest="install_type",
-        choices=["pypi", "source_code", "dist_file"],
-        help="""The type of source package, can be pip package, github repo or a distribution
-                        file accessible in public""",
-    )
-    parser.add_argument(
-        "-n",
-        "--package-name",
-        default=None,
-        dest="package_name",
-        help="The name of source package, required if INSTALL_TYPE==pypi",
-    )
-    parser.add_argument(
-        "-v",
-        "--version",
-        default=None,
-        dest="version",
-        help="The version of source package, if not assigned, will use latest version",
-    )
-    parser.add_argument(
-        "-i",
-        "--extra-index-url",
-        default=None,
-        dest="extra_index_url",
-        help="Extra index of pip to download source package",
-    )
-    parser.add_argument(
-        "--url",
-        default=None,
-        dest="url",
-        help="""Valid when INSTALL_TYPE==source_code, url of the repo to
-                        clone which contains SDK package source code.""",
-    )
-    parser.add_argument(
-        "--branch",
-        default=None,
-        dest="branch",
-        help="""Valid when INSTALL_TYPE==source_code, branch of the repo to clone which
-                        contains SDK package source code.""",
-    )
-    parser.add_argument(
-        "--editable",
-        default=False,
-        dest="editable",
-        help="""Install a project in editable mode.""",
-    )
-    parser.add_argument(
-        "--folder",
-        default=None,
-        dest="folder",
-        help="""Valid when INSTALL_TYPE==source_code, relative folder path inside the repo
-                        containing SDK package source code.""",
-    )
-    parser.add_argument(
-        "--prefer-source-distribution",
-        dest="prefer_source_distribution",
-        action="store_true",
-        help="""Valid when INSTALL_TYPE==pypi, a flag which add --prefer-binary
-                        option to pip commands when getting package source.""",
-    )
-    parser.add_argument(
-        "--location",
-        default=None,
-        dest="location",
-        help="""Valid when INSTALL_TYPE==dist_file, the url of distribution file
-                        containing source package.""",
-    )
-    parser.add_argument(
-        "--build-in-subpackage",
-        action="store_true",
-        dest="build_in_subpackage",
-        help="""When package has lot of big subpackages and each doesn't depend on others
-                    enable to fasten build""",
-    )
-    parser.add_argument(
-        "exclude_path",
-        default=[],
-        nargs="*",
-        help="""A list containing relative paths to the root of the package of files/directories
-                        excluded when generating documents, should follow fnmatch-style.""",
-    )
-    
-    parser.add_argument(
-        "--verbose",
-        action="store_true",
-        help="""Increase output verbosity. Cannot be used together with --show-warning""",
-    )
-    
-    parser.add_argument(
-        "--show-warning",
-        action="store_true",
-        help="""Show warning message. Cannot be used together with --verbose""",
-    )
-    return parser
-
-
-def parse_command_line_args(argv) -> (
-        list[PackageInfo], list[PackageInfo], str, str, str | os.PathLike, bool, bool):
-    parser = get_parser()
-    args = parser.parse_args(argv)
-
-    github_token = args.github_token
-    ado_token = args.ado_token
-    output_root = args.output_root
-    verbose = args.verbose
-    show_warning = args.show_warning
-
-    if args.param_file_path:
-        (package_info_list, required_packages) = load_file_params(args.param_file_path)
-        return (list(package_info_list), list(required_packages), github_token,
-                ado_token, output_root, verbose, show_warning)
-    elif args.param_json:
-        (package_info_list, required_packages) = load_command_params(args.param_json)
-        return (package_info_list, required_packages, github_token,
-                ado_token, output_root, verbose, show_warning)
-    else:
-        package_info = PackageInfo()
-        if not args.install_type:
-            PackageInfo.report_error("install_type", args.install_type)
-        package_info.install_type = PackageInfo.InstallType[
-            args.install_type.upper()
-        ]
-
-        package_info.name = args.package_name
-        package_info.version = args.version
-        package_info.extra_index_url = args.extra_index_url
-        package_info.editable = args.editable
-        package_info.prefer_source_distribution = (
-            args.prefer_source_distribution
-        )
-        package_info.build_in_subpackage = args.build_in_subpackage
-        package_info.exclude_path = args.exclude_path
-
-        if (
-            package_info.install_type == PackageInfo.InstallType.PYPI
-            and not package_info.name
-        ):
-            PackageInfo.report_error("name", "None")
-
-        if package_info.install_type == PackageInfo.InstallType.SOURCE_CODE:
-            package_info.url = args.url
-            package_info.branch = args.branch
-            package_info.folder = args.folder
-            if not package_info.url:
-                if not package_info.folder:
-                    msg = "When install_type is source_code, folder or url should be provided"
-                    raise ValueError(msg)
-                else:
-                    msg = f"Read source code from local folder: {package_info.folder}"
-                    logging.info(msg)
-
-        if package_info.install_type == PackageInfo.InstallType.DIST_FILE:
-            package_info.location = args.location
-            if not package_info.location:
-                PackageInfo.report_error(
-                    "location",
-                    "None",
-                    condition="When install_type is dist_file",
-                )
-        return ([package_info], [], github_token, ado_token, output_root, verbose, show_warning)
-
 async def donwload_package_generate_documents(
         package_info_list: list[PackageInfo],
         output_root: str | os.PathLike | None,
@@ -245,7 +38,7 @@ async def donwload_package_generate_documents(
     for idx, package in enumerate(package_info_list):
         os.environ['PROCESSING_PACKAGE_NAME'] = package.name
         package_number = start_num + idx
-        py2docfx_logger = get_package_logger(__name__)
+        py2docfx_logger = py2docfxLogger.get_package_logger(__name__)
         msg = f"Processing package {package.name}, env_prepare_tasks: {len(env_prepare_tasks)}"
         py2docfx_logger.info(msg)
 
@@ -295,56 +88,6 @@ async def donwload_package_generate_documents(
         if env_remove_tasks[idx] != None and not env_remove_tasks[idx].done():
             await env_remove_tasks[idx]
 
-def prepare_out_dir(output_root: str | os.PathLike) -> os.PathLike | None:
-    # prepare output_root\DOC_FOLDER_NAME (if folder contains files, raise exception)
-    if output_root:
-        if os.path.exists(output_root):
-            if os.path.isfile(output_root):
-                raise ValueError(f"""output-root-folder is a path of file,
-                                    output-root-folder value: {output_root}""")
-            else:
-                if len(os.listdir(output_root)) > 0:
-                    raise ValueError(f"""output-root-folder isn't empty,
-                                    output-root-folder value: {output_root}""")
-                return output_root
-        else:
-            os.makedirs(output_root)
-            return output_root
-    else:
-        return None
-
-def on_rm_error( func, path, exc_info):
-    # path contains the path of the file that couldn't be removed
-    # let's just assume that it's read-only and unlink it.
-    os.chmod(path, stat.S_IWRITE)
-    os.unlink(path)
-
-def remove_folder(folder: str | os.PathLike) -> None:
-    try:
-        shutil.rmtree(folder)
-    except PermissionError:
-        shutil.rmtree(folder, ignore_errors=False, onerror=on_rm_error)
-        if os.path.exists(folder):
-            raise ValueError(f"Failed to remove folder {folder}")
-        
-def temp_folder_clean_up(folder_list: list[str | os.PathLike]) -> None:
-    for folder in folder_list:
-        if os.path.exists(folder):
-            remove_folder(folder)
-
-def decide_global_log_level(verbose: bool, show_warning: bool) -> None:
-    if verbose and show_warning:
-        raise ValueError("Cannot use --verbose and --show-warning at the same time")
-    if verbose:
-        os.environ['LOG_LEVEL'] = 'INFO'
-        return
-    if show_warning:
-        os.environ['LOG_LEVEL'] = 'WARNING'
-        return
-    
-    # Default log level
-    os.environ['LOG_LEVEL'] = 'ERROR'
-
 def main(argv) -> int:
     # TODO: may need to purge pip cache
     (package_info_list,
@@ -356,9 +99,9 @@ def main(argv) -> int:
     clean_up_folder_list = [py2docfxEnvironment.VENV_DIR, DIST_TEMP, SOURCE_REPO, TARGET_REPO, LOG_FOLDER]
     temp_folder_clean_up(clean_up_folder_list)
     
-    decide_global_log_level(verbose, show_warning)
+    py2docfxLogger.decide_global_log_level(verbose, show_warning)
     
-    py2docfx_logger = get_logger(__name__)
+    py2docfx_logger = py2docfxLogger.get_logger(__name__)
 
     msg = "Adding yaml extension to path"
     py2docfx_logger.info(msg)
@@ -375,8 +118,8 @@ def main(argv) -> int:
         py2docfx_logger.error(msg)
         raise
     
-    warning_count, error_count = get_warning_error_count()
-    output_log_by_log_level()
+    warning_count, error_count = py2docfxLogger.get_warning_error_count()
+    py2docfxLogger.output_log_by_log_level()
     print(f"Warning count: {warning_count}, Error count: {error_count}")
     logging.shutdown()
     return 0

py2docfx/convert_prepare/arg_parser.py

@@ -0,0 +1,211 @@
+import argparse
+import logging
+import os
+
+from py2docfx.convert_prepare.params import load_file_params, load_command_params
+from py2docfx.convert_prepare.package_info import PackageInfo
+
+def get_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        description=(
+            """A command line tool to run Sphinx with docfx-yaml extension, 
+                        transform python source code packages to yamls supported in docfx"""
+        )
+    )
+
+    parser.add_argument(
+        "-o"
+        "--output-root-folder",
+        default=None,
+        dest="output_root",
+        help="The output folder storing generated documents, use cwd if not assigned",
+    )
+    parser.add_argument(
+        "--github-token",
+        default=None,
+        dest="github_token",
+        help="Allow pipeline to clone Github source code repo",
+    )
+    parser.add_argument(
+        "--ado-token",
+        default=None,
+        dest="ado_token",
+        help="Allow pipeline to clone Azure DevOps source code repo",
+    )
+    parser.add_argument(
+        "-f",
+        "--param-file-path",
+        dest="param_file_path",
+        help="The json file contains package infomation",
+    )
+    parser.add_argument(
+        "-j",
+        "--param-json",
+        default=None,
+        dest="param_json",
+        help="The json string contains package infomation",
+    )
+    parser.add_argument(
+        "-t",
+        "--install-type",
+        action="store",
+        dest="install_type",
+        choices=["pypi", "source_code", "dist_file"],
+        help="""The type of source package, can be pip package, github repo or a distribution
+                        file accessible in public""",
+    )
+    parser.add_argument(
+        "-n",
+        "--package-name",
+        default=None,
+        dest="package_name",
+        help="The name of source package, required if INSTALL_TYPE==pypi",
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        default=None,
+        dest="version",
+        help="The version of source package, if not assigned, will use latest version",
+    )
+    parser.add_argument(
+        "-i",
+        "--extra-index-url",
+        default=None,
+        dest="extra_index_url",
+        help="Extra index of pip to download source package",
+    )
+    parser.add_argument(
+        "--url",
+        default=None,
+        dest="url",
+        help="""Valid when INSTALL_TYPE==source_code, url of the repo to
+                        clone which contains SDK package source code.""",
+    )
+    parser.add_argument(
+        "--branch",
+        default=None,
+        dest="branch",
+        help="""Valid when INSTALL_TYPE==source_code, branch of the repo to clone which
+                        contains SDK package source code.""",
+    )
+    parser.add_argument(
+        "--editable",
+        default=False,
+        dest="editable",
+        help="""Install a project in editable mode.""",
+    )
+    parser.add_argument(
+        "--folder",
+        default=None,
+        dest="folder",
+        help="""Valid when INSTALL_TYPE==source_code, relative folder path inside the repo
+                        containing SDK package source code.""",
+    )
+    parser.add_argument(
+        "--prefer-source-distribution",
+        dest="prefer_source_distribution",
+        action="store_true",
+        help="""Valid when INSTALL_TYPE==pypi, a flag which add --prefer-binary
+                        option to pip commands when getting package source.""",
+    )
+    parser.add_argument(
+        "--location",
+        default=None,
+        dest="location",
+        help="""Valid when INSTALL_TYPE==dist_file, the url of distribution file
+                        containing source package.""",
+    )
+    parser.add_argument(
+        "--build-in-subpackage",
+        action="store_true",
+        dest="build_in_subpackage",
+        help="""When package has lot of big subpackages and each doesn't depend on others
+                    enable to fasten build""",
+    )
+    parser.add_argument(
+        "exclude_path",
+        default=[],
+        nargs="*",
+        help="""A list containing relative paths to the root of the package of files/directories
+                        excluded when generating documents, should follow fnmatch-style.""",
+    )
+    
+    parser.add_argument(
+        "--verbose",
+        action="store_true",
+        help="""Increase output verbosity. Cannot be used together with --show-warning""",
+    )
+    
+    parser.add_argument(
+        "--show-warning",
+        action="store_true",
+        help="""Show warning message. Cannot be used together with --verbose""",
+    )
+    return parser
+
+
+def parse_command_line_args(argv) -> (
+        list[PackageInfo], list[PackageInfo], str, str, str | os.PathLike, bool, bool):
+    parser = get_parser()
+    args = parser.parse_args(argv)
+
+    github_token = args.github_token
+    ado_token = args.ado_token
+    output_root = args.output_root
+    verbose = args.verbose
+    show_warning = args.show_warning
+
+    if args.param_file_path:
+        (package_info_list, required_packages) = load_file_params(args.param_file_path)
+        return (list(package_info_list), list(required_packages), github_token,
+                ado_token, output_root, verbose, show_warning)
+    elif args.param_json:
+        (package_info_list, required_packages) = load_command_params(args.param_json)
+        return (package_info_list, required_packages, github_token,
+                ado_token, output_root, verbose, show_warning)
+    else:
+        package_info = PackageInfo()
+        if not args.install_type:
+            PackageInfo.report_error("install_type", args.install_type)
+        package_info.install_type = PackageInfo.InstallType[
+            args.install_type.upper()
+        ]
+
+        package_info.name = args.package_name
+        package_info.version = args.version
+        package_info.extra_index_url = args.extra_index_url
+        package_info.editable = args.editable
+        package_info.prefer_source_distribution = (
+            args.prefer_source_distribution
+        )
+        package_info.build_in_subpackage = args.build_in_subpackage
+        package_info.exclude_path = args.exclude_path
+
+        if (
+            package_info.install_type == PackageInfo.InstallType.PYPI
+            and not package_info.name
+        ):
+            PackageInfo.report_error("name", "None")
+
+        if package_info.install_type == PackageInfo.InstallType.SOURCE_CODE:
+            package_info.url = args.url
+            package_info.branch = args.branch
+            package_info.folder = args.folder
+            if not package_info.url:
+                if not package_info.folder:
+                    msg = "When install_type is source_code, folder or url should be provided"
+                    raise ValueError(msg)
+                else:
+                    msg = f"Read source code from local folder: {package_info.folder}"
+                    logging.info(msg)
+
+        if package_info.install_type == PackageInfo.InstallType.DIST_FILE:
+            package_info.location = args.location
+            if not package_info.location:
+                PackageInfo.report_error(
+                    "location",
+                    "None",
+                    condition="When install_type is dist_file",
+                )
+        return ([package_info], [], github_token, ado_token, output_root, verbose, show_warning)

py2docfx/convert_prepare/environment.py

@@ -2,11 +2,12 @@ import subprocess
 import asyncio
 import os
 import sys
+
 from py2docfx import PACKAGE_ROOT
 from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.get_source import get_source
 from py2docfx.convert_prepare import pip_utils
-from py2docfx.docfx_yaml.logger import get_logger
+from py2docfx.docfx_yaml.logger import get_logger, run_async_subprocess
 
 REQUIREMENT_MODULES = ["setuptools", "sphinx==6.1.3", "pyyaml", "jinja2==3.0.3", "wheel"]
 VENV_REQUIREMENT_MODULES = ["setuptools", "wheel"] # to support running setup.py in venv
@@ -47,8 +48,7 @@ def install_converter_requirements(executable: str):
 async def install_venv_requirements(venv_num: int):
     venv_exe = get_venv_exe(venv_num)
     pip_cmd = ["-m", "pip", "install", "--upgrade"]+ VENV_REQUIREMENT_MODULES
-    # await(await asyncio.create_subprocess_exec(venv_exe, *pip_cmd)).wait()
-    await pip_utils.run_async_subprocess(venv_exe, pip_cmd)
+    await run_async_subprocess(venv_exe, pip_cmd)
 
 def get_venv_path(venv_num: int) -> str:
     return os.path.join(PACKAGE_ROOT, VENV_DIR, "venv"+str(venv_num))
@@ -85,8 +85,7 @@ def get_base_venv_sphinx_build_path() -> str:
 
 async def install_converter_requirement_async(executable: str):
     pip_cmd = PIP_INSTALL_COMMAND + PIP_INSTALL_VENV_COMMON_OPTIONS + REQUIREMENT_MODULES
-    # await(await asyncio.create_subprocess_exec(executable, *pip_cmd)).wait()
-    await pip_utils.run_async_subprocess(executable, pip_cmd)
+    await run_async_subprocess(executable, pip_cmd)
 
 async def install_required_packages(
         executable: str, required_package_list: list[PackageInfo], github_token: str, ado_token: str):
@@ -96,8 +95,7 @@ async def install_required_packages(
         #     get_source(package, idx, vststoken=ado_token, githubtoken=github_token)
         package_name, options = package.get_install_command()
         pip_cmd = PIP_INSTALL_COMMAND + PIP_INSTALL_VENV_COMMON_OPTIONS + options + [package_name]
-        # await(await asyncio.create_subprocess_exec(executable, *pip_cmd)).wait()
-        await pip_utils.run_async_subprocess(executable, pip_cmd)
+        await run_async_subprocess(executable, pip_cmd)
 
 async def create_environment(venv_path: int):
     if os.name == 'nt':

py2docfx/convert_prepare/pack.py

@@ -1,8 +1,10 @@
 import shutil
 from os import path
 import os
-import wheel.cli.unpack as wheel_cli_unpack
+import subprocess
+import sys
 
+from py2docfx.docfx_yaml.logger import get_package_logger, log_subprocess_ouput
 
 def unpack_dist(dist_file):
     if dist_file.endswith(".whl"):
@@ -22,8 +24,16 @@ def unpack_wheel(file_path):
     """
     Transform a wheel file to a folder containing source code
     """
-
-    wheel_cli_unpack.unpack(file_path, path.dirname(file_path))
+    py2docfx_logger = get_package_logger(__name__)
+    command = [sys.executable,
+               '-m',
+               'wheel',
+               'unpack',
+               file_path,
+               '-d',
+               os.path.dirname(file_path)]
+    output = subprocess.run(command, check=True, capture_output=True, text=True)
+    log_subprocess_ouput(output, py2docfx_logger)
     extract_folder = [file for file in os.listdir(path.dirname(file_path)) if path.isdir(path.join(path.dirname(file_path), file))][0]
     data_folder = path.join(path.dirname(file_path), extract_folder, extract_folder + ".data")
     if path.exists(data_folder):

py2docfx/convert_prepare/pip_utils.py

@@ -1,8 +1,7 @@
 import subprocess
-import asyncio
-import os
+
 from py2docfx import PACKAGE_ROOT
-from py2docfx.docfx_yaml.logger import get_logger, log_subprocess_ouput
+from py2docfx.docfx_yaml.logger import get_logger, log_subprocess_ouput, run_async_subprocess
 
 PYPI = "pypi"
 
@@ -50,23 +49,4 @@ def install_in_exe(exe_path, package_name, options):
     
 async def install_in_exe_async(exe_path, package_name, options):
     pip_cmd = ["-m", "pip", "install"]+ pip_install_common_options + options + [package_name]
-    await run_async_subprocess(exe_path, pip_cmd)
-    # await(await asyncio.create_subprocess_exec(exe_path, *pip_cmd)).wait()
-    
-async def run_async_subprocess(exe_path, cmd):
-    process = await asyncio.create_subprocess_exec(
-        exe_path, *cmd,
-        stdout=asyncio.subprocess.PIPE,
-        stderr=asyncio.subprocess.PIPE
-    )
-    stdout, stderr = await process.communicate()
-    py2docfx_logger = get_logger(__name__)
-    if process.returncode != 0:
-        msg = stderr.decode('utf-8')
-        if msg != None and msg != "":
-            py2docfx_logger.error(msg)
-        raise RuntimeError()
-    else:
-        msg = stdout.decode('utf-8')
-        if msg != None and msg != "":
-            py2docfx_logger.info(msg)
+    await run_async_subprocess(exe_path, pip_cmd)

py2docfx/convert_prepare/sphinx_caller.py

@@ -1,7 +1,5 @@
 import os
 import sys
-from sphinx.application import Sphinx
-import sphinx.ext.apidoc as apidoc
 import subprocess
 
 from py2docfx import PACKAGE_ROOT
@@ -32,29 +30,18 @@ def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageI
         if os.path.isdir(subfolderPath):
             msg = "<CI INFO>: Subfolder path {}.".format(subfolderPath)
             py2docfx_logger.info(msg)
-            if os.environ.get('LOG_LEVEL') == 'INFO':
-                args = [
-                    "--module-first",
-                    "--no-headings",
-                    "--no-toc",
-                    "--implicit-namespaces",
-                    "-o",
-                    rst_path,
-                    subfolderPath,
-                ]
-            else:
-                args = [
-                    "-q",
-                    "--module-first",
-                    "--no-headings",
-                    "--no-toc",
-                    "--implicit-namespaces",
-                    "-o",
-                    rst_path,
-                    subfolderPath
-                ]
+            args = [
+                "--module-first",
+                "--no-headings",
+                "--no-toc",
+                "--implicit-namespaces",
+                "-o",
+                rst_path,
+                subfolderPath,
+            ]
             args.extend(exclude_paths)
-            apidoc.main(args)
+            output = subprocess.run([sys.executable, "-m", "sphinx.ext.apidoc"] + args, capture_output=True, text=True)
+            log_subprocess_ouput(output, py2docfx_logger)
             if package_info.build_in_subpackage and subfolder == "azure":
                 subpackages_rst_record = move_rst_files_to_subfolder(
                     package_paths.doc_folder, package_info.name,

py2docfx/convert_prepare/utils.py

@@ -0,0 +1,41 @@
+import os
+import shutil
+import stat
+
+def on_rm_error( func, path, exc_info):
+    # path contains the path of the file that couldn't be removed
+    # let's just assume that it's read-only and unlink it.
+    os.chmod(path, stat.S_IWRITE)
+    os.unlink(path)
+
+def remove_folder(folder: str | os.PathLike) -> None:
+    try:
+        shutil.rmtree(folder)
+    except PermissionError as e:
+        if '.git' and '.idx' in str(e):
+            shutil.rmtree(folder, ignore_errors=False, onerror=on_rm_error)
+        if os.path.exists(folder):
+            raise RuntimeError(f"Failed to remove folder {folder}")
+
+def temp_folder_clean_up(folder_list: list[str | os.PathLike]) -> None:
+    for folder in folder_list:
+        if os.path.exists(folder):
+            remove_folder(folder)
+            
+def prepare_out_dir(output_root: str | os.PathLike) -> os.PathLike | None:
+    # prepare output_root\DOC_FOLDER_NAME (if folder contains files, raise exception)
+    if output_root:
+        if os.path.exists(output_root):
+            if os.path.isfile(output_root):
+                raise ValueError(f"""output-root-folder is a path of file,
+                                    output-root-folder value: {output_root}""")
+            else:
+                if len(os.listdir(output_root)) > 0:
+                    raise ValueError(f"""output-root-folder isn't empty,
+                                    output-root-folder value: {output_root}""")
+                return output_root
+        else:
+            os.makedirs(output_root)
+            return output_root
+    else:
+        return None

py2docfx/docfx_yaml/logger.py

@@ -1,7 +1,21 @@
+import asyncio
 import os
 import logging
 import subprocess
 
+def decide_global_log_level(verbose: bool, show_warning: bool) -> None:
+    if verbose and show_warning:
+        raise ValueError("Cannot use --verbose and --show-warning at the same time")
+    if verbose:
+        os.environ['LOG_LEVEL'] = 'INFO'
+        return
+    if show_warning:
+        os.environ['LOG_LEVEL'] = 'WARNING'
+        return
+    
+    # Default log level
+    os.environ['LOG_LEVEL'] = 'ERROR'
+
 def get_log_level():
     if os.environ.get('LOG_LEVEL') == 'WARNING':
         return logging.WARNING
@@ -24,7 +38,6 @@ def setup_log_handlers(logger, log_file_name):
     check_log_file_exists(log_file_name)
     file_handler = logging.FileHandler(filename=log_file_name, mode='a')
     file_handler.setFormatter(logging.Formatter('%(levelname)s - %(name)s - %(message)s'))
-    
     logger.addHandler(file_handler)
     
     return logger
@@ -145,4 +158,22 @@ def output_log_by_log_level():
     package_logs_folder = os.path.join("logs", "package_logs")
     for log_file in os.listdir(package_logs_folder):
         log_file_path = os.path.join(package_logs_folder, log_file)
-        print_out_log_by_log_level(parse_log(log_file_path), log_level)
+        print_out_log_by_log_level(parse_log(log_file_path), log_level)
+
+async def run_async_subprocess(exe_path, cmd):
+    process = await asyncio.create_subprocess_exec(
+        exe_path, *cmd,
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE
+    )
+    stdout, stderr = await process.communicate()
+    py2docfx_logger = get_logger(__name__)
+    if process.returncode != 0:
+        msg = stderr.decode('utf-8')
+        if msg != None and msg != "":
+            py2docfx_logger.error(msg)
+        raise RuntimeError()
+    else:
+        msg = stdout.decode('utf-8')
+        if msg != None and msg != "":
+            py2docfx_logger.info(msg)

{py2docfx-0.1.9.dev1929293.dist-info → py2docfx-0.1.9.dev1931282.dist-info}/METADATA

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

@@ -1,23 +1,25 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=uhzznSKIF9Y-aslF42_y4BqlGfkDIwPlnhYT6IDuqLc,15004
+py2docfx/__main__.py,sha256=MA5jRTbG6NH5ma7Ew8iSmaTp3YSTWoRhEwOiPX2chvs,5674
 py2docfx/convert_prepare/__init__.py,sha256=XxtxrP0kmW3ZBHIAoxsPDEHzcgeC0WSnole8Lk6CjKs,11
+py2docfx/convert_prepare/arg_parser.py,sha256=Wa1iK8a0Gb3QqaS4X7nUPGvh-7mWhuBS9IVbmnjC770,7606
 py2docfx/convert_prepare/constants.py,sha256=RC5DqNkqWvx4hb91FrajZ1R9dBFLxcPyoEJ43jdm36E,102
-py2docfx/convert_prepare/environment.py,sha256=7EmlodXVG0S5wnn0_VFPwPJ_3OHfJfGpN33SUL3HSRI,7233
+py2docfx/convert_prepare/environment.py,sha256=j2pQ7cfkxJDpw9kXL4VbVuq23B3fXMoc8EdIGmLX5YM,6985
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
 py2docfx/convert_prepare/generate_document.py,sha256=mNfJpLViIfzwRnjVwXmg5H5lVWzKJkUHeXTiJouA39o,2879
 py2docfx/convert_prepare/get_source.py,sha256=6EMSLiDOfid4d7SDxweV_-TGV4McxhSxKQPJju2Mi4Y,5221
 py2docfx/convert_prepare/git.py,sha256=OIoaX_0LG5ueY8zmUwrbxl_YyMxwLzgTp6g0uSkC2Y0,6617
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
-py2docfx/convert_prepare/pack.py,sha256=bptweiUnlk_jtu1FxgqlqvHVOCfvoeAqemxli6ep0-o,1231
+py2docfx/convert_prepare/pack.py,sha256=k8eme75VRhdsZOc9ox0zNORXP4kFhAiPiP4mUdNBwwU,1614
 py2docfx/convert_prepare/package_info.py,sha256=2fDyalHtxhZQICehDK4zv7k69HE427c1MLEuHVnPzBU,7624
 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=SGWS07Rn0sWlZsr_fdGIqLFHsgma4UvsghjzkNogFkc,2930
+py2docfx/convert_prepare/pip_utils.py,sha256=GPWGUBcxW8JKreGwxZIAe9AWAI78aL1aFan8DvaAf1o,2228
 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=KM5SanFk67Kkd3oVKzNN-5KCAAiyNUUgnJl5mDs-3kw,4439
+py2docfx/convert_prepare/sphinx_caller.py,sha256=4hYjDQgwEaAkCl8V7q05sn4RmWJQA_QthtztV6l6K-w,4082
 py2docfx/convert_prepare/subpackage.py,sha256=mXAi_07pXvnPkSLZfykDh_7VeFxfLy74pYlzhMO8N_Q,5183
+py2docfx/convert_prepare/utils.py,sha256=TwfDjIqIx_nAoSeQ-LX30h_-d96WhPQcAu7P8N_tSjM,1618
 py2docfx/convert_prepare/conf_templates/conf.py_t,sha256=8zxvY1WiG-z2aiSNDY0719C08QxZLXXEMwKfYSGN0ZE,3811
 py2docfx/convert_prepare/conf_templates/root_doc.rst_t,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/post_process/merge_toc.py,sha256=DPUvL6eS0Q4gcp_fdGgWQJeYmt0sa9voWnVe0O-2giM,1265
@@ -63,7 +65,7 @@ py2docfx/docfx_yaml/convert_enum.py,sha256=QH0OkZq8pFi_nAXem6ddkO_7TSsoY2tz7_wxI
 py2docfx/docfx_yaml/convert_module.py,sha256=GptO1MRwaQ2Qbu724F0kCDDQQTZe7mWOtrOp3Rzgl-I,2259
 py2docfx/docfx_yaml/convert_package.py,sha256=Ep7PmvoLInDvY6OU5dveR6iVwyzGRkW3q6lX7yGJ0JE,2109
 py2docfx/docfx_yaml/directives.py,sha256=zVVuNM_6AU9G6sbqL1UAyHHgPe7bkBWbthXI-PO5ez0,879
-py2docfx/docfx_yaml/logger.py,sha256=t4IqwDYp8dkbzS5-W0ChoeryzX0KAuq09bb5GhiU7f0,5497
+py2docfx/docfx_yaml/logger.py,sha256=XIznVK30tjpcstpyjNuJM43gs0DkCRjmU_kaLhCxS8M,6547
 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
@@ -4180,7 +4182,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=u95n7QQUxpCjrZistYE-3gN451zXzopuJna8cXRQ4Jw,28115
 py2docfx/venv/venv1/Scripts/pywin32_testall.py,sha256=-6yvZmd2lPQc4e8i6PgLsr_totF6mScvoq0Jqr0V2fM,3844
-py2docfx-0.1.9.dev1929293.dist-info/METADATA,sha256=LDqDxpPgSjI-Z-iTKM4bRTuRbiJDAwaCif99Nw9KnRY,600
-py2docfx-0.1.9.dev1929293.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-py2docfx-0.1.9.dev1929293.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.9.dev1929293.dist-info/RECORD,,
+py2docfx-0.1.9.dev1931282.dist-info/METADATA,sha256=l1MDPaHDr5FIdNgjvFLycZsIkIqACVVILJ2qfhdMGtU,600
+py2docfx-0.1.9.dev1931282.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+py2docfx-0.1.9.dev1931282.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.9.dev1931282.dist-info/RECORD,,