py2docfx 0.1.11.dev1987375__py3-none-any.whl → 0.1.11.dev1994698__py3-none-any.whl

py2docfx/__main__.py

@@ -36,7 +36,6 @@ async def donwload_package_generate_documents(
             py2docfxEnvironment.prepare_base_venv(required_package_list, github_token, ado_token))
 
     for idx, package in enumerate(package_info_list):
-        os.environ['PROCESSING_PACKAGE_NAME'] = package.name
         package_number = start_num + idx
         py2docfx_logger = py2docfxLogger.get_logger(__name__)
         msg = f"Processing package {package.name}, env_prepare_tasks: {len(env_prepare_tasks)}"
@@ -47,9 +46,9 @@ async def donwload_package_generate_documents(
         except Exception as e:
             msg = f"Failed to setup venv for package {package.name}: {e}"
             py2docfx_logger.error(msg)
-            raise
+            raise e
 
-        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_base_venv_exe())
@@ -101,10 +100,15 @@ def main(argv) -> int:
      github_token, ado_token,
      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)
     
+    # create log folder and package log folder
+    log_folder = os.path.join(PACKAGE_ROOT, LOG_FOLDER)
+    os.makedirs(log_folder)
+    os.makedirs(os.path.join(log_folder, "package_logs"))
+    
     py2docfxLogger.decide_global_log_level(verbose, show_warning)
     
     py2docfx_logger = py2docfxLogger.get_logger(__name__)
@@ -123,7 +127,6 @@ def main(argv) -> int:
         msg = f"An error occurred: {e}"
         py2docfx_logger.error(msg)
         fishish_up()
-        # asyncio.get_event_loop().stop()
         raise
     
     fishish_up()

py2docfx/convert_prepare/generate_document.py

@@ -10,7 +10,7 @@ from py2docfx.convert_prepare.subpackage import merge_subpackage_files
 
 CONF_TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "conf_templates")
 
