py2docfx 0.1.20.dev2246325__py3-none-any.whl → 0.1.20.dev2246430__py3-none-any.whl

py2docfx/convert_prepare/diagnostics.py

@@ -0,0 +1,95 @@
+# diagnostics.py (or inline with your existing helper module)
+
+import os, re, json, textwrap
+from pathlib import Path
+from py2docfx import PACKAGE_ROOT
+from py2docfx.docfx_yaml.logger import get_logger, run_async_subprocess
+
+# Reuse your global install options if you like
+pip_install_common_options = ["--no-compile", "--disable-pip-version-check", "-vvv"]
+
+SECRET_PATTERN = re.compile(r"(//[^:/]+:)([^@]+)(@)")  # //user:pass@ → //user:****@
+
+def _mask(s: str) -> str:
+    if not s:
+        return s
+    return SECRET_PATTERN.sub(r"\1****\3", s)
+
+def _env_var(name: str) -> str:
+    val = os.environ.get(name)
+    return f"{name}={_mask(val)}" if val else f"{name}="
+
+async def pip_diag_bundle(
+    exe_path: str,
+    package_name: str,
+    extra_install_options: list[str],
+    report_dir: str = "pip_reports",
+    include_metadata_peek: bool = True,
+):
+    """
+    Collect a comprehensive diagnostic snapshot for pip in the current venv:
+      - pip/python version
+      - pip config (with origins)
+      - pip debug (platform & tags)
+      - env vars likely to affect pip
+      - pip list (packages in the venv)
+      - dry-run resolver report for the target package (JSON)
+      - optional: METADATA/Requires-Dist peek for any downloaded wheel
+    """
+    logger = get_logger(__name__)
+    out_dir = Path(PACKAGE_ROOT) / report_dir
+    out_dir.mkdir(parents=True, exist_ok=True)
+
+    # 0) Write a quick "header" file with env context (sanitized)
+    ctx = {
+        "cwd": str(PACKAGE_ROOT),
+        "PIP_INDEX_URL": os.environ.get("PIP_INDEX_URL"),
+        "PIP_EXTRA_INDEX_URL": os.environ.get("PIP_EXTRA_INDEX_URL"),
+        "HTTPS_PROXY": os.environ.get("HTTPS_PROXY") or os.environ.get("https_proxy"),
+        "HTTP_PROXY": os.environ.get("HTTP_PROXY") or os.environ.get("http_proxy"),
+    }
+    (out_dir / "00_env_context.txt").write_text(
+        "\n".join(_env_var(k) for k in ctx.keys()), encoding="utf-8"
+    )
+
+    # 1) pip/python versions
+    await run_async_subprocess(exe_path, ["-m", "pip", "--version"], logger, cwd=PACKAGE_ROOT)
+    await run_async_subprocess(exe_path, ["-c", "import sys; import platform; print(sys.executable); print(sys.version); print(platform.platform())"], logger, cwd=PACKAGE_ROOT)
+
+    # 2) Effective pip config
+    await run_async_subprocess(exe_path, ["-m", "pip", "config", "list", "-v"], logger, cwd=PACKAGE_ROOT)  # [2](https://pip.pypa.io/en/stable/topics/configuration.html)
+
+    # 3) Platform & wheel tag info
+    await run_async_subprocess(exe_path, ["-m", "pip", "debug"], logger, cwd=PACKAGE_ROOT)  # [3](https://pip.pypa.io/en/stable/cli/pip_debug/)
+
+    # 4) Snapshot venv packages (if any)
+    await run_async_subprocess(exe_path, ["-m", "pip", "list", "--format=freeze"], logger, cwd=PACKAGE_ROOT)
+
+    # 5) Resolver dry run with JSON report (no env changes)
+    report_path = out_dir / f"{package_name.replace('==', '-').replace(' ', '_')}.dryrun.report.json"
+    dry_run_cmd = (
+        ["-m", "pip", "install", "--dry-run", "--ignore-installed", "--report", str(report_path)]
+        + pip_install_common_options
+        + extra_install_options
+        + [package_name]
+    )
+    await run_async_subprocess(exe_path, dry_run_cmd, logger, cwd=PACKAGE_ROOT)  # [1](https://pip.pypa.io/en/stable/cli/pip_install/)
+
+    # 6) Optional: peek at any already-downloaded wheel METADATA for quick "Requires-Dist" visibility
+    if include_metadata_peek:
+        try:
+            import zipfile, glob
+            wheel_candidates = glob.glob("**/*.whl", recursive=True)
+            wheel_candidates = [w for w in wheel_candidates if "microsoft_teams_ai-2.0.0a1-" in w or "microsoft-teams-ai-2.0.0a1-" in w]
+            if wheel_candidates:
+                wheel_candidates.sort()
+                whl = wheel_candidates[-1]
+                with zipfile.ZipFile(whl) as zf:
+                    meta_name = [n for n in zf.namelist() if n.endswith(".dist-info/METADATA")][0]
+                    meta_text = zf.read(meta_name).decode("utf-8", "replace")
+                    (out_dir / "wheel_METADATA.txt").write_text(meta_text, encoding="utf-8")
+        except Exception as _:
+            # Non-fatal
+            pass
+
+    logger.info(f"[pip-diag] Wrote diagnostic bundle to: {out_dir}")

