py2docfx 0.1.20.dev2245077__py3-none-any.whl → 0.1.20.dev2245319__py3-none-any.whl

py2docfx/convert_prepare/package_info.py

@@ -13,7 +13,7 @@ class PackageInfo:
     path: Source
     def __init__(self) -> None:
         pass
-    
+
     @classmethod
     def report_error(cls, name, value, condition=None):
         py2docfx_logger = get_logger(__name__)
@@ -53,6 +53,7 @@ class PackageInfo:
 
         package_info.version = package_info_dict.get("version", None)
         package_info.extra_index_url = package_info_dict.get("extra_index_url", None)
+        package_info.extras = package_info_dict.get("extras", [])
 
         if package_info.install_type == cls.InstallType.SOURCE_CODE:
             package_info.url = package_info_dict.get("url", None)
@@ -93,56 +94,65 @@ class PackageInfo:
         return package_info
 
     def get_combined_name_version(self):
-        if not self.version:
-            return self.name
-        elif re.match("^(<|>|<=|>=|==).+$", self.version.strip()):
-            return self.name.strip() + self.version.strip()
-        else:
-            return f"{self.name.strip()}=={self.version.strip()}"
+        base_name = (
+            f"{self.name}[{','.join(extras)}]"
+            if (extras := getattr(self, "extras", []))
+            else self.name
+        )
 
-    def get_install_command(self) -> (str, []):
-        packageInstallName = ""
-        pipInstallExtraOptions = []
+        version = getattr(self, "version", None)
+        if not version:
+            return base_name
+        elif re.match("^(<|>|<=|>=|==).+$", version.strip()):
+            return base_name.strip() + version.strip()
+        else:
+            return f"{base_name.strip()}=={version.strip()}"
 
+    def get_install_command(self) -> tuple[str, list]:
         if self.install_type == self.InstallType.DIST_FILE:
-            if hasattr(self, "location") and self.location:
-                packageInstallName = self.location
-            else:
+            if not hasattr(self, "location") or not self.location:
                 self.__class__.report_error(
                     "location", "None", condition="When install_type is dist_file"
                 )
+            return (
+                f"{self.location}[{','.join(extras)}]"
+                if (extras := getattr(self, "extras", None))
+                else self.location,
+                [],
+            )
 
-        elif self.install_type == self.InstallType.PYPI:
+        if self.install_type == self.InstallType.PYPI:
             if not hasattr(self, "name") or not self.name:
                 self.__class__.report_error(
                     "name", "None", condition="When install_type is pypi"
                 )
-            if hasattr(self, "version") and self.version:
-                packageInstallName = self.get_combined_name_version()
-            else:
-                packageInstallName = self.name
+            pipInstallExtraOptions = []
+            if not hasattr(self, "version") or self.version is None:
                 pipInstallExtraOptions.append("--upgrade")
-
             if hasattr(self, "extra_index_url") and self.extra_index_url:
                 pipInstallExtraOptions.extend(
                     ["--extra-index-url", self.extra_index_url]
                 )
+            return (self.get_combined_name_version(), pipInstallExtraOptions)
 
-        elif self.install_type == self.InstallType.SOURCE_CODE:
-            if hasattr(self, "path") and self.path.source_folder:
-                packageInstallName = self.path.source_folder
-            else:
+        if self.install_type == self.InstallType.SOURCE_CODE:
+            if not hasattr(self, "path") or not self.path.source_folder:
                 self.__class__.report_error(
                     "path.source_folder",
                     "None",
                     condition="When install_type is source_code",
                 )
-        else:
-            self.__class__.report_error("install_type", self.install_type)
+            return (
+                f"{self.path.source_folder}[{','.join(extras)}]"
+                if (extras := getattr(self, "extras", None))
+                else self.path.source_folder,
+                [],
+            )
+
+        self.__class__.report_error("install_type", self.install_type)
 
-        return (packageInstallName, pipInstallExtraOptions)
 