-def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, sphinx_build_path: str, extra_package_path: str, executable=sys.executable):
+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
@@ -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(pkg.name, 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(pkg.name, 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

@@ -124,6 +124,6 @@ def get_source(executable: str, pkg: PackageInfo, cnt: int, vststoken=None, gith
     else:
         msg = f"Unknown install type: {pkg.install_type}"
         py2docfx_logger.error(msg)
-        raise ValueError()
+        raise ValueError(msg)
 
     update_package_info(executable, pkg, source_folder)

py2docfx/convert_prepare/git.py

@@ -22,7 +22,7 @@ def clone(repo_location, branch, folder, extra_token=None):
     if not test_url(repo_location, extra_token):
         msg = "Git repo address {} is not a valid URL.".format(repo_location)
         py2docfx_logger.error(msg)
-        raise ValueError()
+        raise ValueError(msg)
     else:
         # Remove http(s):// from url to record. Further avoid dup-clone.
         pureURL = re.sub("^\s*https?://", "", repo_location)

py2docfx/convert_prepare/package_info.py

@@ -26,7 +26,7 @@ class PackageInfo:
                 name, value
             )
         py2docfx_logger.error(message)
-        raise ValueError()
+        raise ValueError(message)
 
     @classmethod
     def parse_from(cls, dict, reading_required_packages=False):
@@ -64,7 +64,7 @@ class PackageInfo:
                 if not package_info.folder:
                     msg = "When install_type is source_code, url or folder should be provided"
                     py2docfx_logger.error(msg)
-                    raise ValueError()
+                    raise ValueError(msg)
                 else:
                     msg = f'Read source code from local folder: {package_info.folder}'
                     py2docfx_logger.info(msg)
@@ -149,7 +149,7 @@ class PackageInfo:
         else:
             msg = "Should set source code location before build documents"
             py2docfx_logger.error(msg)
-            raise ValueError()
+            raise ValueError(msg)
         exclude_path = []
         if code_location:
             exclude_path.append(os.path.join(code_location, "build/*"))

py2docfx/convert_prepare/post_process/merge_toc.py

@@ -21,8 +21,9 @@ def merge_toc(
             if not toc_content.endswith("\n"):
                 root_toc_handle.write("\n")
     else:
-        py2docfx_logger.error(f"TOC content empty: {package_toc_path}")
-        raise ValueError()
+        msg = f"TOC content empty: {package_toc_path}"
+        py2docfx_logger.error(msg)
+        raise ValueError(msg)
 
     # delete package toc.yml
     os.remove(package_toc_path)

py2docfx/convert_prepare/sphinx_caller.py

@@ -1,3 +1,4 @@
+import asyncio
 import os
 import subprocess
 import sys
@@ -49,7 +50,7 @@ def run_apidoc(package_name, rst_path, source_code_path, exclude_paths, package_
     return subpackages_rst_record
 
 
-def run_converter(package_name: str,
+async def run_converter(package_name: str,
                     rst_path,
                     out_path,
                     sphinx_build_path: str,
@@ -73,9 +74,8 @@ def run_converter(package_name: str,
     if not sys.executable:
         msg = "Can't get the executable binary for the Python interpreter."
         py2docfx_logger.error(msg)
-        raise ValueError()
+        raise ValueError(msg)
     sphinx_param = [
-        executable,
         sphinx_build_path,
         rst_path,
         outdir,
@@ -92,8 +92,22 @@ def run_converter(package_name: str,
         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=False, cwd=PACKAGE_ROOT, env=env_tmp, capture_output=True ,text=True)
-    log_subprocess_ouput(output, py2docfx_logger)
+    os.environ['PROCESSING_PACKAGE_NAME'] = package_name
+    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)
 
     return outdir

py2docfx/convert_prepare/tests/test_environment.py

@@ -12,7 +12,6 @@ from py2docfx.convert_prepare.environment import prepare_base_venv
 from py2docfx.convert_prepare.environment import get_base_venv_exe
 from py2docfx.convert_prepare.environment import get_base_venv_path
 from py2docfx.convert_prepare.package_info import PackageInfo
-pytest_plugins = ('pytest_asyncio',)
 
 @pytest.mark.asyncio
 async def test_venv_creation_package_install_remove():

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_sphinx_caller.py

@@ -1,5 +1,6 @@
 import os
 import shutil
+import pytest
 import sphinx
 import sphinx.cmd.build
 
@@ -34,8 +35,8 @@ def test_run_apidoc(tmp_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)
     package_name = "testcode"
     run_apidoc(package_name, rst_path, source_code_path, package_info.get_exluded_command(), package_info)
@@ -50,7 +51,7 @@ def test_run_converter(tmp_path):
         index_rst.write("")
 
     out_path = os.path.join(tmp_path, "out")
-    out_path = 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)
+    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/docfx_yaml/logger.py

@@ -34,7 +34,10 @@ 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()
@@ -47,12 +50,8 @@ 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)
-    
-    file_logger = setup_log_handlers(file_logger, file_name)
+
+    file_logger = setup_log_handlers(logger_name, file_name, log_folder_path)
 
     return file_logger
 
@@ -61,13 +60,9 @@ def get_package_logger(logger_name:str, package_name:str = None):
     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)
 
-    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 log_subprocess_ouput(subprocess_out: subprocess.CompletedProcess, logger: logging.Logger):

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
                     )
                 )

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

@@ -89,7 +89,7 @@ class ImdsCredential(MsalManagedIdentityClient):
                 # IMDS responded
                 _check_forbidden_response(ex)
                 self._endpoint_available = True
-            except Exception as ex:  # pylint:disable=broad-except
+            except Exception as ex:
                 error_message = (
                     "ManagedIdentityCredential authentication unavailable, no response from the IMDS endpoint."
                 )
@@ -119,7 +119,7 @@ class ImdsCredential(MsalManagedIdentityClient):
             raise ClientAuthenticationError(message=ex.message, response=ex.response) from ex
         except json.decoder.JSONDecodeError as ex:
             raise CredentialUnavailableError(message="ManagedIdentityCredential authentication unavailable.") from ex
-        except Exception as ex:  # pylint:disable=broad-except
+        except Exception as ex:
             # if anything else was raised, assume the endpoint is unavailable
             error_message = "ManagedIdentityCredential authentication unavailable, no response from the IMDS endpoint."
             raise CredentialUnavailableError(error_message) from ex

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

@@ -108,7 +108,7 @@ class ManagedIdentityCredential:
             self._credential = WorkloadIdentityCredential(
                 tenant_id=os.environ[EnvironmentVariables.AZURE_TENANT_ID],
                 client_id=workload_client_id,
-                file=os.environ[EnvironmentVariables.AZURE_FEDERATED_TOKEN_FILE],
+                token_file_path=os.environ[EnvironmentVariables.AZURE_FEDERATED_TOKEN_FILE],
                 **kwargs,
             )
         else:

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_internal/__init__.py

@@ -13,6 +13,7 @@ from .utils import (
     normalize_authority,
     resolve_tenant,
     validate_scope,
+    validate_subscription,
     validate_tenant_id,
     within_credential_chain,
     within_dac,
@@ -49,6 +50,7 @@ __all__ = [
     "normalize_authority",
     "resolve_tenant",
     "validate_scope",
+    "validate_subscription",
     "within_credential_chain",
     "within_dac",
     "wrap_exceptions",

py2docfx/venv/venv1/Lib/site-packages/azure/identity/_internal/auth_code_redirect_handler.py

@@ -28,7 +28,7 @@ class AuthCodeRedirectHandler(BaseHTTPRequestHandler):
 
         self.wfile.write(b"Authentication complete. You can close this window.")
 
-    def log_message(self, format, *args):  # pylint: disable=redefined-builtin,unused-argument
+    def log_message(self, format, *args):  # pylint: disable=redefined-builtin
         pass  # this prevents server dumping messages to stdout