py2docfx 0.1.11.dev1985872__py3-none-any.whl → 0.1.11.dev1989123__py3-none-any.whl

py2docfx/__main__.py

@@ -38,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 = py2docfxLogger.get_package_logger(__name__)
+        py2docfx_logger = py2docfxLogger.get_logger(__name__)
         msg = f"Processing package {package.name}, env_prepare_tasks: {len(env_prepare_tasks)}"
         py2docfx_logger.info(msg)
 
@@ -49,9 +49,9 @@ async def donwload_package_generate_documents(
             py2docfx_logger.error(msg)
             raise
 
-        generate_document(package, output_root,
+        await generate_document(package, output_root,
                           py2docfxEnvironment.get_base_venv_sphinx_build_path(),
-                          py2docfxEnvironment.get_venv_package_path(idx), 
+                          py2docfxEnvironment.get_venv_package_path(idx),
                           py2docfxEnvironment.get_base_venv_exe())
 
         merge_toc(YAML_OUTPUT_ROOT, package.path.yaml_output_folder)
@@ -80,7 +80,7 @@ async def donwload_package_generate_documents(
             msg = f"Removing venv {idx-py2docfxEnvironment.VENV_BUFFER}"
             py2docfx_logger.info(msg)
             await env_remove_tasks[idx-py2docfxEnvironment.VENV_BUFFER]
-
+    
     if output_doc_folder:
         move_root_toc_to_target(YAML_OUTPUT_ROOT, output_doc_folder)
     
@@ -88,6 +88,12 @@ 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 fishish_up():
+    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()
+    
 def main(argv) -> int:
     # TODO: may need to purge pip cache
     (package_info_list,
@@ -116,12 +122,11 @@ def main(argv) -> int:
     except Exception as e:
         msg = f"An error occurred: {e}"
         py2docfx_logger.error(msg)
+        fishish_up()
+        # asyncio.get_event_loop().stop()
         raise
     
-    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()
+    fishish_up()
     return 0
 
 if __name__ == "__main__":

py2docfx/convert_prepare/environment.py

@@ -150,4 +150,4 @@ async def remove_environment(venv_num: int):
         else:
             msg = f"<CI ERROR>: Failed to remove venv{venv_num}. Error: {stderr.decode()}"
             py2docfx_logger.error(msg)
-            raise RuntimeError()
+            raise RuntimeError(msg)

py2docfx/convert_prepare/generate_document.py

@@ -10,8 +10,8 @@ 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):
-    py2docfx_logger = get_package_logger(__name__)
+async def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_build_path: str, extra_package_path: str, executable=sys.executable):
+    py2docfx_logger = get_package_logger(__name__, pkg.name)
     # Copy manual written RST from target doc repo
     package_paths = pkg.path
     if output_root:
@@ -33,7 +33,7 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_b
         msg = f"<CI INFO>: Generating RST files for {pkg.name}."
         py2docfx_logger.info(msg)
 
-        subpackages_rst_record = run_apidoc(package_paths.doc_folder, package_paths.source_folder,
+        subpackages_rst_record = run_apidoc(pkg.name, package_paths.doc_folder, package_paths.source_folder,
                                             exclude_paths, pkg)
 
     msg = f"<CI INFO>: Listing RST files:"
@@ -45,7 +45,7 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_b
     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)
+    await run_converter(pkg.name, package_paths.doc_folder, package_paths.yaml_output_folder, sphinx_build_path, extra_package_path, executable=executable)
     
     subpackages_path_record = {}
     if pkg.build_in_subpackage:
@@ -53,6 +53,6 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_b
         for (subpackage_name, subpackage_path) in subpackages_rst_record.items():
             subpackage_yaml_path = os.path.join(subpackages_yaml_path, subpackage_name)
             subpackages_path_record[subpackage_name] = subpackage_yaml_path
-            run_converter(subpackage_path, subpackage_yaml_path, sphinx_build_path, extra_package_path, executable=executable)
+            await run_converter(pkg.name, subpackage_path, subpackage_yaml_path, sphinx_build_path, extra_package_path, executable=executable)
 
         merge_subpackage_files(subpackages_path_record, package_paths.yaml_output_folder, pkg.name)

py2docfx/convert_prepare/get_source.py

@@ -102,7 +102,7 @@ def get_source(executable: str, pkg: PackageInfo, cnt: int, vststoken=None, gith
         )
         # unpack the downloaded wheel file.
         downloaded_dist_file = path.join(dist_dir, os.listdir(dist_dir)[0])
-        pack.unpack_dist(downloaded_dist_file)
+        pack.unpack_dist(pkg.name, downloaded_dist_file)
         os.remove(downloaded_dist_file)
         source_folder = path.join(
             path.dirname(downloaded_dist_file),
@@ -112,7 +112,7 @@ def get_source(executable: str, pkg: PackageInfo, cnt: int, vststoken=None, gith
         pip_utils.download(pkg.location, dist_dir, prefer_source_distribution=False)
         # unpack the downloaded dist file.
         downloaded_dist_file = path.join(dist_dir, os.listdir(dist_dir)[0])
-        pack.unpack_dist(downloaded_dist_file)
+        pack.unpack_dist(pkg.name, downloaded_dist_file)
         os.remove(downloaded_dist_file)
         if downloaded_dist_file.endswith(".tar.gz"):
             downloaded_dist_file = downloaded_dist_file.rsplit(".", maxsplit=1)[

py2docfx/convert_prepare/pack.py

@@ -6,9 +6,9 @@ import sys
 
 from py2docfx.docfx_yaml.logger import get_package_logger, log_subprocess_ouput
 
-def unpack_dist(dist_file):
+def unpack_dist(package_name, dist_file):
     if dist_file.endswith(".whl"):
-        unpack_wheel(dist_file)
+        unpack_wheel(package_name, dist_file)
     else:
         unpack_compressed(dist_file)
 
@@ -20,11 +20,11 @@ def unpack_compressed(file_path):
     shutil.unpack_archive(file_path, path.dirname(file_path))
 
 
-def unpack_wheel(file_path):
+def unpack_wheel(package_name, file_path):
     """
     Transform a wheel file to a folder containing source code
     """
-    py2docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__, package_name)
     command = [sys.executable,
                '-m',
                'wheel',

py2docfx/convert_prepare/sphinx_caller.py

@@ -1,6 +1,7 @@
+import asyncio
 import os
-import sys
 import subprocess
+import sys
 
 from py2docfx import PACKAGE_ROOT
 from py2docfx.docfx_yaml.logger import get_package_logger,log_subprocess_ouput
@@ -11,14 +12,14 @@ from py2docfx.convert_prepare.subpackage import (get_subpackages,
 
 DEBUG_SPHINX_FLAG = 'PY2DOCFX_DEBUG_SPHINX'
 
-def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageInfo):
+def run_apidoc(package_name, rst_path, source_code_path, exclude_paths, package_info: PackageInfo):
     """
     Run sphinx-apidoc to generate RST inside rst_path folder
 
     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
     """
-    py2docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__, package_name)
     subfolderList = [name for name in
                        os.listdir(source_code_path)
                        if os.path.isdir(os.path.join(source_code_path, name))
@@ -49,7 +50,13 @@ def run_apidoc(rst_path, source_code_path, exclude_paths, package_info: PackageI
     return subpackages_rst_record
 
 
-def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path: str, conf_path = None, executable = sys.executable):
+async def run_converter(package_name: str,
+                    rst_path,
+                    out_path,
+                    sphinx_build_path: str,
+                    extra_package_path: str,
+                    conf_path = None,
+                    executable = sys.executable):
     """
     Take rst files as input and run sphinx converter
 
@@ -58,7 +65,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
     """
-    py2docfx_logger = get_package_logger(__name__)
+    py2docfx_logger = get_package_logger(__name__, package_name)
     outdir = os.path.join(out_path, "_build")
 
     # Sphinx/docutils have memory leak including linecaches, module-import-caches,
@@ -69,7 +76,7 @@ def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path
         py2docfx_logger.error(msg)
         raise ValueError()
     sphinx_param = [
-        executable,
+        # executable,
         sphinx_build_path,
         rst_path,
         outdir,
@@ -86,6 +93,25 @@ def run_converter(rst_path, out_path, sphinx_build_path: str, extra_package_path
         env_tmp["PYTHONPATH"] = f"{extra_package_path};{package_root_parent};"
     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, py2docfx_logger)
+        
+    proc = await asyncio.create_subprocess_exec(
+        executable, *sphinx_param,
+        cwd=PACKAGE_ROOT,
+        env=env_tmp,
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE
+    )
+    stdout, stderr = await proc.communicate()
+    return_code = proc.returncode
+
+    if return_code == 0:
+        py2docfx_logger.info(f"{stdout}")
+        py2docfx_logger.info(f"{stderr}")
+    else:
+        py2docfx_logger.error(f"{stderr}")
+        raise subprocess.CalledProcessError(return_code, sphinx_param, stdout, stderr)
+        
+    # output = subprocess.run(sphinx_param, check=False, cwd=PACKAGE_ROOT, env=env_tmp, capture_output=True ,text=True)
+    # log_subprocess_ouput(output, py2docfx_logger)
+
     return outdir

py2docfx/convert_prepare/tests/test_environment.py

@@ -1,8 +1,6 @@
-import asyncio
 import os
 import shutil
 import pytest
-import sys
 
 from py2docfx.convert_prepare.environment import create_environment
 from py2docfx.convert_prepare.environment import remove_environment

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -4,6 +4,7 @@ Test the generate_document function.
 import os
 import sys
 import shutil
+import pytest
 import sphinx
 import sphinx.cmd.build
 
@@ -11,7 +12,8 @@ from py2docfx.convert_prepare.generate_document import generate_document
 from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.source import Source
 
-def test_generate_document(tmp_path):
+@pytest.mark.asyncio
+async def test_generate_document(tmp_path):
     """
     Test the generate_document function.
     """
@@ -42,7 +44,7 @@ def test_generate_document(tmp_path):
 
     # call the function
     
-    generate_document(package, output_root, sphinx_build_path = sphinx.cmd.build.__file__, extra_package_path = source_folder)
+    await generate_document(package, output_root, sphinx_build_path = sphinx.cmd.build.__file__, extra_package_path = source_folder)
 
     #assert the result
     yaml_path = os.path.join(yaml_output_folder, "_build", "docfx_yaml")

py2docfx/convert_prepare/tests/test_get_source.py

@@ -6,6 +6,7 @@ import shutil
 import stat
 import pytest
 import sys
+
 from py2docfx.convert_prepare import git
 from py2docfx.convert_prepare import get_source
 from py2docfx.convert_prepare.package_info import PackageInfo

py2docfx/convert_prepare/tests/test_pack.py

@@ -5,6 +5,7 @@ import subprocess
 import shutil
 import glob
 from os import path
+
 from py2docfx.convert_prepare.pack import unpack_compressed, unpack_wheel
 
 SRC_DIR = path.abspath("convert_prepare/tests/data/pack/")
@@ -107,7 +108,8 @@ def test_pack_unpack_wheel(tmp_path):
     wheel_path = path.join(tmp_path / "wheel", wheel_name)
 
     # unpack and assert the file list
-    unpack_wheel(wheel_path)
+    package_name = wheel_name.split("-")[0]
+    unpack_wheel(package_name, wheel_path)
     _assert_file_list_same(
         path.abspath("convert_prepare/tests/data/pack"),
         tmp_path / "wheel" / "foo-0.1",

py2docfx/convert_prepare/tests/test_params.py

@@ -1,4 +1,3 @@
-import pytest
 import os
 
 from py2docfx.convert_prepare.params import load_file_params, load_command_params

py2docfx/convert_prepare/tests/test_sphinx_caller.py

@@ -1,6 +1,6 @@
-import pytest
 import os
 import shutil
+import pytest
 import sphinx
 import sphinx.cmd.build
 
@@ -27,17 +27,19 @@ def init_paths(tmp_path):
 
 def test_run_apidoc(tmp_path):
     rst_path, source_code_path = init_paths(tmp_path)
-    run_apidoc(rst_path, source_code_path, package_info.get_exluded_command(), package_info)
+    package_name = "testcode"
+    run_apidoc(package_name, rst_path, source_code_path, package_info.get_exluded_command(), package_info)
 
     # List all files under rst_path
     rst_list = os.listdir(rst_path)
     assert "testcode.fakemodule.rst" in rst_list
     assert "testcode.exclude.rst" not in rst_list
 
-
-def test_run_converter(tmp_path):
+@pytest.mark.asyncio
+async def test_run_converter(tmp_path):
     rst_path, source_code_path = init_paths(tmp_path)
-    run_apidoc(rst_path, source_code_path, package_info.get_exluded_command(), package_info)
+    package_name = "testcode"
+    run_apidoc(package_name, rst_path, source_code_path, package_info.get_exluded_command(), package_info)
 
     # prepare conf.py, index.rst and docfx_yaml
     conf_path = os.path.abspath("convert_prepare/tests/data/sphinx_caller/conf.py")
@@ -49,7 +51,7 @@ def test_run_converter(tmp_path):
         index_rst.write("")
 
     out_path = os.path.join(tmp_path, "out")
-    out_path = run_converter(rst_path, out_path, sphinx_build_path = sphinx.cmd.build.__file__, extra_package_path = source_code_path, conf_path=rst_path)
+    out_path = await run_converter(package_name, rst_path, out_path, sphinx_build_path = sphinx.cmd.build.__file__, extra_package_path = source_code_path, conf_path=rst_path)
 
     if os.path.exists(out_path):
         yaml_list = os.listdir(os.path.join(out_path, "docfx_yaml"))

py2docfx/convert_prepare/tests/test_subpackage.py

@@ -1,5 +1,6 @@
 import shutil, os, yaml
 from os import path
+
 from py2docfx.convert_prepare.subpackage import (
     get_subpackages,
     move_rst_files_to_subfolder,

py2docfx/docfx_yaml/build_finished.py

@@ -315,7 +315,7 @@ def build_finished(app, exception):
     if len(toc_yaml) == 0:
         msg = "No documentation for this module."
         py2docfx_logger.error(msg)
-        raise RuntimeError()
+        raise RuntimeError(msg)
 
     toc_file = os.path.join(normalized_outdir, 'toc.yml')
     with open(toc_file, 'w') as writable:

py2docfx/docfx_yaml/logger.py

@@ -36,6 +36,8 @@ def check_log_file_exists(log_file_path):
 
 def setup_log_handlers(logger, log_file_name):
     check_log_file_exists(log_file_name)
+    if logger.hasHandlers():
+        logger.handlers.clear()
     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)
@@ -49,23 +51,20 @@ def get_logger(logger_name: str):
     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
     
     file_logger = setup_log_handlers(file_logger, file_name)
 
     return file_logger
 
-def get_package_logger(logger_name:str):
+def get_package_logger(logger_name:str, package_name:str = None):
     log_folder_path = os.path.join("logs", "package_logs")
-    package_name = os.environ.get('PROCESSING_PACKAGE_NAME')
+    if package_name is None:
+        package_name = os.environ.get('PROCESSING_PACKAGE_NAME')
     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
 
     file_logger = setup_log_handlers(file_logger, file_name)
     
@@ -81,8 +80,9 @@ def log_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: lo
                 continue
             logger.warning(msg)
     if subprocess_out.returncode != 0:
-        logger.error(f"Subprocess failed with return code {subprocess_out.returncode}")
-        raise RuntimeError()
+        msg = f"Subprocess failed with return code {subprocess_out.returncode}"
+        logger.error(msg)
+        raise RuntimeError(msg)
 
 def log_git_clone_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: logging.Logger):
     if subprocess_out.stdout:
@@ -94,8 +94,9 @@ def log_git_clone_subprocess_ouput(subprocess_out: subprocess.CompletedProcess,
                 continue
             logger.info(msg)
     if subprocess_out.returncode != 0:
-        logger.error(f"Subprocess failed with return code {subprocess_out.returncode}")
-        raise RuntimeError()
+        msg = f"Subprocess failed with return code {subprocess_out.returncode}"
+        logger.error(msg)
+        raise RuntimeError(msg)
 
 def counts_errors_warnings(log_file_path):
     error_count = 0
@@ -172,7 +173,7 @@ async def run_async_subprocess(exe_path, cmd):
         msg = stderr.decode('utf-8')
         if msg != None and msg != "":
             py2docfx_logger.error(msg)
-        raise RuntimeError()
+        raise RuntimeError(msg)
     else:
         msg = stdout.decode('utf-8')
         if msg != None and msg != "":

py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py

@@ -17,12 +17,5 @@ class SampleClass():
         """
         pass
 
-    def dummy_summary3(self):
-        """
-        This is a bare URL that shouldn't be transformed into a link
-        because it's in the exclusion list: https://management.azure.com
-        """
-        pass
-
     pass
     

py2docfx/docfx_yaml/tests/test_writer_uri.py

@@ -20,7 +20,6 @@ def test_http_link_in_summary_should_not_nest_parenthesis(app):
     class_summary_result = transform_node(app, doctree[1][1][0])
     method1_summary_result = transform_node(app, doctree[1][1][2][1])
     method2_summary_result = transform_node(app, doctree[1][1][4][1])
-    method3_summary_result = transform_node(app, doctree[1][1][6][1])
 
     # Assert
     # Shouldn't see something like [title]((link))
@@ -29,10 +28,7 @@ def test_http_link_in_summary_should_not_nest_parenthesis(app):
                                "We should not generate nested parenthesis causing docs validation warnings\n")
     method2_summary_expected = ("\n\n   This isn't a content issue link ([https://www.microsoft.com](https://www.microsoft.com))\n   "
                                 "Should expect a transformed Markdown link.\n")
-    method3_summary_expected = ("\n\n   This is a bare URL that shouldn't be transformed into a link\n   "
-                                "because it's in the exclusion list: `https://management.azure.com`\n")
     assert(class_summary_expected == class_summary_result)
     assert(method1_summary_expected == method1_summary_result)
     assert(method2_summary_expected == method2_summary_result)
-    assert(method3_summary_expected == method3_summary_result)
     

py2docfx/docfx_yaml/writer.py

@@ -184,15 +184,6 @@ class MarkdownTranslator(nodes.NodeVisitor):
     sectionchars = '*=-~"+`'
     xref_template = "<xref:{0}>"
 
-    # URLs that shouldn't be automatically rendered as hyperlinks if found bare. Included because they appear
-    # frequently, get flagged by the broken link validator and/or there's no value to the user in
-    # making them clickable links.
-    urls_that_shouldnt_be_rendered_as_links = {
-        "https://management.azure.com",
-        "https://management.chinacloudapi.cn",
-        "https://management.usgovcloudapi.net"
-        }
-
     def __init__(self, document, builder):
         self.invdata = []
         nodes.NodeVisitor.__init__(self, document)
@@ -936,10 +927,7 @@ class MarkdownTranslator(nodes.NodeVisitor):
                             match_content_issue_pattern = True
                             ref_string = node.attributes["refuri"]
                 if not match_content_issue_pattern:
-                    if inner_text == node.attributes['refuri'] and inner_text in cls.urls_that_shouldnt_be_rendered_as_links:
-                        ref_string = f'`{inner_text}`'
-                    else:
-                        ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
+                    ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
             else:
                 # only use id in class and func refuri if its id exists
                 # otherwise, remove '.html#' in refuri

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/authorization_code.py

@@ -85,7 +85,7 @@ class AuthorizationCodeCredential(GetTokenMixin):
           attribute gives a reason. Any error response from Microsoft Entra ID is available as the error's
           ``response`` attribute.
         """
-        # pylint:disable=useless-super-delegation
+
         return super(AuthorizationCodeCredential, self).get_token(
             *scopes, claims=claims, tenant_id=tenant_id, client_secret=self._client_secret, **kwargs
         )

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azd_cli.py

@@ -5,6 +5,7 @@
 
 from datetime import datetime
 import json
+import logging
 import os
 import re
 import shutil
@@ -19,12 +20,15 @@ from .. import CredentialUnavailableError
 from .._internal import resolve_tenant, within_dac, validate_tenant_id, validate_scope
 from .._internal.decorators import log_get_token
 
+
+_LOGGER = logging.getLogger(__name__)
+
 CLI_NOT_FOUND = (
     "Azure Developer CLI could not be found. "
     "Please visit https://aka.ms/azure-dev for installation instructions and then,"
     "once installed, authenticate to your Azure account using 'azd auth login'."
 )
-COMMAND_LINE = "azd auth token --output json --scope {}"
+COMMAND_LINE = ["auth", "token", "--output", "json"]
 EXECUTABLE_NAME = "azd"
 NOT_LOGGED_IN = "Please run 'azd auth login' from a command prompt to authenticate before using this credential."
 
@@ -160,8 +164,9 @@ class AzureDeveloperCliCredential:
         for scope in scopes:
             validate_scope(scope)
 
-        commandString = " --scope ".join(scopes)
-        command = COMMAND_LINE.format(commandString)
+        command_args = COMMAND_LINE.copy()
+        for scope in scopes:
+            command_args += ["--scope", scope]
         tenant = resolve_tenant(
             default_tenant=self.tenant_id,
             tenant_id=tenant_id,
@@ -169,8 +174,8 @@ class AzureDeveloperCliCredential:
             **kwargs,
         )
         if tenant:
-            command += " --tenant-id " + tenant
-        output = _run_command(command, self._process_timeout)
+            command_args += ["--tenant-id", tenant]
+        output = _run_command(command_args, self._process_timeout)
 
         token = parse_token(output)
         if not token:
@@ -236,15 +241,13 @@ def sanitize_output(output: str) -> str:
     return re.sub(r"\"token\": \"(.*?)(\"|$)", "****", output)
 
 
-def _run_command(command: str, timeout: int) -> str:
+def _run_command(command_args: List[str], timeout: int) -> str:
     # Ensure executable exists in PATH first. This avoids a subprocess call that would fail anyway.
-    if shutil.which(EXECUTABLE_NAME) is None:
+    azd_path = shutil.which(EXECUTABLE_NAME)
+    if not azd_path:
         raise CredentialUnavailableError(message=CLI_NOT_FOUND)
 
-    if sys.platform.startswith("win"):
-        args = ["cmd", "/c", command]
-    else:
-        args = ["/bin/sh", "-c", command]
+    args = [azd_path] + command_args
     try:
         working_directory = get_safe_working_dir()
 
@@ -257,13 +260,16 @@ def _run_command(command: str, timeout: int) -> str:
             "timeout": timeout,
         }
 
+        _LOGGER.debug("Executing subprocess with the following arguments %s", args)
         return subprocess.check_output(args, **kwargs)
     except subprocess.CalledProcessError as ex:
         # non-zero return from shell
         # Fallback check in case the executable is not found while executing subprocess.
-        if ex.returncode == 127 or ex.stderr.startswith("'azd' is not recognized"):
+        if ex.returncode == 127 or (ex.stderr is not None and ex.stderr.startswith("'azd' is not recognized")):
             raise CredentialUnavailableError(message=CLI_NOT_FOUND) from ex
-        if "not logged in, run `azd auth login` to login" in ex.stderr and "AADSTS" not in ex.stderr:
+        if ex.stderr is not None and (
+            "not logged in, run `azd auth login` to login" in ex.stderr and "AADSTS" not in ex.stderr
+        ):
             raise CredentialUnavailableError(message=NOT_LOGGED_IN) from ex
 
         # return code is from the CLI -> propagate its output
@@ -278,7 +284,7 @@ def _run_command(command: str, timeout: int) -> str:
         # failed to execute 'cmd' or '/bin/sh'
         error = CredentialUnavailableError(message="Failed to execute '{}'".format(args[0]))
         raise error from ex
-    except Exception as ex:  # pylint:disable=broad-except
+    except Exception as ex:
         # could be a timeout, for example
         error = CredentialUnavailableError(message="Failed to invoke the Azure Developer CLI")
         raise error from ex

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_credentials/azure_arc.py

@@ -54,7 +54,7 @@ def _get_secret_key(response: PipelineResponse) -> str:
     with open(key_file, "r", encoding="utf-8") as file:
         try:
             return file.read()
-        except Exception as error:  # pylint:disable=broad-except
+        except Exception as error:
             # user is expected to have obtained read permission prior to this being called
             raise ClientAuthenticationError(
                 message="Could not read file {} contents: {}".format(key_file, error)