-    def get_exluded_command(self) -> []:
+    def get_exluded_command(self) -> list:
         py2docfx_logger = get_logger(__name__)
         if hasattr(self, "path"):
             code_location = self.path.source_folder

py2docfx/convert_prepare/tests/test_package_info.py

@@ -80,4 +80,162 @@ def test_get_exclude_command_check_extra_exclude(tmp_path):
     ]
     def form_exclude_path(raletive_path):
         return os.path.join(source_folder, raletive_path)
-    assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]
+    assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]
+
+
+def test_get_combined_name_version_with_extras():
+    """Test get_combined_name_version with extras"""
+    # Test package with extras but no version
+    test_data = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "extras": ["dev", "test"],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    assert pkg.get_combined_name_version() == "test-package[dev,test]"
+
+    # Test package with extras and version
+    test_data_with_version = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": "1.0.0",
+            "extras": ["dev", "test"],
+        },
+    }
+    pkg_with_version = PackageInfo.parse_from(test_data_with_version)
+    assert (
+        pkg_with_version.get_combined_name_version() == "test-package[dev,test]==1.0.0"
+    )
+
+    # Test package with extras and version operator
+    test_data_with_operator = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": ">=1.0.0",
+            "extras": ["dev"],
+        },
+    }
+    pkg_with_operator = PackageInfo.parse_from(test_data_with_operator)
+    assert pkg_with_operator.get_combined_name_version() == "test-package[dev]>=1.0.0"
+
+
+def test_install_command_pypi_with_extras():
+    """Test get_install_command for PYPI packages with extras"""
+    # Test PYPI package with extras and version
+    test_data = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": "1.0.0",
+            "extras": ["dev", "test"],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    install_command = pkg.get_install_command()
+    assert install_command[0] == "test-package[dev,test]==1.0.0"
+    assert install_command[1] == []
+
+    # Test PYPI package with extras but no version (should get --upgrade)
+    test_data_no_version = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "extras": ["dev"],
+        },
+    }
+    pkg_no_version = PackageInfo.parse_from(test_data_no_version)
+    install_command = pkg_no_version.get_install_command()
+    assert install_command[0] == "test-package[dev]"
+    assert install_command[1] == ["--upgrade"]
+
+
+def test_install_command_source_code_with_extras(tmp_path):
+    """Test get_install_command for SOURCE_CODE packages with extras"""
+    source_folder = os.path.join(tmp_path, "source_folder")
+    yaml_output_folder = os.path.join(tmp_path, "yaml_output_folder")
+
+    test_data = {
+        "package_info": {
+            "install_type": "source_code",
+            "name": "test-package",
+            "url": "https://github.com/test/test-package.git",
+            "extras": ["dev", "test"],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    pkg.path = Source(
+        source_folder=source_folder,
+        yaml_output_folder=yaml_output_folder,
+        package_name="test-package",
+    )
+
+    install_command = pkg.get_install_command()
+    assert install_command[0] == f"{source_folder}[dev,test]"
+    assert install_command[1] == []
+
+
+def test_install_command_dist_file_with_extras():
+    """Test get_install_command for DIST_FILE packages with extras"""
+    test_data = {
+        "package_info": {
+            "install_type": "dist_file",
+            "location": "/path/to/package.whl",
+            "extras": ["dev"],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    install_command = pkg.get_install_command()
+    assert install_command[0] == "/path/to/package.whl[dev]"
+    assert install_command[1] == []
+
+
+def test_install_command_without_extras():
+    """Test that packages without extras work as before"""
+    # Test PYPI package without extras
+    test_data = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": "1.0.0",
+        }
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    install_command = pkg.get_install_command()
+    assert install_command[0] == "test-package==1.0.0"
+    assert install_command[1] == []
+
+
+def test_install_command_empty_extras():
+    """Test that packages with empty extras list work correctly"""
+    test_data = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": "1.0.0",
+            "extras": [],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    install_command = pkg.get_install_command()
+    assert install_command[0] == "test-package==1.0.0"
+    assert install_command[1] == []
+
+
+def test_install_command_single_extra():
+    """Test package with single extra"""
+    test_data = {
+        "package_info": {
+            "install_type": "pypi",
+            "name": "test-package",
+            "version": "1.0.0",
+            "extras": ["dev"],
+        },
+    }
+    pkg = PackageInfo.parse_from(test_data)
+    install_command = pkg.get_install_command()
+    assert install_command[0] == "test-package[dev]==1.0.0"
+    assert install_command[1] == []

{py2docfx-0.1.20.dev2245077.dist-info → py2docfx-0.1.20.dev2245319.dist-info}/METADATA

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

@@ -10,7 +10,7 @@ py2docfx/convert_prepare/get_source.py,sha256=I_-QXXFFraMruDf13xlkwGAs5hDuv-wAjW
 py2docfx/convert_prepare/git.py,sha256=Cq76ooxejKlVJiJWWbBhbLZ_JvxqN2ka12L8jkl80b4,6492
 py2docfx/convert_prepare/install_package.py,sha256=aJxQBwLRPTIKpdtLVl-SaXPaF_OX_H1ZtWmcKD8Zzuk,274
 py2docfx/convert_prepare/pack.py,sha256=Jjj9ps8ESoKUFmSk6VgNmxOwMhuwirnQ-rhqigH-4VY,1578
-py2docfx/convert_prepare/package_info.py,sha256=-zrMNeAkHxxzLRjBl1kRehUJy_ugc16yns-xdcAHQIQ,7711
+py2docfx/convert_prepare/package_info.py,sha256=K9bkS--64XEfyZTYS3ms1xGEgy3tdAWav94wj-7BBnw,8126
 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
@@ -30,7 +30,7 @@ py2docfx/convert_prepare/tests/test_environment.py,sha256=oJ_IuVQ-zwWNQZRXR74RDW
 py2docfx/convert_prepare/tests/test_generate_document.py,sha256=mY8DRT-WRGIBFdDRdFwa7ZSUQwR-fTQtyKwzrzFZLU8,2621
 py2docfx/convert_prepare/tests/test_get_source.py,sha256=IGBLAemm5SWUnNJJh6GJE5gBtAAdlC_cxS1xSeugzBI,7949
 py2docfx/convert_prepare/tests/test_pack.py,sha256=Gw-LkIcbQuQHpoSbvkybYt4_fVw-LL12dceWw5AUKdE,4242
-py2docfx/convert_prepare/tests/test_package_info.py,sha256=3B-IzmUjETVO-5s3g3Lmh2E6JgopwnRauv8mB-SDZEM,3361
+py2docfx/convert_prepare/tests/test_package_info.py,sha256=iUJIfTEPVuGnA8aypL7TLJhfY3F3gdzJUpig5pSYYPk,8635
 py2docfx/convert_prepare/tests/test_params.py,sha256=itwmVdBMtU1qIXAGaIoaDfvTOYyAL2B_WLsaBV9KUZY,2232
 py2docfx/convert_prepare/tests/test_post_process_merge_toc.py,sha256=YKOcn4_lf4syGsAvJ9BqpdUUc3SLfK4TiOX1lpXJT_Y,885
 py2docfx/convert_prepare/tests/test_source.py,sha256=LNFZtvjz6QhVLOxatjWokYCCcoSm0bhTikMF9KoTPIE,2025
@@ -3914,7 +3914,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.dev2245077.dist-info/METADATA,sha256=jo79MnKzOH-YBTnNMlzjWxJWDdGxiUpMsZ4heIpzZFg,548
-py2docfx-0.1.20.dev2245077.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-py2docfx-0.1.20.dev2245077.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.20.dev2245077.dist-info/RECORD,,
+py2docfx-0.1.20.dev2245319.dist-info/METADATA,sha256=alQjhdxpFKoY6UaTnlfj_pbVltuQejW_-otvBlc9Odg,548
+py2docfx-0.1.20.dev2245319.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+py2docfx-0.1.20.dev2245319.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.20.dev2245319.dist-info/RECORD,,