py2docfx 0.1.11rc1981066__py3-none-any.whl → 0.1.11rc1997820__py3-none-any.whl

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
@@ -61,7 +62,8 @@ def test_update_package_info(init_package_info):
     assert package.name == "mock_package"
     assert package.version == "1.2.0"
 
-def test_get_source_git_clone(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_git_clone(init_package_info):
     """
     Test the git clone of get_source
     """
@@ -76,10 +78,11 @@ def test_get_source_git_clone(init_package_info):
     package.branch = "main"
     package.folder = None
     package.url = "https://github.com/Azure/azure-iot-hub-python"
-    get_source.get_source(sys.executable, package, 0)
+    await get_source.get_source(sys.executable, package, 0)
     assert git.status("source_repo/0") is True
 
-def test_get_source_dist_file_zip(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_dist_file_zip(init_package_info):
     """
     Test the zip dist file download of get_source
     """
@@ -92,12 +95,13 @@ def test_get_source_dist_file_zip(init_package_info):
     package.extra_index_url = None
     package.prefer_source_distribution = True
     package.location = "https://files.pythonhosted.org/packages/3e/71/f6f71a276e2e69264a97ad39ef850dca0a04fce67b12570730cb38d0ccac/azure-common-1.1.28.zip"
-    get_source.get_source(sys.executable, package, 1)
+    await get_source.get_source(sys.executable, package, 1)
     assert os.path.exists("dist_temp/1/azure-common-1.1.28")
     assert package.path.source_folder == os.path.join("dist_temp", "1", "azure-common-1.1.28")
     assert os.path.exists("dist_temp/1/azure-common-1.1.28.zip") is False
 
-def test_get_source_dist_file_whl(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_dist_file_whl(init_package_info):
     """
     Test the whl dist file download of get_source
     """
@@ -110,12 +114,13 @@ def test_get_source_dist_file_whl(init_package_info):
     package.extra_index_url = None
     package.prefer_source_distribution = True
     package.location = "https://files.pythonhosted.org/packages/62/55/7f118b9c1b23ec15ca05d15a578d8207aa1706bc6f7c87218efffbbf875d/azure_common-1.1.28-py2.py3-none-any.whl"
-    get_source.get_source(sys.executable, package, 2)
+    await get_source.get_source(sys.executable, package, 2)
     assert os.path.exists("dist_temp/2/azure_common-1.1.28")
     assert package.path.source_folder == os.path.join("dist_temp", "2", "azure_common-1.1.28")
     assert os.path.exists("dist_temp/2/azure_common-1.1.28-py2.py3-none-any.whl") is False
 
-def test_get_source_dist_file_tar(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_dist_file_tar(init_package_info):
     """
     Test the tar dist file download of get_source
     """
@@ -128,12 +133,13 @@ def test_get_source_dist_file_tar(init_package_info):
     package.extra_index_url = None
     package.prefer_source_distribution = True
     package.location = "https://files.pythonhosted.org/packages/fa/19/43a9eb812b4d6071fdc2c55640318f7eb5a1be8dbd3b6f9d96a1996e1bb6/azure-core-1.29.4.tar.gz"
-    get_source.get_source(sys.executable, package, 3)
+    await get_source.get_source(sys.executable, package, 3)
     assert os.path.exists("dist_temp/3/azure-core-1.29.4")
     assert package.path.source_folder == os.path.join("dist_temp", "3", "azure-core-1.29.4")
     assert os.path.exists("dist_temp/3/azure-core-1.29.4.tar.gz") is False
 
-def test_get_source_pip_whl(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_pip_whl(init_package_info):
     """
     Test the pip install of get_source with prefer_source_distribution = False
     """
@@ -145,12 +151,13 @@ def test_get_source_pip_whl(init_package_info):
     package.build_in_subpackage = False
     package.extra_index_url = None
     package.prefer_source_distribution = False
-    get_source.get_source(sys.executable, package, 4)
+    await get_source.get_source(sys.executable, package, 4)
     assert os.path.exists("dist_temp/4/azure_common-1.1.28")
     assert package.path.source_folder == os.path.join("dist_temp", "4", "azure_common-1.1.28")
     assert os.path.exists("dist_temp/4/azure_common-1.1.28-py2.py3-none-any.whl") is False
 
-def test_get_source_pip_zip(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_pip_zip(init_package_info):
     """
     Test the pip install of get_source with prefer_source_distribution = True
     """
@@ -162,12 +169,13 @@ def test_get_source_pip_zip(init_package_info):
     package.build_in_subpackage = False
     package.extra_index_url = None
     package.prefer_source_distribution = True
-    get_source.get_source(sys.executable, package, 5)
+    await get_source.get_source(sys.executable, package, 5)
     assert os.path.exists("dist_temp/5/azure-common-1.1.28")
     assert package.path.source_folder == os.path.join("dist_temp", "5", "azure-common-1.1.28")
     assert os.path.exists("dist_temp/5/azure-common-1.1.28.zip") is False
 
-def test_get_source_zip_file_at_position_0(init_package_info):
+@pytest.mark.asyncio
+async def test_get_source_zip_file_at_position_0(init_package_info):
     """
     Test the pip install of packages with zip or tar file at position 0 in the dirctory list
     """
@@ -179,7 +187,7 @@ def test_get_source_zip_file_at_position_0(init_package_info):
     package.build_in_subpackage = False
     package.extra_index_url = None
     package.prefer_source_distribution = True
-    get_source.get_source(sys.executable, package, 6)
+    await get_source.get_source(sys.executable, package, 6)
     assert os.path.exists("dist_temp/6/azure_template-0.1.0b3942895")
     assert package.path.source_folder == os.path.join("dist_temp", "6", "azure_template-0.1.0b3942895")
     assert os.path.exists("dist_temp/6/azure_template-0.1.0b3942895.tar.gz") is False

py2docfx/convert_prepare/tests/test_pack.py

@@ -5,6 +5,8 @@ import subprocess
 import shutil
 import glob
 from os import path
+import pytest
+
 from py2docfx.convert_prepare.pack import unpack_compressed, unpack_wheel
 
 SRC_DIR = path.abspath("convert_prepare/tests/data/pack/")
@@ -81,8 +83,8 @@ def test_pack_unpack_compressed(tmp_path):
         path.abspath("convert_prepare/tests/data/pack"), tmp_path / "gz", [], [str(gz_file_path)]
     )
 
-
-def test_pack_unpack_wheel(tmp_path):
+@pytest.mark.asyncio
+async def test_pack_unpack_wheel(tmp_path):
     def _prepare_wheel(target_path):
         subprocess.run(
             ["pip", "wheel", ".", "--wheel-dir", str(target_path / "wheel")],
@@ -107,7 +109,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]
+    await 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,5 +1,5 @@
-import pytest
 import os
+import pytest
 import shutil
 import sphinx
 import sphinx.cmd.build
@@ -24,20 +24,22 @@ def init_paths(tmp_path):
     package_info.name = 'testcode'
     return rst_path, destination
 
-
-def test_run_apidoc(tmp_path):
+@pytest.mark.asyncio
+async 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"
+    await 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"
+    await 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

@@ -34,8 +34,13 @@ def check_log_file_exists(log_file_path):
         with open(log_file_path, 'w') as f:
             f.write('')
 
-def setup_log_handlers(logger, log_file_name):
+def setup_log_handlers(logger_name, log_file_name, log_folder_path):
+    check_log_dir_exists(log_folder_path)
+    logger = logging.getLogger(logger_name)
+    logger.setLevel(logging.INFO)
     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)
@@ -45,57 +50,20 @@ def setup_log_handlers(logger, log_file_name):
 def get_logger(logger_name: str):
     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
-    
-    file_logger = setup_log_handlers(file_logger, file_name)
+
+    file_logger = setup_log_handlers(logger_name, file_name, log_folder_path)
 
     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)
-    
-    return file_logger
+    file_logger = setup_log_handlers(logger_name, file_name, log_folder_path)
 
-def log_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: logging.Logger):
-    if subprocess_out.stdout:
-        logger.info(subprocess_out.stdout)
-    if subprocess_out.stderr:
-        msgs = subprocess_out.stderr.split('\n')
-        for msg in msgs:
-            if msg is None or msg == "":
-                continue
-            logger.warning(msg)
-    if subprocess_out.returncode != 0:
-        logger.error(f"Subprocess failed with return code {subprocess_out.returncode}")
-        raise RuntimeError()
-
-def log_git_clone_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: logging.Logger):
-    if subprocess_out.stdout:
-        logger.info(subprocess_out.stdout)
-    if subprocess_out.stderr:
-        msgs = subprocess_out.stderr.split('\n')
-        for msg in msgs:
-            if msg is None or msg == "":
-                continue
-            logger.info(msg)
-    if subprocess_out.returncode != 0:
-        logger.error(f"Subprocess failed with return code {subprocess_out.returncode}")
-        raise RuntimeError()
+    return file_logger
 
 def counts_errors_warnings(log_file_path):
     error_count = 0
@@ -160,20 +128,53 @@ def output_log_by_log_level():
         log_file_path = os.path.join(package_logs_folder, log_file)
         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
-    )
+async def run_async_subprocess(exe_path, cmd, logger, cwd=None):
+    if cwd is None:
+        process = await asyncio.create_subprocess_exec(
+            exe_path, *cmd,
+            stdout=asyncio.subprocess.PIPE,
+            stderr=asyncio.subprocess.PIPE
+        )
+    else:
+        process = await asyncio.create_subprocess_exec(
+            exe_path, *cmd,
+            cwd=cwd,
+            stdout=asyncio.subprocess.PIPE,
+            stderr=asyncio.subprocess.PIPE,
+        )
+    stdout, stderr = await process.communicate()
+    if process.returncode != 0:
+        msg = stderr.decode('utf-8')
+        if msg != None and msg != "":
+            logger.error(msg)
+        raise subprocess.CalledProcessError(process.returncode, cmd, stdout, stderr)
+    else:
+        msg = stdout.decode('utf-8')
+        if msg != None and msg != "":
+            logger.info(msg)
+
+async def run_async_subprocess_without_executable(cmd, logger, cwd=None):
+    if cwd is None:
+        process = await asyncio.create_subprocess_exec(
+            *cmd,
+            stdout=asyncio.subprocess.PIPE,
+            stderr=asyncio.subprocess.PIPE
+        )
+    else:
+        process = await asyncio.create_subprocess_exec(
+            *cmd,
+            cwd=cwd,
+            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()
+            logger.error(msg)
+        raise subprocess.CalledProcessError(process.returncode, cmd, stdout, stderr)
     else:
         msg = stdout.decode('utf-8')
         if msg != None and msg != "":
-            py2docfx_logger.info(msg)
+            logger.info(msg)

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)

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

