py2docfx 0.1.9.dev1926139__py3-none-any.whl → 0.1.9.dev1927662__py3-none-any.whl

py2docfx/__main__.py

@@ -7,8 +7,8 @@ import sys
 import shutil
 
 from py2docfx import PACKAGE_ROOT
-from py2docfx.docfx_yaml.logger import get_logger
-from py2docfx.convert_prepare.constants import SOURCE_REPO, TARGET_REPO, DIST_TEMP
+from py2docfx.docfx_yaml.logger import get_logger, get_package_logger, get_warning_error_count, output_log_by_log_level
+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
@@ -227,8 +227,6 @@ async def donwload_package_generate_documents(
         output_doc_folder: os.PathLike | None,
         github_token: str, ado_token: str, required_package_list: list):
     
-    docfx_logger = get_logger(__name__)
-    
     start_num = len(required_package_list)
     env_prepare_tasks = []
     env_remove_tasks = []
@@ -244,14 +242,15 @@ 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__)
         msg = f"Processing package {package.name}, env_prepare_tasks: {len(env_prepare_tasks)}"
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
 
         try:
             await env_prepare_tasks[idx]
         except Exception as e:
             msg = f"Failed to setup venv for package {package.name}: {e}"
-            docfx_logger.error(msg)
+            py2docfx_logger.error(msg)
             raise
 
         generate_document(package, output_root,
@@ -268,7 +267,7 @@ async def donwload_package_generate_documents(
             buffer_package_idx = idx + py2docfxEnvironment.VENV_BUFFER
             
             msg = f"Creating venv {buffer_package_idx}"
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
             
             env_prepare_tasks.append(
                 asyncio.create_task(py2docfxEnvironment.prepare_venv(buffer_package_idx, 
@@ -283,7 +282,7 @@ async def donwload_package_generate_documents(
 
         if idx > py2docfxEnvironment.VENV_BUFFER and env_remove_tasks[idx-py2docfxEnvironment.VENV_BUFFER] != None:
             msg = f"Removing venv {idx-py2docfxEnvironment.VENV_BUFFER}"
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
             await env_remove_tasks[idx-py2docfxEnvironment.VENV_BUFFER]
 
     if output_doc_folder:
@@ -329,15 +328,6 @@ def decide_global_log_level(verbose: bool, show_warning: bool) -> None:
     # Default log level
     os.environ['LOG_LEVEL'] = 'ERROR'
 
-def prepare_log_folder() -> None:
-    if not os.path.exists('logs'):
-        os.makedirs('logs')
-        os.makedirs(os.path.join('logs', 'package_logs'))
-    else:
-        shutil.rmtree('logs')
-        os.makedirs('logs')
-        os.makedirs(os.path.join('logs', 'package_logs'))
-
 def main(argv) -> int:
     # TODO: may need to purge pip cache
     (package_info_list,
@@ -346,20 +336,19 @@ def main(argv) -> int:
      output_root, verbose,
      show_warning) = parse_command_line_args(argv)
     
+    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)
-    prepare_log_folder()
     
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
 
     msg = "Adding yaml extension to path"
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     
     sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)),'docfx_yaml'))
     os.chdir(PACKAGE_ROOT)
     output_doc_folder = prepare_out_dir(output_root)
-    
-    clean_up_folder_list = [py2docfxEnvironment.VENV_DIR, DIST_TEMP, SOURCE_REPO, TARGET_REPO]
-    temp_folder_clean_up(clean_up_folder_list)
 
     try:
         asyncio.run(donwload_package_generate_documents(
@@ -367,8 +356,13 @@ def main(argv) -> int:
             github_token, ado_token, required_package_list))
     except Exception as e:
         msg = f"An error occurred: {e}"
-        docfx_logger.error(msg)
+        py2docfx_logger.error(msg)
         raise
+    
+    warning_count, error_count = get_warning_error_count()
+    output_log_by_log_level()
+    print(f"Warning count: {warning_count}, Error count: {error_count}")
+    logging.shutdown()
     return 0
 
 if __name__ == "__main__":

py2docfx/convert_prepare/conf_templates/conf.py_t

@@ -62,7 +62,7 @@ release = '{{PROJECT_RELEASE}}'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

py2docfx/convert_prepare/constants.py

@@ -1,3 +1,4 @@
 TARGET_REPO = 'target_repo'
 SOURCE_REPO = 'source_repo'
-DIST_TEMP = 'dist_temp'
+DIST_TEMP = 'dist_temp'
+LOG_FOLDER = 'logs'

py2docfx/convert_prepare/environment.py

@@ -28,7 +28,7 @@ def install_converter_requirements(executable: str):
     https://apidrop.visualstudio.com/Content%20CI/_git/ReferenceAutomation?path=/Python/InstallPackage.ps1&line=15&lineEnd=35&lineStartColumn=1&lineEndColumn=87&lineStyle=plain&_a=contents
     """
     pip_install_cmd = [executable, "-m", "pip", "install", "--upgrade"]
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     pip_install_common_options = [
         "--no-cache-dir",
         "--quiet",
@@ -39,7 +39,7 @@ def install_converter_requirements(executable: str):
 
     for module in REQUIREMENT_MODULES:
         msg = f"<CI INFO>: Upgrading {module}..."
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
         subprocess.run(
             pip_install_cmd + [module] + pip_install_common_options, check=True
         )
@@ -106,39 +106,39 @@ async def create_environment(venv_path: int):
         await (await asyncio.create_subprocess_exec("python3", "-m", "venv", venv_path)).wait()
 
 async def prepare_base_venv(required_package_list: list[PackageInfo], github_token: str, ado_token: str):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     
     msg = f"<CI INFO>: Creating basevenv..."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     await create_environment(get_base_venv_path())
     
     msg = f"<CI INFO>: Installing converter requirements in ..."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     await install_converter_requirement_async(get_base_venv_exe())
     
     msg = f"<CI INFO>: Installing required packages in basevenv..."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     await install_required_packages(get_base_venv_exe(), required_package_list, github_token, ado_token)
     
     msg = f"<CI INFO>: basevenv setup complete."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
 
 async def prepare_venv(venv_num: int, package_info: PackageInfo, package_number: int, github_token: str, ado_token: str):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     await create_environment(get_venv_path(venv_num))
     await install_venv_requirements(venv_num)
     get_source(get_venv_exe(venv_num), package_info, package_number, vststoken=ado_token, githubtoken=github_token)
     package_name, options = package_info.get_install_command()
     await pip_utils.install_in_exe_async(get_venv_exe(venv_num), package_name, options)
     msg = f"<CI INFO>: venv{venv_num} setup complete."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
 
 async def remove_environment(venv_num: int):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     venv_path = get_venv_path(venv_num)
     if os.path.exists(venv_path):
         msg = f"<CI INFO>: Removing venv{venv_num}..."
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
         # Create a subprocess to run the shell command for removing the directory
         process = await asyncio.create_subprocess_shell(
             f'rm -rf {venv_path}' if os.name != 'nt' else f'rmdir /S /Q {venv_path}',
@@ -148,8 +148,8 @@ async def remove_environment(venv_num: int):
         stdout, stderr = await process.communicate()
         if process.returncode == 0:
             msg = f"<CI INFO>: venv{venv_num} removed."
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
         else:
             msg = f"<CI ERROR>: Failed to remove venv{venv_num}. Error: {stderr.decode()}"
-            docfx_logger.error(msg)
+            py2docfx_logger.error(msg)
             raise RuntimeError()

py2docfx/convert_prepare/generate_document.py

@@ -1,7 +1,7 @@
 from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import os
 import sys
-from py2docfx.docfx_yaml.logger import get_logger
+from py2docfx.docfx_yaml.logger import get_package_logger
 from py2docfx.convert_prepare.generate_conf import generate_conf
 from py2docfx.convert_prepare.git import checkout
 from py2docfx.convert_prepare.package_info import PackageInfo
@@ -11,7 +11,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, sphinx_build_path: str, extra_package_path: str, executable=sys.executable):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     # Copy manual written RST from target doc repo
     package_paths = pkg.path
     if output_root:
@@ -31,18 +31,18 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_b
             checkout(package_paths.source_folder, pkg.branch)
 
         msg = f"<CI INFO>: Generating RST files for {pkg.name}."
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
 
         subpackages_rst_record = run_apidoc(package_paths.doc_folder, package_paths.source_folder,
                                             exclude_paths, pkg)
 
     msg = f"<CI INFO>: Listing RST files:"
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     for rst_file in os.listdir(package_paths.doc_folder):
-        docfx_logger.info(rst_file)
+        py2docfx_logger.info(rst_file)
         
     msg = "<CI INFO>: Running Sphinx build..."
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
 
     generate_conf(pkg, package_paths.doc_folder, CONF_TEMPLATE_DIR)
     run_converter(package_paths.doc_folder, package_paths.yaml_output_folder, sphinx_build_path, extra_package_path, executable=executable)

py2docfx/convert_prepare/get_source.py

@@ -73,7 +73,7 @@ def update_package_info(executable: str, pkg: PackageInfo, source_folder: str):
     )
 
 def get_source(executable: str, pkg: PackageInfo, cnt: int, vststoken=None, githubtoken=None):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     path_cnt = str(cnt)
     dist_dir = path.join(DIST_TEMP, path_cnt)
 
@@ -123,7 +123,7 @@ def get_source(executable: str, pkg: PackageInfo, cnt: int, vststoken=None, gith
         )
     else:
         msg = f"Unknown install type: {pkg.install_type}"
-        docfx_logger.error(msg)
+        py2docfx_logger.error(msg)
         raise ValueError()
 
     update_package_info(executable, pkg, source_folder)

py2docfx/convert_prepare/git.py

@@ -13,15 +13,15 @@ def clone(repo_location, branch, folder, extra_token=None):
     replacing
     https://apidrop.visualstudio.com/Content%20CI/_git/ReferenceAutomation?path=/Python/GetPackageCode.ps1&line=50&lineEnd=90&lineStartColumn=1&lineEndColumn=2&lineStyle=plain&_a=contents
     """
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     msg = "<CI INFO>: Cloning repo: {}...".format(repo_location)
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
 
     global repoMap
 
     if not test_url(repo_location, extra_token):
         msg = "Git repo address {} is not a valid URL.".format(repo_location)
-        docfx_logger.error(msg)
+        py2docfx_logger.error(msg)
         raise ValueError()
     else:
         # Remove http(s):// from url to record. Further avoid dup-clone.
@@ -62,14 +62,14 @@ def clone(repo_location, branch, folder, extra_token=None):
                 msg = "<CI INFO>: Repo {} successfully cloned in {}...".format(
                         repo_location, repoMap[pureURL]
                     )
-                docfx_logger.info(msg)
+                py2docfx_logger.info(msg)
             else:
                 raise ValueError(
                     "Branch {} doesn't exist in repo {}.".format(branch, repo_location)
                 )
         else:
             msg = "<CI INFO>: Repo already cloned in {}...".format(repoMap[pureURL])
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
 
         return repoMap[pureURL]
 
@@ -78,11 +78,11 @@ def test_url(url, extraHeader):
     """
     Test if the url is a valid git repo url
     """
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     params = ["git", "ls-remote", url]
     if extraHeader:
         msg = "Using extra header to test git repo url."
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
 
         params[1:1] = [
             "-c",
@@ -96,13 +96,13 @@ def test_url(url, extraHeader):
 
 
 def convertBranch(repo_url, branch, extraHeader):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     result = branch
     if not branch:
         msg = "Using empty branch of {}, going to use master branch instead.".format(
                 repo_url
             )
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
         result = "master"
     if result == "master":
         check_params = ["git", "ls-remote", "--heads", repo_url, "refs/heads/main"]
@@ -117,7 +117,7 @@ def convertBranch(repo_url, branch, extraHeader):
             msg = "Using master branch of {}, going to use main branch instead.".format(
                     repo_url
                 )
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
             result = "main"
     return result
 
@@ -129,7 +129,7 @@ def checkout(folder, branch):
     Replacing
     https://apidrop.visualstudio.com/Content%20CI/_git/ReferenceAutomation?path=/Python/PyCommon.ps1&line=707&lineEnd=763&lineStartColumn=1&lineEndColumn=2&lineStyle=plain&_a=contents
     """
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     remote = "origin"
 
     if ":" in branch:
@@ -158,7 +158,7 @@ def checkout(folder, branch):
 
         subprocess.run(["git", "-C", folder, "checkout", "--quiet", branch])
         msg = "<CI INFO>: Switched to branch {}.".format(branch)
-        docfx_logger.info(msg)
+        py2docfx_logger.info(msg)
 
 
 def commit_and_push(repo_location, folder, extra_token=None):

py2docfx/convert_prepare/package_info.py

@@ -16,7 +16,7 @@ class PackageInfo:
     
     @classmethod
     def report_error(cls, name, value, condition=None):
-        docfx_logger = get_logger(__name__)
+        py2docfx_logger = get_logger(__name__)
         if condition:
             message = "When {0}, found unexpected property of {1}, loaded value is: {2}".format(
                 condition, name, value
@@ -25,7 +25,7 @@ class PackageInfo:
             message = "Found unexpected property of {0}, loaded value is: {1}".format(
                 name, value
             )
-        docfx_logger.error(message)
+        py2docfx_logger.error(message)
         raise ValueError()
 
     @classmethod
@@ -60,14 +60,14 @@ class PackageInfo:
             package_info.folder = package_info_dict.get("folder", None)
 
             if not package_info.url:
-                docfx_logger = get_logger(__name__)
+                py2docfx_logger = get_logger(__name__)
                 if not package_info.folder:
                     msg = "When install_type is source_code, url or folder should be provided"
-                    docfx_logger.error(msg)
+                    py2docfx_logger.error(msg)
                     raise ValueError()
                 else:
                     msg = f'Read source code from local folder: {package_info.folder}'
-                    docfx_logger.info(msg)
+                    py2docfx_logger.info(msg)
 
         prefer_source_distribution = package_info_dict.get(
             "prefer_source_distribution", False
@@ -143,12 +143,12 @@ class PackageInfo:
         return (packageInstallName, pipInstallExtraOptions)
 
     def get_exluded_command(self) -> []:
-        docfx_logger = get_logger(__name__)
+        py2docfx_logger = get_logger(__name__)
         if hasattr(self, "path"):
             code_location = self.path.source_folder
         else:
             msg = "Should set source code location before build documents"
-            docfx_logger.error(msg)
+            py2docfx_logger.error(msg)
             raise ValueError()
         exclude_path = []
         if code_location:

py2docfx/convert_prepare/pip_utils.py

@@ -26,8 +26,8 @@ def download(package_name, path, extra_index_url=None, prefer_source_distributio
     else:
         download_param.append("--prefer-binary")
     output = subprocess.run(download_param, check=True, cwd=PACKAGE_ROOT, capture_output=True, text=True)
-    docfx_logger = get_logger(__name__)
-    log_subprocess_ouput(output, docfx_logger)
+    py2docfx_logger = get_logger(__name__)
+    log_subprocess_ouput(output, py2docfx_logger)
 
 
 def install(package_name, options):
@@ -36,8 +36,8 @@ def install(package_name, options):
         " ".join(pip_install_common_options + options), package_name
     ).split(" ")
     output = subprocess.run(install_param, check=True, cwd=PACKAGE_ROOT, capture_output=True, text=True)
-    docfx_logger = get_logger(__name__)
-    log_subprocess_ouput(output, docfx_logger)
+    py2docfx_logger = get_logger(__name__)
+    log_subprocess_ouput(output, py2docfx_logger)
 
 def install_in_exe(exe_path, package_name, options):
     # Installs a package from PyPI using pip.
@@ -45,8 +45,8 @@ def install_in_exe(exe_path, package_name, options):
         " ".join(pip_install_common_options + options), package_name
     ).split(" ")
     output = subprocess.run(install_param, check=True, cwd=PACKAGE_ROOT, capture_output=True, text=True)
-    docfx_logger = get_logger(__name__)
-    log_subprocess_ouput(output, docfx_logger)
+    py2docfx_logger = get_logger(__name__)
+    log_subprocess_ouput(output, py2docfx_logger)
     
 async def install_in_exe_async(exe_path, package_name, options):
     pip_cmd = ["-m", "pip", "install"]+ pip_install_common_options + options + [package_name]
@@ -60,9 +60,13 @@ async def run_async_subprocess(exe_path, cmd):
         stderr=asyncio.subprocess.PIPE
     )
     stdout, stderr = await process.communicate()
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     if process.returncode != 0:
-        docfx_logger.error(stderr.decode('utf-8'))
+        msg = stderr.decode('utf-8')
+        if msg != None and msg != "":
+            py2docfx_logger.error(msg)
         raise RuntimeError()
     else:
-        docfx_logger.info(stdout.decode('utf-8'))
+        msg = stdout.decode('utf-8')
+        if msg != None and msg != "":
+            py2docfx_logger.info(msg)

py2docfx/convert_prepare/post_process/merge_toc.py

@@ -8,7 +8,7 @@ TOC_FILE_PATH = "toc.yml"
 PACKAGE_TOC_FILE_PATH = "_build/docfx_yaml/toc.yml"
 def merge_toc(
         root_doc_path: str | os.PathLike, package_doc_path: str | os.PathLike):
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_logger(__name__)
     root_toc_path = os.path.join(root_doc_path, TOC_FILE_PATH)
     package_toc_path = os.path.join(package_doc_path, PACKAGE_TOC_FILE_PATH)
 
@@ -21,7 +21,7 @@ def merge_toc(
             if not toc_content.endswith("\n"):
                 root_toc_handle.write("\n")
     else:
-        docfx_logger.error(f"TOC content empty: {package_toc_path}")
+        py2docfx_logger.error(f"TOC content empty: {package_toc_path}")
         raise ValueError()
 
     # delete package toc.yml

py2docfx/convert_prepare/sphinx_caller.py

@@ -5,7 +5,7 @@ import sphinx.ext.apidoc as apidoc
 import subprocess
 
 from py2docfx import PACKAGE_ROOT
-from py2docfx.docfx_yaml.logger import get_logger, log_subprocess_ouput
+from py2docfx.docfx_yaml.logger import get_package_logger,log_subprocess_ouput
 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,
@@ -20,7 +20,7 @@ def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageI
     Replacing
     https://apidrop.visualstudio.com/Content%20CI/_git/ReferenceAutomation?path=/Python/build.ps1&line=110&lineEnd=126&lineStartColumn=1&lineEndColumn=14&lineStyle=plain&_a=contents
     """
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     subfolderList = [name for name in
                        os.listdir(source_code_path)
                        if os.path.isdir(os.path.join(source_code_path, name))
@@ -31,7 +31,7 @@ def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageI
         subfolderPath = os.path.join(source_code_path, subfolder)
         if os.path.isdir(subfolderPath):
             msg = "<CI INFO>: Subfolder path {}.".format(subfolderPath)
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
             if os.environ.get('LOG_LEVEL') == 'INFO':
                 args = [
                     "--module-first",
@@ -71,7 +71,7 @@ def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path
     Replacing
     https://apidrop.visualstudio.com/Content%20CI/_git/ReferenceAutomation?path=/Python/build.ps1&line=150&lineEnd=161&lineStartColumn=13&lineEndColumn=52&lineStyle=plain&_a=contents
     """
-    docfx_logger = get_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     outdir = os.path.join(out_path, "_build")
 
     # Sphinx/docutils have memory leak including linecaches, module-import-caches,
@@ -79,7 +79,7 @@ def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path
 
     if not sys.executable:
         msg = "Can't get the executable binary for the Python interpreter."
-        docfx_logger.error(msg)
+        py2docfx_logger.error(msg)
         raise ValueError()
     sphinx_param = [
         executable,
@@ -100,5 +100,5 @@ def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path
     else:
         env_tmp["PYTHONPATH"] = f"{extra_package_path}:{package_root_parent}:"
     output = subprocess.run(sphinx_param, check=True, cwd=PACKAGE_ROOT, env=env_tmp, capture_output=True ,text=True)
-    log_subprocess_ouput(output, docfx_logger)
+    log_subprocess_ouput(output, py2docfx_logger)
     return outdir

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -10,14 +10,12 @@ import sphinx.cmd.build
 from py2docfx.convert_prepare.generate_document import generate_document
 from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.source import Source
-from py2docfx.convert_prepare.tests.utils import prepare_log_folder
 
 def test_generate_document(tmp_path):
     """
     Test the generate_document function.
     """
     # init test case
-    prepare_log_folder()
     source_code_path = os.path.join("convert_prepare", "tests", "data", "generate_document")
     output_root = os.path.join(tmp_path, "output")
     shutil.copytree(source_code_path, os.path.join(tmp_path, "source", "0"))

py2docfx/convert_prepare/tests/test_sphinx_caller.py

@@ -7,7 +7,6 @@ import sphinx.cmd.build
 from py2docfx.convert_prepare.sphinx_caller import run_apidoc, run_converter
 from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.source import Source
-from py2docfx.convert_prepare.tests.utils import prepare_log_folder
 
 package_info = PackageInfo()
 
@@ -37,7 +36,6 @@ def test_run_apidoc(tmp_path):
 
 
 def test_run_converter(tmp_path):
-    prepare_log_folder()
     rst_path, source_code_path = init_paths(tmp_path)
     run_apidoc(rst_path, source_code_path, package_info.get_exluded_command(), package_info)
 

py2docfx/docfx_yaml/build_finished.py

@@ -92,7 +92,7 @@ def add_isrequired_if_needed(obj, key: str):
                 args['isRequired'] = True
 
 def get_merged_params(obj, info_field_data, key: str):
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     merged_params = []
     arg_params = obj.get('syntax', {}).get(key, [])
     if key in info_field_data[obj['uid']]:
@@ -101,7 +101,7 @@ def get_merged_params(obj, info_field_data, key: str):
         if arg_params and doc_params:
             if len(arg_params) - len(doc_params) > 0:
                 msg = f'Documented params don\'t match size of params:{obj["uid"]}' # CodeQL: [py/clear-text-logging-sensitive-data] There is no sensitive data in the print statement.
-                docfx_logger.warning(msg)
+                py2docfx_logger.warning(msg)
             doc_params = remove_params_without_id(doc_params)
             merged_params = merge_params(arg_params, doc_params)
     else:
@@ -186,7 +186,7 @@ def build_finished(app, exception):
     Output YAML on the file system.
     """
     
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
 
     def convert_class_to_enum_if_needed(obj):
         if (obj.get('inheritance'), None):
@@ -305,7 +305,7 @@ def build_finished(app, exception):
 
             if transformed_obj == None:
                 msg = f"Unknown yml, uid is: {uid}"
-                docfx_logger.warning(msg)
+                py2docfx_logger.warning(msg)
             else:
                 # save file
                 common.write_yaml(transformed_obj, out_file, mime)
@@ -314,7 +314,7 @@ def build_finished(app, exception):
     # Write TOC, the toc should include at least 1 
     if len(toc_yaml) == 0:
         msg = "No documentation for this module."
-        docfx_logger.error(msg)
+        py2docfx_logger.error(msg)
         raise RuntimeError()
 
     toc_file = os.path.join(normalized_outdir, 'toc.yml')

py2docfx/docfx_yaml/convert_class.py

@@ -6,7 +6,7 @@ from common import remove_empty_values, parse_references, convert_member, conver
 from logger import get_package_logger
 
 def convert_class(obj):
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     record = {}
     reference_mapping = {}
     old_class_object = {}
@@ -50,5 +50,5 @@ def convert_class(obj):
     new_class_object['attributes'] = list(map(convert_member_partial, attributes))
 
     msg = "class: " + new_class_object['uid'] # CodeQL: [py/clear-text-logging-sensitive-data] There is no sensitive data in the print statement.
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     return remove_empty_values(new_class_object)

py2docfx/docfx_yaml/convert_enum.py

@@ -7,7 +7,7 @@ def convert_enum(obj):
 
     :param obj: The object is generated from the Enum yaml file
     '''
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     record = {}
     reference_mapping = {}
     old_enum_object = {}
@@ -45,7 +45,7 @@ def convert_enum(obj):
     new_enum_object['fields'] = list(map(convert_fields, fields))
 
     msg = "enum: " + new_enum_object['uid'] # CodeQL: [py/clear-text-logging-sensitive-data] There is no sensitive data in the print statement.
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     return remove_empty_values(new_enum_object)
 
 

py2docfx/docfx_yaml/convert_module.py

@@ -6,7 +6,7 @@ from common import remove_empty_values, parse_references, convert_member
 from logger import get_package_logger
 
 def convert_module(obj, uid_type_mapping):
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     record = {}
     reference_mapping = {}
     old_object = {}
@@ -56,5 +56,5 @@ def convert_module(obj, uid_type_mapping):
 
     toreturn = remove_empty_values(new_object)
     msg = "module: " + toreturn['uid'] # CodeQL: [py/clear-text-logging-sensitive-data] There is no sensitive data in the print statement.
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     return toreturn

py2docfx/docfx_yaml/convert_package.py

@@ -6,7 +6,7 @@ from common import remove_empty_values, parse_references, convert_member
 from logger import get_package_logger
 
 def convert_package(obj, uid_type_mapping):
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     record = {}
     reference_mapping = {}
     old_object = {}
@@ -51,5 +51,5 @@ def convert_package(obj, uid_type_mapping):
 
     toreturn = remove_empty_values(new_object)
     msg = "package: " + toreturn['uid'] # CodeQL: [py/clear-text-logging-sensitive-data] There is no sensitive data in the print statement.
-    docfx_logger.info(msg)
+    py2docfx_logger.info(msg)
     return toreturn

py2docfx/docfx_yaml/logger.py

@@ -10,24 +10,32 @@ def get_log_level():
     
     return logging.ERROR
 
+def check_log_dir_exists(log_dir_path):
+    if not os.path.exists(log_dir_path):
+        os.makedirs(log_dir_path)
+
+def check_log_file_exists(log_file_path):
+    # create log file if it doesn't exist
+    if not os.path.exists(log_file_path):
+        with open(log_file_path, 'w') as f:
+            f.write('')
+
 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('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
-    
-    stream_handeler = logging.StreamHandler()
-    stream_handeler.setLevel(get_log_level())
+    file_handler.setFormatter(logging.Formatter('%(levelname)s - %(name)s - %(message)s'))
     
     logger.addHandler(file_handler)
-    logger.addHandler(stream_handeler)
     
     return logger
 
 def get_logger(logger_name: str):
-    file_name = os.path.join("logs", "log.txt")
+    log_folder_path = os.path.join("logs")
+    file_name = os.path.join(log_folder_path, "log.txt")
     
     file_logger = logging.getLogger(logger_name)
     file_logger.setLevel(logging.INFO)
-    
+    check_log_dir_exists(log_folder_path)
     if file_logger.hasHandlers():
         return file_logger
     
@@ -36,12 +44,13 @@ def get_logger(logger_name: str):
     return file_logger
 
 def get_package_logger(logger_name:str):
+    log_folder_path = os.path.join("logs", "package_logs")
     package_name = os.environ.get('PROCESSING_PACKAGE_NAME')
-    file_name = os.path.join("logs", "package_logs", f"{package_name}.txt")
+    file_name = os.path.join(log_folder_path, f"{package_name}.txt")
     
     file_logger = logging.getLogger(logger_name)
     file_logger.setLevel(logging.INFO)
-
+    check_log_dir_exists(log_folder_path)
     if file_logger.hasHandlers():
         return file_logger
 
@@ -57,12 +66,70 @@ def log_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: lo
         for msg in msgs:
             if msg is None or msg == "":
                 continue
-            if "WARNING:" in msg:
-                logger.warning(msg)
-            elif "ERROR:" in msg:
-                logger.error(msg)
-            else:
-                logger.info(msg)
+            logger.warning(msg)
     if subprocess_out.returncode != 0:
         logger.error(f"Subprocess failed with return code {subprocess_out.returncode}")
         raise RuntimeError()
+
+def counts_errors_warnings(log_file_path):
+    error_count = 0
+    warning_count = 0
+    with open(log_file_path, 'r', encoding='utf-8') as f:
+        lines = f.readlines()
+        for line in lines:
+            if line.startswith("ERROR -"):
+                error_count += 1
+            elif line.startswith("WARNING -"):
+                warning_count += 1
+    return warning_count, error_count
+
+def get_warning_error_count():
+    main_log_file_path = os.path.join("logs", "log.txt")
+    warning_count, error_count = counts_errors_warnings(main_log_file_path)
+    
+    log_folder_path = os.path.join("logs", "package_logs")
+    for log_file in os.listdir(log_folder_path):
+        log_file_path = os.path.join(log_folder_path, log_file)
+        warnings, errors = counts_errors_warnings(log_file_path)
+        warning_count += warnings
+        error_count += errors
+    
+    return warning_count, error_count
+
+def parse_log(log_file_path):
+    # reads the log file and parse it into a list of dictionaries
+    # the dictionary has the keys: 'name', 'level', 'message'
+    log_list = []
+    with open(log_file_path, 'r', encoding='utf-8') as f:
+        lines = f.readlines()
+        for line in lines:
+            if line.startswith("ERROR -"):
+                level = logging.INFO
+            elif line.startswith("WARNING -"):
+                level = logging.WARNING
+            elif line.startswith("INFO -"):
+                level = logging.INFO
+            else:
+                # put everything to the previous message
+                log_list[-1]['message'] += line
+                continue
+            temp_info = line.split(" - ")
+            logger_name = temp_info[1]
+            message = temp_info[2]
+            log_list.append({'name': logger_name, 'level': level, 'message': message})
+    return log_list
+
+def print_out_log_by_log_level(log_list, log_level):
+    for log in log_list:
+        if log['level'] >= log_level and log['message'] not in ['', '\n', '\r\n']:
+            print(log['message'])
+
+def output_log_by_log_level():
+    log_level = get_log_level()
+    main_log_file_path = os.path.join("logs", "log.txt")
+    print_out_log_by_log_level(parse_log(main_log_file_path), 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)

py2docfx/docfx_yaml/process_doctree.py

@@ -182,7 +182,7 @@ def _create_datam(app, cls, module, name, _type, obj, lines=None):
     """
     Build the data structure for an autodoc class
     """
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     if lines is None:
         lines = []
     short_name = name.split('.')[-1]
@@ -206,7 +206,7 @@ def _create_datam(app, cls, module, name, _type, obj, lines=None):
 
     except Exception as e:
         msg = "Can't get argspec for {}: {}. Exception: {}".format(type(obj), name, e)
-        docfx_logger.warning(msg)
+        py2docfx_logger.warning(msg)
 
     datam = {
         'module': module if module else None,
@@ -390,7 +390,7 @@ def process_docstring(app, _type, name, obj, options, lines):
     This function takes the docstring and indexes it into memory.
     """
     # Use exception as class
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     def check_convert_package_type(obj, _type):
         if _type == MODULE:
             filename = getattr(obj, '__file__', None)
@@ -411,7 +411,7 @@ def process_docstring(app, _type, name, obj, options, lines):
     cls, module = _get_cls_module(_type, name)
 
     if _type != PACKAGE and not module:
-        docfx_logger.warning('Unknown Type: %s' % _type)
+        py2docfx_logger.warning('Unknown Type: %s' % _type)
         return None
 
     if app.config.__contains__('autoclass_content') and app.config.autoclass_content.lower() == 'both':

py2docfx/docfx_yaml/translator.py

@@ -28,7 +28,7 @@ types_contain_attributes = {CLASS_TYPE, EXCEPTION_TYPE}
 
 def translator(app, docname, doctree):
 
-    docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__)
     transform_node = app.docfx_transform_node
 
     class_obj_cache = app.env.domains['py'].objects
@@ -58,14 +58,14 @@ def translator(app, docname, doctree):
         assert node.tagname == 'desc'
         if node.attributes['domain'] != 'py':
             msg = str('Skipping Domain Object (%s)' % node.attributes['domain'])
-            docfx_logger.info(msg)
+            py2docfx_logger.info(msg)
             return None, None
 
         try:
             module = node[0].attributes['module']
             full_name = node[0].attributes['fullname']
         except KeyError as e:
-            docfx_logger.error("There maybe some syntax error in docstring near: " + node.astext())
+            py2docfx_logger.error("There maybe some syntax error in docstring near: " + node.astext())
             raise e
 
         uid = '{module}.{full_name}'.format(module=module, full_name=full_name)

py2docfx/docfx_yaml/writer.py

@@ -604,7 +604,7 @@ class MarkdownTranslator(nodes.NodeVisitor):
         except ValueError as e:
             msg = "Image not found where expected {}".format(
                 node.attributes['uri'])
-            docfx_logger.warning(msg)
+            py2docfx_logger.warning(msg)
             raise nodes.SkipNode
         image_name = ''.join(image_name.split())
         self.new_state(0)
@@ -1085,10 +1085,10 @@ class MarkdownTranslator(nodes.NodeVisitor):
         self.add_text('<<')
 
     def visit_system_message(self, node):
-        docfx_logger = get_package_logger(__name__)
+        py2docfx_logger = get_package_logger(__name__)
         msg = str(bcolors.WARNING + "System message warnings: %s" %
               self.replace_special_unicode(node.astext()) + bcolors.ENDC)
-        docfx_logger.warning(msg)
+        py2docfx_logger.warning(msg)
         raise nodes.SkipNode
 
     def visit_comment(self, node):
@@ -1106,14 +1106,14 @@ class MarkdownTranslator(nodes.NodeVisitor):
         raise nodes.SkipNode
 
     def visit_math(self, node):
-        docfx_logger = get_package_logger(__name__)
+        py2docfx_logger = get_package_logger(__name__)
         msg = str(bcolors.WARNING +
         ('using "math" markup without a Sphinx math extension '
          'active, please use one of the math extensions '
          'described at http://sphinx-doc.org/ext/math.html. Source_path is: {}; Line is: {}').format(
             node.source if node.source else node.parent.source,
             node.line if node.line else node.parent.line))
-        docfx_logger.warning(msg)
+        py2docfx_logger.warning(msg)
         raise nodes.SkipNode
 
     visit_math_block = visit_math

{py2docfx-0.1.9.dev1926139.dist-info → py2docfx-0.1.9.dev1927662.dist-info}/METADATA

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

@@ -1,40 +1,39 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=0ZrOTlw1ORhfQliNWXKyCHcBlPFP5wOlTM2KUTvmdaM,14454
+py2docfx/__main__.py,sha256=UvFVxhJNQCn9EHyDfHPwDqJrlqGpoadFVIvDavaYpiI,14456
 py2docfx/convert_prepare/__init__.py,sha256=XxtxrP0kmW3ZBHIAoxsPDEHzcgeC0WSnole8Lk6CjKs,11
-py2docfx/convert_prepare/constants.py,sha256=9hj5Jn0PezeJ2FUGlIjJRtxMtZcgpRTtHnGlHNguWw0,81
-py2docfx/convert_prepare/environment.py,sha256=wlU_MQaLlFeKFydOX3QEIqO97dSFP_LmjUoHuNQLoXc,7194
+py2docfx/convert_prepare/constants.py,sha256=RC5DqNkqWvx4hb91FrajZ1R9dBFLxcPyoEJ43jdm36E,102
+py2docfx/convert_prepare/environment.py,sha256=7EmlodXVG0S5wnn0_VFPwPJ_3OHfJfGpN33SUL3HSRI,7233
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
-py2docfx/convert_prepare/generate_document.py,sha256=VDYOYHozKNN0cmHS_pCmAfZ_Z8kEYHedGZdXoMS0dY4,2848
-py2docfx/convert_prepare/get_source.py,sha256=bSezLy5q0flVqZLdVwcXrKIWHApGI6V3-7FP1bSScv4,5215
-py2docfx/convert_prepare/git.py,sha256=t08B7Te68CjV_G4U7nJZ1eDDA94y6uiYPvG2Qy9ELsU,6227
+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=AFCot6xJnZwPGkRsXwZl_EnSG60P5r_84lvSGp7LtB0,6263
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
 py2docfx/convert_prepare/pack.py,sha256=bptweiUnlk_jtu1FxgqlqvHVOCfvoeAqemxli6ep0-o,1231
-py2docfx/convert_prepare/package_info.py,sha256=GdR8EgQaYl0m2PxzDT2ozvesynFFdXumBQRNU4i_YqM,7603
+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=Wvql-MGrvBjTL_dehVY1lWhEpahteoVM1pp0jIChhLE,2779
+py2docfx/convert_prepare/pip_utils.py,sha256=SGWS07Rn0sWlZsr_fdGIqLFHsgma4UvsghjzkNogFkc,2930
 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=Fzc8pX6OZ96zTmWeMEoIhrBcgLF42_0BsWUEGQmyppQ,4401
+py2docfx/convert_prepare/sphinx_caller.py,sha256=KM5SanFk67Kkd3oVKzNN-5KCAAiyNUUgnJl5mDs-3kw,4439
 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/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=C5_PbutEXNOp3TPw-BGQ2w52Qu4_lDQ2t5VS7OT6iRE,1259
+py2docfx/convert_prepare/post_process/merge_toc.py,sha256=DPUvL6eS0Q4gcp_fdGgWQJeYmt0sa9voWnVe0O-2giM,1265
 py2docfx/convert_prepare/subpackage_merge/merge_root_package.py,sha256=uK96qL2asuSfo_3SZaoP8XZaUvjf5mNkr17JNbZR4Lg,1026
 py2docfx/convert_prepare/subpackage_merge/merge_toc.py,sha256=nkVqe8R0m8D6cyTYV7aIpMDXorvn4-LXfU_vIK_hJBg,1706
 py2docfx/convert_prepare/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/test_environment.py,sha256=1jONzb7saZN46h1GVI1jAvO8ws-UrjiQzl7bGEAvZBM,2131
-py2docfx/convert_prepare/tests/test_generate_document.py,sha256=SYOjWIO2fnIsvtEJnV2HbSOI8xoCryyjA6GH_MWeeYA,2667
+py2docfx/convert_prepare/tests/test_generate_document.py,sha256=Llt3szDunwmFKhHxc8fKuov_ci5rQokMcOgu5QNqt0U,2572
 py2docfx/convert_prepare/tests/test_get_source.py,sha256=TXaIPjKyA-KJopQBp8msUubT-rJLaq3llf1upfa10RM,7709
 py2docfx/convert_prepare/tests/test_pack.py,sha256=46JWMNzknIptDVs7D3CuxcmqBr_OKMmaw1br9H7wqco,4134
 py2docfx/convert_prepare/tests/test_package_info.py,sha256=hdNpAH9hlLF-cX9sKAu3cmiCtphX4USy9G_gWI_iaHo,3883
 py2docfx/convert_prepare/tests/test_params.py,sha256=x-UXun7mz4DA8zyHQCim6bTPdW4SUxxne13vn7EjJKw,2054
 py2docfx/convert_prepare/tests/test_post_process_merge_toc.py,sha256=YKOcn4_lf4syGsAvJ9BqpdUUc3SLfK4TiOX1lpXJT_Y,885
 py2docfx/convert_prepare/tests/test_source.py,sha256=LNFZtvjz6QhVLOxatjWokYCCcoSm0bhTikMF9KoTPIE,2025
-py2docfx/convert_prepare/tests/test_sphinx_caller.py,sha256=aEAnbva7wbZc8UHUjy8hBJ9uWrrqfkjnCq0a5uBaOWg,2707
+py2docfx/convert_prepare/tests/test_sphinx_caller.py,sha256=1ZR3uoNl1b_cpVRBcoqVpYry6tT4gNhYX_r5OpGC36M,2612
 py2docfx/convert_prepare/tests/test_subpackage.py,sha256=n0lCcdrTE1gkmmfGE85tSBMlpOEBszZafaHXffxo3Oc,4982
-py2docfx/convert_prepare/tests/utils.py,sha256=jdOQO2pHMwcksKYaK-2bQh-s6l4n8AxwonXBgvhpwrI,315
 py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/dummy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -56,25 +55,25 @@ 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=zco2YkveS-HMKJeCVKf_Pdjz9WMKH29KBwYXyqdCwU4,13808
+py2docfx/docfx_yaml/build_finished.py,sha256=BPsb8YiJjIwiUDwVpvsHjFjXnND2zwhM--LNsDwtrsM,13823
 py2docfx/docfx_yaml/build_init.py,sha256=lAw-fnBVQbySfZ7Sut_NpFQUjnqLOmnGQrTBBH2RXcg,1860
 py2docfx/docfx_yaml/common.py,sha256=UN1MUmjUoN1QSFDR1Cm_bfRuHr6FQiOe5VQV6s8xzjc,6841
-py2docfx/docfx_yaml/convert_class.py,sha256=92UFU_PnrPinagYIsArq71FXJX-swzXb2bIOdjaD0VY,2263
-py2docfx/docfx_yaml/convert_enum.py,sha256=p-WjaVRfPGT9OKEJZqpVimbDKy9lapdkio5EfspXhEE,2186
-py2docfx/docfx_yaml/convert_module.py,sha256=BdztG2HOAePpdma_uteudrRRgYODjb_6SV7z2yM3LSI,2253
-py2docfx/docfx_yaml/convert_package.py,sha256=1Q0TwYXBSpE9Dj-mAy9GTHygnw_CLzbFcYqqQSx8Tyw,2103
+py2docfx/docfx_yaml/convert_class.py,sha256=_s-NA1Iz4Pjnnxr5t_sD7VPXxbA011WEYn-LaEzb75g,2269
+py2docfx/docfx_yaml/convert_enum.py,sha256=QH0OkZq8pFi_nAXem6ddkO_7TSsoY2tz7_wxIwUjegI,2192
+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=VAP8PnrR5wk1prZqCOpTmLinA4iOFNgsetrYpDM7u18,2185
+py2docfx/docfx_yaml/logger.py,sha256=_XZRN43HfFhoi-1Kk0VztAUlzKRe-wuT4W85GAERRnE,4950
 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
-py2docfx/docfx_yaml/process_doctree.py,sha256=2SK6E7z-Uzlx07u9hqPX2GjzvqsGzN6zNoUEO2gx6WI,17845
+py2docfx/docfx_yaml/process_doctree.py,sha256=n2D-DCR7JmqVXm0oeuYZVnHIaHJZOegM8-kHXXx8IZ4,17857
 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=lGRT4aBaoU3aPXYcbSYb0cdzRSt1zdBpakEw99I-Vjs,25990
+py2docfx/docfx_yaml/translator.py,sha256=LSzNl4C-07bLbUZ5myfyWwh25cTNIIBih77Cp4tBWvo,25999
 py2docfx/docfx_yaml/utils.py,sha256=m5jC_qP2NKqzUx_z0zgZ-HAmxQdNTpJYKkL_F9vGeII,1555
 py2docfx/docfx_yaml/write_utils.py,sha256=q5qoYWw6GVDV8a3E8IxcSLWnN9sAer42VFRgadHBkgk,305
-py2docfx/docfx_yaml/writer.py,sha256=q4nhOLXJYS3t2CS9NZA0eqKvhPCUp6xlzPYLcfY75SU,35298
+py2docfx/docfx_yaml/writer.py,sha256=rB_mwwCJfDNATKGHKnHBzWqxaOGfIHOTtJ_f_qsGB90,35313
 py2docfx/docfx_yaml/yaml_builder.py,sha256=S3xty_ILxEUsw1J9VCwUkSLLYAUfQDm3fYbciv70gXc,2573
 py2docfx/docfx_yaml/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/docfx_yaml/tests/conftest.py,sha256=CykkZxaDZ-3a1EIQdGBieSmHL9FdyTE2xTJZe9QgKcg,1214
@@ -4177,7 +4176,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.dev1926139.dist-info/METADATA,sha256=wOIsTJ97TSqbbsve6SPzEzkjAVET3TFGnXu6Qq-WY8E,600
-py2docfx-0.1.9.dev1926139.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-py2docfx-0.1.9.dev1926139.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.9.dev1926139.dist-info/RECORD,,
+py2docfx-0.1.9.dev1927662.dist-info/METADATA,sha256=P_XMnj_2hUmGQfQ2Q0YaydAkyKbWiJR-ADOLE67CEdA,600
+py2docfx-0.1.9.dev1927662.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+py2docfx-0.1.9.dev1927662.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.9.dev1927662.dist-info/RECORD,,

py2docfx/convert_prepare/tests/utils.py

@@ -1,11 +0,0 @@
-import os
-import shutil
-
-def prepare_log_folder() -> None:
-    if not os.path.exists('logs'):
-        os.makedirs('logs')
-        os.makedirs(os.path.join('logs', 'package_logs'))
-    else:
-        shutil.rmtree('logs')
-        os.makedirs('logs')
-        os.makedirs(os.path.join('logs', 'package_logs'))