py2docfx 0.1.9.dev1897607__py3-none-any.whl → 0.1.9.dev1917798__py3-none-any.whl

py2docfx/convert_prepare/environment.py

@@ -1,6 +1,7 @@
 import subprocess
 import asyncio
 import os
+import sys
 from py2docfx import PACKAGE_ROOT
 from py2docfx.convert_prepare.package_info import PackageInfo
 from py2docfx.convert_prepare.get_source import get_source
@@ -11,7 +12,7 @@ VENV_REQUIREMENT_MODULES = ["setuptools", "wheel"] # to support running setup.py
 VENV_DIR = "venv"
 VENV_BUFFER = 10
 VENV_DELETE_BUFFER = 10
-PIP_INSTALL_COMMAND = ["-m", "pip", "install", "--upgrade"]
+PIP_INSTALL_COMMAND = ["-m", "pip", "install", "--upgrade"] 
 
 PIP_INSTALL_VENV_COMMON_OPTIONS = [
     "--quiet",
@@ -53,16 +54,31 @@ def get_base_venv_path() -> str:
     return os.path.join(PACKAGE_ROOT, VENV_DIR, "basevenv")
 
 def get_venv_exe(venv_num: int) -> str:
-    return os.path.join(get_venv_path(venv_num), "Scripts", "python.exe")
+    if os.name == 'nt':
+        return os.path.join(get_venv_path(venv_num), "Scripts", "python.exe")
+    else:
+        return os.path.join(get_venv_path(venv_num), "bin", "python3")
 
 def get_base_venv_exe() -> str:
-    return os.path.join(get_base_venv_path(), "Scripts", "python.exe")
+    if os.name == 'nt':
+        return os.path.join(get_base_venv_path(), "Scripts", "python.exe")
+    else:
+        return os.path.join(get_base_venv_path(), "bin", "python3")
 
 def get_venv_package_path(venv_num: int) -> str:
-    return os.path.join(get_venv_path(venv_num), "Lib", "site-packages")
+    if os.name == 'nt':  # Windows
+        return os.path.join(get_venv_path(venv_num), "Lib", "site-packages")
+    else:  # Linux and other Unix-like systems
+        python_version = f"python{sys.version_info.major}.{sys.version_info.minor}" # venv version should be same as native
+        return os.path.join(get_venv_path(venv_num), "lib", python_version, "site-packages")
 
 def get_base_venv_sphinx_build_path() -> str:
-    return os.path.join(get_base_venv_path(), "Lib", "site-packages", "sphinx", "cmd", "build.py")
+    if os.name == 'nt':  # Windows
+        return os.path.join(get_base_venv_path(), "Lib", "site-packages", "sphinx", "cmd", "build.py")
+    else: # Linux and other Unix-like systems
+        python_version = f"python{sys.version_info.major}.{sys.version_info.minor}" # venv version should be same as native
+        return os.path.join(get_base_venv_path(), "lib", python_version, "site-packages", "sphinx", "cmd", "build.py")
+        
 
 async def install_converter_requirement_async(executable: str):
     pip_cmd = PIP_INSTALL_COMMAND + PIP_INSTALL_VENV_COMMON_OPTIONS + REQUIREMENT_MODULES
@@ -79,7 +95,10 @@ async def install_required_packages(
         await(await asyncio.create_subprocess_exec(executable, *pip_cmd)).wait()
 
 async def create_environment(venv_path: int):
-    await (await asyncio.create_subprocess_exec("python", "-m", "venv", venv_path)).wait()
+    if os.name == 'nt':
+        await (await asyncio.create_subprocess_exec("python", "-m", "venv", venv_path)).wait()
+    else: # On linux the default command name is
+        await (await asyncio.create_subprocess_exec("python3", "-m", "venv", venv_path)).wait()
 
 async def prepare_base_venv(required_package_list: list[PackageInfo], github_token: str, ado_token: str):
     print(f"<CI INFO>: Creating basevenv...")

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -16,9 +16,9 @@ def test_generate_document(tmp_path):
     Test the generate_document function.
     """
     # init test case
-    source_code_path = "convert_prepare\\tests\\data\\generate_document"
+    source_code_path = os.path.join("convert_prepare", "tests", "data", "generate_document")
     output_root = os.path.join(tmp_path, "output")
-    shutil.copytree(source_code_path, os.path.join(tmp_path, "source\\0"))
+    shutil.copytree(source_code_path, os.path.join(tmp_path, "source", "0"))
     package = PackageInfo()
     package.name = "azure-dummy-sourcecode"
     package.exclude_path = ["test*", "example*", "sample*", "doc*"]
@@ -27,7 +27,7 @@ def test_generate_document(tmp_path):
     package.build_in_subpackage = False
     package.extra_index_url = None
     package.prefer_source_distribution = False
-    source_folder = os.path.join(tmp_path, "source\\0\\azure-dummy-sourcecode")
+    source_folder = os.path.join(tmp_path, "source", "0", "azure-dummy-sourcecode")
     yaml_output_folder = os.path.join(tmp_path, "yaml_output")
     package.path = Source(
         source_folder=source_folder, yaml_output_folder=yaml_output_folder, package_name=package.name
@@ -45,7 +45,7 @@ def test_generate_document(tmp_path):
     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")
+    yaml_path = os.path.join(yaml_output_folder, "_build", "docfx_yaml")
     assert os.path.exists(yaml_path)
     assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.foo.foo.yml"))
     assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.boo.boo.yml"))

py2docfx/convert_prepare/tests/test_get_source.py

@@ -94,7 +94,7 @@ def test_get_source_dist_file_zip(init_package_info):
     package.location = "https://files.pythonhosted.org/packages/3e/71/f6f71a276e2e69264a97ad39ef850dca0a04fce67b12570730cb38d0ccac/azure-common-1.1.28.zip"
     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 == "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):
@@ -112,7 +112,7 @@ def test_get_source_dist_file_whl(init_package_info):
     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)
     assert os.path.exists("dist_temp/2/azure_common-1.1.28")
-    assert package.path.source_folder == "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):
@@ -130,7 +130,7 @@ def test_get_source_dist_file_tar(init_package_info):
     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)
     assert os.path.exists("dist_temp/3/azure-core-1.29.4")
-    assert package.path.source_folder == "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):
@@ -147,7 +147,7 @@ def test_get_source_pip_whl(init_package_info):
     package.prefer_source_distribution = False
     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 == "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):
@@ -164,7 +164,7 @@ def test_get_source_pip_zip(init_package_info):
     package.prefer_source_distribution = True
     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 == "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):
@@ -181,5 +181,5 @@ def test_get_source_zip_file_at_position_0(init_package_info):
     package.prefer_source_distribution = True
     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 == "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_params.py

@@ -48,7 +48,7 @@ def test_load_command_params():
 def test_load_file_params():
     # get absolute path of test json
     path = os.path.dirname(os.path.abspath(__file__))
-    relative_path = "data\\params\\test.json"
+    relative_path = os.path.join("data", "params", "test.json")
     full_path = os.path.join(path, relative_path)
     json_info = load_file_params(full_path)
 

py2docfx/convert_prepare/tests/test_sphinx_caller.py

@@ -13,12 +13,12 @@ package_info = PackageInfo()
 def init_paths(tmp_path):
     rst_path = os.path.join(tmp_path, "test_rst")
 
-    source_code_path = os.path.abspath("convert_prepare\\tests\\data\\sphinx_caller\\test_source_code")
+    source_code_path = os.path.abspath("convert_prepare/tests/data/sphinx_caller/test_source_code")
     destination = os.path.join(tmp_path, "test_source_code")
     shutil.copytree(source_code_path, destination)
 
     package_info.code_location = destination
-    package_info.exclude_path = ["testcode\\exclude\\*"]
+    package_info.exclude_path = ["testcode/exclude/*"]
     package_info.path = Source(source_folder=destination, yaml_output_folder=rst_path, package_name="testcode")
     package_info.build_in_subpackage = False
     package_info.name = 'testcode'
@@ -40,7 +40,7 @@ def test_run_converter(tmp_path):
     run_apidoc(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")
+    conf_path = os.path.abspath("convert_prepare/tests/data/sphinx_caller/conf.py")
     destination = os.path.join(rst_path)
     shutil.copy(conf_path, destination)
     docfx_yaml_path = os.path.abspath("docfx_yaml")

py2docfx/venv/basevenv/Lib/site-packages/_distutils_hack/__init__.py

@@ -3,8 +3,7 @@ import os
 import sys
 
 report_url = (
-    "https://github.com/pypa/setuptools/issues/new?"
-    "template=distutils-deprecation.yml"
+    "https://github.com/pypa/setuptools/issues/new?template=distutils-deprecation.yml"
 )
 
 
@@ -91,7 +90,7 @@ def do_override():
 
 
 class _TrivialRe:
-    def __init__(self, *patterns):
+    def __init__(self, *patterns) -> None:
         self._patterns = patterns
 
     def match(self, string):

py2docfx/venv/basevenv/Lib/site-packages/packaging/__init__.py

@@ -6,10 +6,10 @@ __title__ = "packaging"
 __summary__ = "Core utilities for Python packages"
 __uri__ = "https://github.com/pypa/packaging"
 
-__version__ = "24.1"
+__version__ = "24.2"
 
 __author__ = "Donald Stufft and individual contributors"
 __email__ = "donald@stufft.io"
 
 __license__ = "BSD-2-Clause or Apache-2.0"
-__copyright__ = "2014 %s" % __author__
+__copyright__ = f"2014 {__author__}"

py2docfx/venv/basevenv/Lib/site-packages/packaging/_elffile.py

@@ -48,8 +48,8 @@ class ELFFile:
 
         try:
             ident = self._read("16B")
-        except struct.error:
-            raise ELFInvalid("unable to parse identification")
+        except struct.error as e:
+            raise ELFInvalid("unable to parse identification") from e
         magic = bytes(ident[:4])
         if magic != b"\x7fELF":
             raise ELFInvalid(f"invalid magic: {magic!r}")
@@ -67,11 +67,11 @@ class ELFFile:
                 (2, 1): ("<HHIQQQIHHH", "<IIQQQQQQ", (0, 2, 5)),  # 64-bit LSB.
                 (2, 2): (">HHIQQQIHHH", ">IIQQQQQQ", (0, 2, 5)),  # 64-bit MSB.
             }[(self.capacity, self.encoding)]
-        except KeyError:
+        except KeyError as e:
             raise ELFInvalid(
                 f"unrecognized capacity ({self.capacity}) or "
                 f"encoding ({self.encoding})"
-            )
+            ) from e
 
         try:
             (

py2docfx/venv/basevenv/Lib/site-packages/packaging/_manylinux.py

@@ -164,6 +164,7 @@ def _parse_glibc_version(version_str: str) -> tuple[int, int]:
             f"Expected glibc version with 2 components major.minor,"
             f" got: {version_str}",
             RuntimeWarning,
+            stacklevel=2,
         )
         return -1, -1
     return int(m.group("major")), int(m.group("minor"))

py2docfx/venv/basevenv/Lib/site-packages/packaging/licenses/__init__.py

@@ -0,0 +1,145 @@
+#######################################################################################
+#
+# Adapted from:
+#  https://github.com/pypa/hatch/blob/5352e44/backend/src/hatchling/licenses/parse.py
+#
+# MIT License
+#
+# Copyright (c) 2017-present Ofek Lev <oss@ofek.dev>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this
+# software and associated documentation files (the "Software"), to deal in the Software
+# without restriction, including without limitation the rights to use, copy, modify,
+# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be included in all copies
+# or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#
+# With additional allowance of arbitrary `LicenseRef-` identifiers, not just
+# `LicenseRef-Public-Domain` and `LicenseRef-Proprietary`.
+#
+#######################################################################################
+from __future__ import annotations
+
+import re
+from typing import NewType, cast
+
+from packaging.licenses._spdx import EXCEPTIONS, LICENSES
+
+__all__ = [
+    "NormalizedLicenseExpression",
+    "InvalidLicenseExpression",
+    "canonicalize_license_expression",
+]
+
+license_ref_allowed = re.compile("^[A-Za-z0-9.-]*$")
+
+NormalizedLicenseExpression = NewType("NormalizedLicenseExpression", str)
+
+
+class InvalidLicenseExpression(ValueError):
+    """Raised when a license-expression string is invalid
+
+    >>> canonicalize_license_expression("invalid")
+    Traceback (most recent call last):
+        ...
+    packaging.licenses.InvalidLicenseExpression: Invalid license expression: 'invalid'
+    """
+
+
+def canonicalize_license_expression(
+    raw_license_expression: str,
+) -> NormalizedLicenseExpression:
+    if not raw_license_expression:
+        message = f"Invalid license expression: {raw_license_expression!r}"
+        raise InvalidLicenseExpression(message)
+
+    # Pad any parentheses so tokenization can be achieved by merely splitting on
+    # whitespace.
+    license_expression = raw_license_expression.replace("(", " ( ").replace(")", " ) ")
+    licenseref_prefix = "LicenseRef-"
+    license_refs = {
+        ref.lower(): "LicenseRef-" + ref[len(licenseref_prefix) :]
+        for ref in license_expression.split()
+        if ref.lower().startswith(licenseref_prefix.lower())
+    }
+
+    # Normalize to lower case so we can look up licenses/exceptions
+    # and so boolean operators are Python-compatible.
+    license_expression = license_expression.lower()
+
+    tokens = license_expression.split()
+
+    # Rather than implementing boolean logic, we create an expression that Python can
+    # parse. Everything that is not involved with the grammar itself is treated as
+    # `False` and the expression should evaluate as such.
+    python_tokens = []
+    for token in tokens:
+        if token not in {"or", "and", "with", "(", ")"}:
+            python_tokens.append("False")
+        elif token == "with":
+            python_tokens.append("or")
+        elif token == "(" and python_tokens and python_tokens[-1] not in {"or", "and"}:
+            message = f"Invalid license expression: {raw_license_expression!r}"
+            raise InvalidLicenseExpression(message)
+        else:
+            python_tokens.append(token)
+
+    python_expression = " ".join(python_tokens)
+    try:
+        invalid = eval(python_expression, globals(), locals())
+    except Exception:
+        invalid = True
+
+    if invalid is not False:
+        message = f"Invalid license expression: {raw_license_expression!r}"
+        raise InvalidLicenseExpression(message) from None
+
+    # Take a final pass to check for unknown licenses/exceptions.
+    normalized_tokens = []
+    for token in tokens:
+        if token in {"or", "and", "with", "(", ")"}:
+            normalized_tokens.append(token.upper())
+            continue
+
+        if normalized_tokens and normalized_tokens[-1] == "WITH":
+            if token not in EXCEPTIONS:
+                message = f"Unknown license exception: {token!r}"
+                raise InvalidLicenseExpression(message)
+
+            normalized_tokens.append(EXCEPTIONS[token]["id"])
+        else:
+            if token.endswith("+"):
+                final_token = token[:-1]
+                suffix = "+"
+            else:
+                final_token = token
+                suffix = ""
+
+            if final_token.startswith("licenseref-"):
+                if not license_ref_allowed.match(final_token):
+                    message = f"Invalid licenseref: {final_token!r}"
+                    raise InvalidLicenseExpression(message)
+                normalized_tokens.append(license_refs[final_token] + suffix)
+            else:
+                if final_token not in LICENSES:
+                    message = f"Unknown license: {final_token!r}"
+                    raise InvalidLicenseExpression(message)
+                normalized_tokens.append(LICENSES[final_token]["id"] + suffix)
+
+    normalized_expression = " ".join(normalized_tokens)
+
+    return cast(
+        NormalizedLicenseExpression,
+        normalized_expression.replace("( ", "(").replace(" )", ")"),
+    )