@@ -6,6 +6,7 @@ from datetime import datetime
 import json
 import os
 import re
+import logging
 import shutil
 import subprocess
 import sys
@@ -15,12 +16,22 @@ from azure.core.credentials import AccessToken, AccessTokenInfo, TokenRequestOpt
 from azure.core.exceptions import ClientAuthenticationError
 
 from .. import CredentialUnavailableError
-from .._internal import _scopes_to_resource, resolve_tenant, within_dac, validate_tenant_id, validate_scope
+from .._internal import (
+    _scopes_to_resource,
+    resolve_tenant,
+    within_dac,
+    validate_tenant_id,
+    validate_scope,
+    validate_subscription,
+)
 from .._internal.decorators import log_get_token
 
 
+_LOGGER = logging.getLogger(__name__)
+
 CLI_NOT_FOUND = "Azure CLI not found on path"
-COMMAND_LINE = "az account get-access-token --output json --resource {}"
+# COMMAND_LINE = "account get-access-token --output json --resource {}"
+COMMAND_LINE = ["account", "get-access-token", "--output", "json"]
 EXECUTABLE_NAME = "az"
 NOT_LOGGED_IN = "Please run 'az login' to set up an account"
 
@@ -31,6 +42,8 @@ class AzureCliCredential:
     This requires previously logging in to Azure via "az login", and will use the CLI's currently logged in identity.
 
     :keyword str tenant_id: Optional tenant to include in the token request.