py2docfx/convert_prepare/pip_utils.py

@@ -1,23 +1,70 @@
+import os
 import sys
+from pathlib import Path
 
 from py2docfx import PACKAGE_ROOT
 from py2docfx.docfx_yaml.logger import get_logger, run_async_subprocess, run_async_subprocess_without_executable
 
+# NEW: diagnostics import
+try:
+    from diagnostics import pip_diag_bundle
+except Exception:
+    pip_diag_bundle = None  # tolerate missing diagnostics in non-CI runs
+
 PYPI = "pypi"
 
+# Keep your original common options; build commands as lists (no .split())
 pip_install_common_options = [
-    # "--no-cache-dir", # to reduce install duration after switching to each venv
     "--no-compile",
     "--disable-pip-version-check",
-    "-vvv"
+    "-vvv",
 ]
 
+# --- NEW: helpers -------------------------------------------------------------
+
+def _diag_enabled() -> bool:
+    # Enable by default in CI; allow opt-out with PY2DOCFX_PIP_DIAG=0
+    v = os.environ.get("PY2DOCFX_PIP_DIAG", "1").strip()
+    return v not in ("0", "false", "False", "")
+
+def _report_dir() -> str:
+    return os.environ.get("PY2DOCFX_PIP_REPORT_DIR", "pip_reports")
+
+def build_index_options(
+    index_url: str | None = None,
+    extra_index_urls: list[str] | None = None,
+    trusted_hosts: list[str] | None = None,
+    constraints_file: str | None = None,
+) -> list[str]:
+    """
+    Build pip CLI options for index and constraints.
+    Use this from call sites to pass consistent resolution settings.
+    """
+    opts: list[str] = []
+    if index_url:
+        opts += ["--index-url", index_url]
+    if extra_index_urls:
+        for u in extra_index_urls:
+            if u:
+                opts += ["--extra-index-url", u]
+    if trusted_hosts:
+        for h in trusted_hosts:
+            if h:
+                opts += ["--trusted-host", h]
+    if constraints_file:
+        opts += ["-c", constraints_file]
+    return opts
+
+# --- Existing functions with improvements ------------------------------------
+
 async def download(package_name, path, extra_index_url=None, prefer_source_distribution=True):
-    # Downloads a package from PyPI to the specified path using pip.
+    """
+    Downloads a package from PyPI (or other index) to the specified path using pip.
+    """
     download_param = ["pip", "download", "--dest", path, "--no-deps", package_name]
     if extra_index_url:
-        download_param.append("--extra-index-url")
-        download_param.append(extra_index_url)
+        # Note: For multiple mirrors use build_index_options and pass through install() signatures instead.
+        download_param.extend(["--extra-index-url", extra_index_url])
     if prefer_source_distribution:
         download_param.append("--no-binary=:all:")
     else:
@@ -26,23 +73,115 @@ async def download(package_name, path, extra_index_url=None, prefer_source_distr
     py2docfx_logger = get_logger(__name__)
     await run_async_subprocess_without_executable(download_param, py2docfx_logger, cwd=PACKAGE_ROOT)
 
+
 async def install(package_name, options):
-    # Installs a package from PyPI using pip.
-    install_param = "pip install {} {}".format(
-        " ".join(pip_install_common_options + options), package_name
-    ).split(" ")
+    """
+    Installs a package using the *current* Python (no explicit exe).
+    Retains the original signature; enable diagnostics via env var.
+    """
     py2docfx_logger = get_logger(__name__)
-    await run_async_subprocess_without_executable(install_param, py2docfx_logger, cwd=PACKAGE_ROOT)
+
+    # --- NEW: preflight diagnostics
+    if _diag_enabled() and pip_diag_bundle is not None:
+        try:
+            await pip_diag_bundle(
+                sys.executable,
+                package_name,
+                options,
+                report_dir=_report_dir(),
+            )
+        except Exception as _:
+            # Non-fatal: we still attempt the real install
+            pass
+
+    # Build the actual pip command (as list)
+    install_cmd = ["pip", "install"] + pip_install_common_options + options + [package_name]
+    try:
+        await run_async_subprocess_without_executable(install_cmd, py2docfx_logger, cwd=PACKAGE_ROOT)
+    except Exception:
+        # --- NEW: after-failure diagnostics
+        if _diag_enabled() and pip_diag_bundle is not None:
+            try:
+                await pip_diag_bundle(
+                    sys.executable,
+                    package_name,
+                    options,
+                    report_dir=os.path.join(_report_dir(), "after_failure"),
+                )
+            except Exception:
+                pass
+        raise
+
 
 async def install_in_exe(exe_path, package_name, options):
-    # Installs a package from PyPI using pip.
-    install_param = [exe_path] + "-m pip install {} {}".format(
-        " ".join(pip_install_common_options + options), package_name
-    ).split(" ")
+    """
+    Installs a package using the *given* Python executable path.
+    FIX: don't duplicate exe_path in argv; pass "-m pip ..." only.
+    """
     py2docfx_logger = get_logger(__name__)
-    await run_async_subprocess(exe_path, install_param, py2docfx_logger, cwd=PACKAGE_ROOT)
+
+    # --- NEW: preflight diagnostics
+    if _diag_enabled() and pip_diag_bundle is not None:
+        try:
+            await pip_diag_bundle(
+                exe_path,
+                package_name,
+                options,
+                report_dir=_report_dir(),
+            )
+        except Exception:
+            pass
+
+    # Correct pip invocation: exe_path runs, args start with -m pip
+    pip_cmd = ["-m", "pip", "install"] + pip_install_common_options + options + [package_name]
+    try:
+        await run_async_subprocess(exe_path, pip_cmd, py2docfx_logger, cwd=PACKAGE_ROOT)
+    except Exception:
+        # --- NEW: after-failure diagnostics
+        if _diag_enabled() and pip_diag_bundle is not None:
+            try:
+                await pip_diag_bundle(
+                    exe_path,
+                    package_name,
+                    options,
+                    report_dir=os.path.join(_report_dir(), "after_failure"),
+                )
+            except Exception:
+                pass
+        raise
+
 
 async def install_in_exe_async(exe_path, package_name, options):
-    pip_cmd = ["-m", "pip", "install"]+ pip_install_common_options + options + [package_name]
+    """
+    Keeps the original async install; now includes diagnostics.
+    """
     py2docfx_logger = get_logger(__name__)
-    await run_async_subprocess(exe_path, pip_cmd, py2docfx_logger)
+
+    # --- NEW: preflight diagnostics
+    if _diag_enabled() and pip_diag_bundle is not None:
+        try:
+            await pip_diag_bundle(
+                exe_path,
+                package_name,
+                options,
+                report_dir=_report_dir(),
+            )
+        except Exception:
+            pass
+
+    pip_cmd = ["-m", "pip", "install"] + pip_install_common_options + options + [package_name]
+    try:
+        await run_async_subprocess(exe_path, pip_cmd, py2docfx_logger, cwd=PACKAGE_ROOT)
+    except Exception:
+        # --- NEW: after-failure diagnostics
+        if _diag_enabled() and pip_diag_bundle is not None:
+            try:
+                await pip_diag_bundle(
+                    exe_path,
+                    package_name,
+                    options,
+                    report_dir=os.path.join(_report_dir(), "after_failure"),
+                )
+            except Exception:
+                pass
+        raise

{py2docfx-0.1.20.dev2246325.dist-info → py2docfx-0.1.20.dev2246430.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py2docfx
-Version: 0.1.20.dev2246325
+Version: 0.1.20.dev2246430
 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.20.dev2246325.dist-info → py2docfx-0.1.20.dev2246430.dist-info}/RECORD

@@ -3,6 +3,7 @@ py2docfx/__main__.py,sha256=NDKRx5RhLJP6Z6zFEdGZJje69jxPaGeHLU_2e5GYUO4,5958
 py2docfx/convert_prepare/__init__.py,sha256=XxtxrP0kmW3ZBHIAoxsPDEHzcgeC0WSnole8Lk6CjKs,11
 py2docfx/convert_prepare/arg_parser.py,sha256=7goU287AjAyKGd9d5QKcphMCQOrlPnKpQ_YtdwLSNT8,7618
 py2docfx/convert_prepare/constants.py,sha256=RC5DqNkqWvx4hb91FrajZ1R9dBFLxcPyoEJ43jdm36E,102
+py2docfx/convert_prepare/diagnostics.py,sha256=UYrpzriS9qNRJianh5xxucsUOR2Jd_8_n4e6lOTuDrY,4334
 py2docfx/convert_prepare/environment.py,sha256=CF8g2hnpwFXsTfvp1O8lwYpR848iCK8bDM2UAWqibEQ,7286
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
 py2docfx/convert_prepare/generate_document.py,sha256=iTOCMBwkfvZEj5dlEGUq4qynUodaYxJuIrG9R5eGk38,2949
@@ -14,7 +15,7 @@ py2docfx/convert_prepare/package_info.py,sha256=-zrMNeAkHxxzLRjBl1kRehUJy_ugc16y
 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=K433XE1aSczgdD2AUtOQOp4RtVaSMk3EUqAJ7qpj8t0,2089
+py2docfx/convert_prepare/pip_utils.py,sha256=6zK3f7k5bAK_kV07I5IfDEMApPjy5_e8wPHLwWwow88,6470
 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=iyalaxdhcMpiUsPEziEgH7v7cd5Zpx8KeD11iCULGbc,4696
@@ -3915,7 +3916,7 @@ py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/convert.py,sha256=0wSJMU0m
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/pack.py,sha256=o3iwjfRHl7N9ul-M2kHbewLJZnqBLAWf0tzUCwoiTMw,3078
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/tags.py,sha256=Rv2ySVb8-qX3osKp3uJgxcIMXkjt43XUD0-zvC6KvnY,4775
 py2docfx/venv/venv1/Lib/site-packages/wheel/_commands/unpack.py,sha256=Y_J7ynxPSoFFTT7H0fMgbBlVErwyDGcObgme5MBuz58,1021
-py2docfx-0.1.20.dev2246325.dist-info/METADATA,sha256=XNwfzjjkCWTCo72oKKPWNHmJTl0-4NjUy-rE_9ymMTQ,548
-py2docfx-0.1.20.dev2246325.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-py2docfx-0.1.20.dev2246325.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.20.dev2246325.dist-info/RECORD,,
+py2docfx-0.1.20.dev2246430.dist-info/METADATA,sha256=Kky-dbJ4q8dEb_tU_5BQC0iR-d8IpCYo7oxbAVbRZM4,548
+py2docfx-0.1.20.dev2246430.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+py2docfx-0.1.20.dev2246430.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.20.dev2246430.dist-info/RECORD,,