+    :keyword str subscription: The name or ID of a subscription. Set this to acquire tokens for an account other
+        than the Azure CLI's current account.
     :keyword List[str] additionally_allowed_tenants: Specifies tenants in addition to the specified "tenant_id"
         for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to
         acquire tokens for any tenant the application can access.
@@ -50,12 +63,17 @@ class AzureCliCredential:
         self,
         *,
         tenant_id: str = "",
+        subscription: Optional[str] = None,
         additionally_allowed_tenants: Optional[List[str]] = None,
         process_timeout: int = 10,
     ) -> None:
         if tenant_id:
             validate_tenant_id(tenant_id)
+        if subscription:
+            validate_subscription(subscription)
+
         self.tenant_id = tenant_id
+        self.subscription = subscription
         self._additionally_allowed_tenants = additionally_allowed_tenants or []
         self._process_timeout = process_timeout
 
@@ -135,7 +153,7 @@ class AzureCliCredential:
             validate_scope(scope)
 
         resource = _scopes_to_resource(*scopes)
-        command = COMMAND_LINE.format(resource)
+        command_args = COMMAND_LINE + ["--resource", resource]
         tenant = resolve_tenant(
             default_tenant=self.tenant_id,
             tenant_id=tenant_id,
@@ -143,8 +161,11 @@ class AzureCliCredential:
             **kwargs,
         )
         if tenant:
-            command += " --tenant " + tenant
-        output = _run_command(command, self._process_timeout)
+            command_args += ["--tenant", tenant]
+
+        if self.subscription:
+            command_args += ["--subscription", self.subscription]
+        output = _run_command(command_args, self._process_timeout)
 
         token = parse_token(output)
         if not token:
@@ -211,15 +232,13 @@ def sanitize_output(output: str) -> str:
     return re.sub(r"\"accessToken\": \"(.*?)(\"|$)", "****", 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:
+    az_path = shutil.which(EXECUTABLE_NAME)
+    if not az_path:
         raise CredentialUnavailableError(message=CLI_NOT_FOUND)
 
-    if sys.platform.startswith("win"):
-        args = ["cmd", "/c", command]
-    else:
-        args = ["/bin/sh", "-c", command]
+    args = [az_path] + command_args
     try:
         working_directory = get_safe_working_dir()
 
@@ -231,13 +250,16 @@ def _run_command(command: str, timeout: int) -> str:
             "timeout": timeout,
             "env": dict(os.environ, AZURE_CORE_NO_COLOR="true"),
         }
+        _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("'az' is not recognized"):
+        if ex.returncode == 127 or (ex.stderr is not None and ex.stderr.startswith("'az' is not recognized")):
             raise CredentialUnavailableError(message=CLI_NOT_FOUND) from ex
-        if ("az login" in ex.stderr or "az account set" in ex.stderr) and "AADSTS" not in ex.stderr:
+        if ex.stderr is not None and (
+            ("az login" in ex.stderr or "az account set" 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
@@ -252,7 +274,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 CLI")
         raise error from ex

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

@@ -192,7 +192,7 @@ def run_command_line(command_line: List[str], timeout: int) -> str:
             proc = start_process(command_line)
             stdout, stderr = proc.communicate(**kwargs)
 
-    except Exception as ex:  # pylint:disable=broad-except
+    except Exception as ex:
         # failed to execute "cmd" or "/bin/sh", or timed out; PowerShell and Az.Account may or may not be installed
         # (handling Exception here because subprocess.SubprocessError and .TimeoutExpired were added in 3.3)
         if proc and not proc.returncode:

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

@@ -37,8 +37,8 @@ class ChainedTokenCredential:
     """A sequence of credentials that is itself a credential.
 
     Its :func:`get_token` method calls ``get_token`` on each credential in the sequence, in order, returning the first
-    valid token received. For more information, see
-    https://aka.ms/azsdk/python/identity/credential-chains#chainedtokencredential-overview.
+    valid token received. For more information, see `ChainedTokenCredential overview
+    <"https://aka.ms/azsdk/python/identity/credential-chains#chainedtokencredential-overview">`__.
 
     :param credentials: credential instances to form the chain
     :type credentials: ~azure.core.credentials.TokenCredential

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

@@ -24,8 +24,9 @@ _LOGGER = logging.getLogger(__name__)
 
 
 class DefaultAzureCredential(ChainedTokenCredential):
-    """A credential capable of handling most Azure SDK authentication scenarios. See
-    https://aka.ms/azsdk/python/identity/credential-chains#usage-guidance-for-defaultazurecredential.
+    """A credential capable of handling most Azure SDK authentication scenarios. For more information, See
+    `Usage guidance for DefaultAzureCredential
+    <"https://aka.ms/azsdk/python/identity/credential-chains#usage-guidance-for-defaultazurecredential">`__.
 
     The identity it uses depends on the environment. When an access token is needed, it requests one using these
     identities in turn, stopping when one provides a token:
@@ -153,7 +154,7 @@ class DefaultAzureCredential(ChainedTokenCredential):
                     WorkloadIdentityCredential(
                         client_id=cast(str, client_id),
                         tenant_id=workload_identity_tenant_id,
-                        file=os.environ[EnvironmentVariables.AZURE_FEDERATED_TOKEN_FILE],
+                        token_file_path=os.environ[EnvironmentVariables.AZURE_FEDERATED_TOKEN_FILE],
                         **kwargs
                     )
                 )