py-rattler 0.12.0__cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl → 0.13.1__cp38-abi3-manylinux_2_17_i686.manylinux2014_i686.whl

{py_rattler-0.12.0.dist-info → py_rattler-0.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-rattler
-Version: 0.12.0
+Version: 0.13.1
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License

{py_rattler-0.12.0.dist-info → py_rattler-0.13.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
-py_rattler-0.12.0.dist-info/METADATA,sha256=DFVbij0wFtQ8GQ6ZgTefvDKKGCMDumK_cfg2kaG6iI0,7910
-py_rattler-0.12.0.dist-info/WHEEL,sha256=wcJJFCW9jQmzY_UtSD5fNjF0lUaZUDXFT3xHjWhKis8,123
+py_rattler-0.13.1.dist-info/METADATA,sha256=Rr2E94GLr-7_oXjqHW3XgP-l7kYHLgw2GobYO7YE6zA,7910
+py_rattler-0.13.1.dist-info/WHEEL,sha256=wcJJFCW9jQmzY_UtSD5fNjF0lUaZUDXFT3xHjWhKis8,123
 rattler/package_streaming/__init__.py,sha256=I-mbr0sJnHzdFQP8v0Yb_GKpu4bIO3JbAJtq_wzA71Q,898
 rattler/solver/__init__.py,sha256=NZabrelb_pcqOi5PyZTr3OeBbjd85IqW1-2ymOBO-k0,119
-rattler/solver/solver.py,sha256=5T6izd_cOhwIAwlreJIUgqXpyTOCxOgW0Ll786Q6NqM,10922
+rattler/solver/solver.py,sha256=EEF86vA-ryVuBmq5uOomgzPq1BGXsNcAhJvf7JKVVDQ,11259
 rattler/explicit_environment/__init__.py,sha256=QHmwZkdVt-tFL-tEEdhLdH3apuI5F7ElpMzCRZeH3_o,170
 rattler/explicit_environment/environment.py,sha256=Dqcvm5c7C3K0FJ04YVN8WIUrl0R8Fe2TeXZ4Qq8Dg-0,2641
 rattler/match_spec/__init__.py,sha256=uBV3ov1VlCIZlIWhkxxMPcTqRBF5p5lqvT2g6kQv5kQ,167
@@ -16,15 +16,15 @@ rattler/lock/environment.py,sha256=sbcGqkb9rrGwpVCucDKkwdp2SFOyHZQGqvBArGEZFYs,7
 rattler/lock/channel.py,sha256=PaLb-vWRLTJWUx7fyMdP2Tow5wMlGuq3WUrHkrQIzeg,1331
 rattler/prefix/prefix_record.py,sha256=KWbjcBJO-KpdWz2VEYdlz_RPLpLByyaec0aViILi_EM,6290
 rattler/prefix/__init__.py,sha256=gkgyqZ0yTmxOCW8DHuSG-X0spEzb8BIoiox8YG50XYc,257
-rattler/prefix/prefix_paths.py,sha256=Ausp9xbZTUbsbjZJxCpTUuitcUhnr1DAgawHAyiVFh0,12819
+rattler/prefix/prefix_paths.py,sha256=B0EwOFkVbSzuLChdjkjenTehfxjXwwMBIodSGOfBHFU,12828
 rattler/platform/arch.py,sha256=7tanyDql5BvDvY9UryEXyTJ9nWRfx6bn7BWrl6fGEfI,1145
 rattler/platform/__init__.py,sha256=YZaXxnJmG_WjYbhIAxA0jQDhaPYAR4rTVQCm4yRoyZQ,154
 rattler/platform/platform.py,sha256=H_P35Z0irNiyQX2fxX7ombMkGwyYa-Ow_iDIDxJrmG8,4395
-rattler/__init__.py,sha256=kJU7zSmgY5FBQuE2dvZPKuZy7cx2ZhfkbfPZdv_xANk,2418
+rattler/__init__.py,sha256=QKjBUll9mX4TVwJy-dy5Gt8IezLnJz8EPTlKhOsw2IA,2476
 rattler/repo_data/gateway.py,sha256=G9CTfz6Qc84Wo3QJSxWjsCH79WOohSxxUxYwKiss8ng,10141
-rattler/repo_data/sparse.py,sha256=-XGT7vCAjKGdT0Ai7eF6Iff0N2dQRCYGAbxnFtGabko,6162
+rattler/repo_data/sparse.py,sha256=qO3XuIfvcDEfo8mHu8UB9JBoz0IR3k_kNR32ZTpbPWU,12542
 rattler/repo_data/package_record.py,sha256=t8vxRsfAToIolhBRjt9lB4e5Q7Tm-FjZHUI9vhxd-eA,28358
-rattler/repo_data/__init__.py,sha256=I7sC1bFPuXAUlb9gout2bGd1jYOPsHrsoDpSGniwpCk,495
+rattler/repo_data/__init__.py,sha256=cMoMtFOJBGonfWxizGphWpXdQ1GYXDXos7ESYigfco8,549
 rattler/repo_data/repo_data.py,sha256=lB7hQ1SN5b2VxuOaOH1BOFeIXbRUf2fslitLyT5aVwo,2264
 rattler/repo_data/patch_instructions.py,sha256=TNa7NgLtqGQ6lSpibLFxuPFwsmqRLrORpDZOpeZ5fnk,694
 rattler/repo_data/record.py,sha256=6CK2-KyvVZ8kaZ2l-o4DFWivxMJE_ChkOrm97bmIjn4,4572
@@ -58,5 +58,5 @@ rattler/channel/__init__.py,sha256=K-ZAo0qFzchXWP-6DpMHLg_djGD25-0CRwusisIGp8k,2
 rattler/channel/channel_config.py,sha256=rRD4dGeHTBIcm3vTuQR1wTGTELNdN69yq4lyCaTaN3M,1532
 rattler/channel/channel_priority.py,sha256=OQfCHp_DeInkMB0YahCf2X7yCk0_RtM_C_Vy4Ny-65M,474
 rattler/channel/channel.py,sha256=kGeZKa_YkSM943CA1i_8O1FXG9kS9hkrnmSl6OhkbbQ,2474
-rattler/rattler.abi3.so,sha256=FtkFI-uS34dFC64p0G3mAr-fAs4ZkBvZ3EZCdVY3Ayg,44860488
-py_rattler-0.12.0.dist-info/RECORD,,
+rattler/rattler.abi3.so,sha256=2TqQbIGUVSxi_jucL26HDu8jO-p7Ef0Q0Fu1PmiKR4Q,44993720
+py_rattler-0.13.1.dist-info/RECORD,,

rattler/__init__.py

@@ -8,6 +8,7 @@ from rattler.repo_data import (
     SparseRepoData,
     Gateway,
     SourceConfig,
+    PackageFormatSelection,
 )
 from rattler.channel import Channel, ChannelConfig, ChannelPriority
 from rattler.networking import Client, fetch_repo_data
@@ -70,6 +71,7 @@ __all__ = [
     "PrefixPathsEntry",
     "PrefixPathType",
     "SparseRepoData",
+    "PackageFormatSelection",
     "LockFile",
     "Environment",
     "LockChannel",

rattler/prefix/prefix_paths.py

@@ -22,9 +22,9 @@ class PrefixPathType:
             "softlink",
             "directory",
             "pyc_file",
-            "windows_python_entrypoint_script",
-            "windows_python_entrypoint_exe",
-            "unix_python_entrypoint",
+            "windows_python_entry_point_script",
+            "windows_python_entry_point_exe",
+            "unix_python_entry_point",
         ],
     ) -> None:
         """
@@ -82,25 +82,25 @@ class PrefixPathType:
         return self._inner.pyc_file
 
     @property
-    def windows_python_entrypoint_script(self) -> bool:
+    def windows_python_entry_point_script(self) -> bool:
         """
         A Windows entry point python script (a <entrypoint>-script.py Python script file)
         """
-        return self._inner.windows_python_entrypoint_script
+        return self._inner.windows_python_entry_point_script
 
     @property
-    def windows_python_entrypoint_exe(self) -> bool:
+    def windows_python_entry_point_exe(self) -> bool:
         """
         A Windows entry point python script (a <entrypoint>.exe executable)
         """
-        return self._inner.windows_python_entrypoint_exe
+        return self._inner.windows_python_entry_point_exe
 
     @property
-    def unix_python_entrypoint(self) -> bool:
+    def unix_python_entry_point(self) -> bool:
         """
         A Unix entry point python script (a <entrypoint> Python script file)
         """
-        return self._inner.unix_python_entrypoint
+        return self._inner.unix_python_entry_point
 
 
 class PrefixPathsEntry(BasePathLike):

rattler/repo_data/__init__.py

@@ -2,7 +2,7 @@ from rattler.repo_data.package_record import PackageRecord
 from rattler.repo_data.repo_data import RepoData
 from rattler.repo_data.patch_instructions import PatchInstructions
 from rattler.repo_data.record import RepoDataRecord
-from rattler.repo_data.sparse import SparseRepoData
+from rattler.repo_data.sparse import SparseRepoData, PackageFormatSelection
 from rattler.repo_data.gateway import Gateway, SourceConfig
 
 __all__ = [
@@ -13,4 +13,5 @@ __all__ = [
     "SparseRepoData",
     "Gateway",
     "SourceConfig",
+    "PackageFormatSelection",
 ]

rattler/repo_data/sparse.py

@@ -1,14 +1,44 @@
 from __future__ import annotations
 import os
 from pathlib import Path
-from typing import List
+from typing import List, Optional, Type, Literal, Iterable
+from types import TracebackType
+
+from rattler.match_spec.match_spec import MatchSpec
 from rattler.channel.channel import Channel
 from rattler.package.package_name import PackageName
+from enum import Enum
 
-from rattler.rattler import PySparseRepoData
+from rattler.rattler import PySparseRepoData, PyPackageFormatSelection
 from rattler.repo_data.record import RepoDataRecord
 
 
+class PackageFormatSelection(Enum):
+    """
+    Enum that describes what to do if both a `.tar.bz2` and a `.conda` package is available.
+    """
+
+    ONLY_TAR_BZ2 = PyPackageFormatSelection.OnlyTarBz2
+    """
+    Only use the `.tar.bz2` packages, ignore all `.conda` packages.
+    """
+
+    ONLY_CONDA = PyPackageFormatSelection.OnlyConda
+    """
+    Only use the `.conda` packages, ignore all `.tar.bz2` packages.
+    """
+
+    PREFER_CONDA = PyPackageFormatSelection.PreferConda
+    """
+    Only use the `.conda` packages if there are both a `.tar.bz2` and a `.conda` package available.
+    """
+
+    BOTH = PyPackageFormatSelection.Both
+    """
+    Use both the `.tar.bz2` and the `.conda` packages.
+    """
+
+
 class SparseRepoData:
     """
     A class to enable loading records from a `repodata.json` file on demand.
@@ -39,7 +69,43 @@ class SparseRepoData:
             )
         self._sparse = PySparseRepoData(channel._channel, subdir, str(path))
 
-    def package_names(self) -> List[str]:
+    def close(self) -> None:
+        """
+        Closes any mapped resources associated with this `SparseRepoData`
+        instance. It is good practice to call this method when you are done
+        with it. This is especially important if you want to modify or delete
+        the file from which this instance was created.
+
+        This method will release all resources associated with this instance,
+        including those that are currently being used on another thread. This
+        method will block until all resources are released.
+
+        This method has no effect if the file is already closed. Once the
+        instance is closed, any operation on the instance will raise a
+        `ValueError`.
+
+        As a convenience, it is allowed to call this method more than once;
+        only the first call, however, will have an effect.
+
+        Examples
+        --------
+        ```python
+        >>> from rattler import Channel, ChannelConfig
+        >>> channel = Channel("dummy", ChannelConfig())
+        >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
+        >>> sparse_data.close()
+        >>> sparse_data.package_names() # doctest: +IGNORE_EXCEPTION_DETAIL
+        Traceback (most recent call last):
+        ValueError: I/O operation on closed file.
+        >>>
+        ```
+        """
+        self._sparse.close()
+
+    def package_names(
+        self, package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA
+    ) -> List[str]:
         """
         Returns a list over all package names in this repodata file.
         This works by iterating over all elements in the `packages` and
@@ -51,9 +117,8 @@ class SparseRepoData:
         ```python
         >>> from rattler import Channel, ChannelConfig
         >>> channel = Channel("dummy", ChannelConfig())
-        >>> subdir = "test-data/dummy/noarch"
         >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
-        >>> sparse_data = SparseRepoData(channel, subdir, path)
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
         >>> package_names = sparse_data.package_names()
         >>> package_names
         [...]
@@ -62,9 +127,22 @@ class SparseRepoData:
         >>>
         ```
         """
-        return self._sparse.package_names()
+        return self._sparse.package_names(package_format_selection.value)
+
+    def record_count(
+        self, package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA
+    ) -> int:
+        """
+        Returns the total number of packages in this repodata file.
+        :return:
+        """
+        return self._sparse.record_count(package_format_selection.value)
 
-    def load_records(self, package_name: PackageName) -> List[RepoDataRecord]:
+    def load_records(
+        self,
+        package_name: str | PackageName,
+        package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA,
+    ) -> List[RepoDataRecord]:
         """
         Returns all the records for the specified package name.
 
@@ -73,9 +151,8 @@ class SparseRepoData:
         ```python
         >>> from rattler import Channel, ChannelConfig, RepoDataRecord, PackageName
         >>> channel = Channel("dummy", ChannelConfig())
-        >>> subdir = "test-data/dummy/noarch"
         >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
-        >>> sparse_data = SparseRepoData(channel, subdir, path)
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
         >>> package_name = PackageName(sparse_data.package_names()[0])
         >>> records = sparse_data.load_records(package_name)
         >>> records
@@ -85,8 +162,66 @@ class SparseRepoData:
         >>>
         ```
         """
+        if not isinstance(package_name, PackageName):
+            package_name = PackageName(package_name)
+        return [
+            RepoDataRecord._from_py_record(record)
+            for record in self._sparse.load_records(package_name._name, package_format_selection.value)
+        ]
+
+    def load_all_records(
+        self, package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA
+    ) -> List[RepoDataRecord]:
+        """
+        Returns all the records for the specified package name.
+
+        Examples
+        --------
+        ```python
+        >>> from rattler import Channel, ChannelConfig, RepoDataRecord, PackageName
+        >>> channel = Channel("dummy", ChannelConfig())
+        >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
+        >>> records = sparse_data.load_all_records()
+        >>> records
+        [...]
+        >>> isinstance(records[0], RepoDataRecord)
+        True
+        >>>
+        ```
+        """
         # maybe change package_name to Union[str, PackageName]
-        return [RepoDataRecord._from_py_record(record) for record in self._sparse.load_records(package_name._name)]
+        return [
+            RepoDataRecord._from_py_record(record)
+            for record in self._sparse.load_all_records(package_format_selection.value)
+        ]
+
+    def load_matching_records(
+        self,
+        specs: Iterable[MatchSpec],
+        package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA,
+    ) -> List[RepoDataRecord]:
+        """
+        Returns all the records that match any of the specified MatchSpecs.
+
+        Examples
+        --------
+        ```python
+        >>> from rattler import Channel, ChannelConfig, RepoDataRecord, PackageName
+        >>> channel = Channel("dummy", ChannelConfig())
+        >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
+        >>> [record.file_name for record in sparse_data.load_matching_records([MatchSpec("* 12.5")])]
+        ['cuda-version-12.5-hd4f0392_3.conda']
+        >>>
+        ```
+        """
+        return [
+            RepoDataRecord._from_py_record(record)
+            for record in self._sparse.load_matching_records(
+                [spec._match_spec for spec in specs], package_format_selection.value
+            )
+        ]
 
     @property
     def subdir(self) -> str:
@@ -98,11 +233,10 @@ class SparseRepoData:
         ```python
         >>> from rattler import Channel, ChannelConfig
         >>> channel = Channel("dummy", ChannelConfig())
-        >>> subdir = "test-data/dummy/noarch"
         >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
-        >>> sparse_data = SparseRepoData(channel, subdir, path)
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
         >>> sparse_data.subdir
-        'test-data/dummy/noarch'
+        'linux-64'
         >>>
         ```
         """
@@ -112,6 +246,7 @@ class SparseRepoData:
     def load_records_recursive(
         repo_data: List[SparseRepoData],
         package_names: List[PackageName],
+        package_format_selection: PackageFormatSelection = PackageFormatSelection.PREFER_CONDA,
     ) -> List[List[RepoDataRecord]]:
         """
         Given a set of [`SparseRepoData`]s load all the records
@@ -127,7 +262,7 @@ class SparseRepoData:
         >>> channel = Channel("dummy")
         >>> subdir = "test-data/dummy/linux-64"
         >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
-        >>> sparse_data = SparseRepoData(channel, subdir, path)
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
         >>> package_name = PackageName("python")
         >>> SparseRepoData.load_records_recursive([sparse_data], [package_name])
         [...]
@@ -137,8 +272,7 @@ class SparseRepoData:
         return [
             [RepoDataRecord._from_py_record(record) for record in list_of_records]
             for list_of_records in PySparseRepoData.load_records_recursive(
-                [r._sparse for r in repo_data],
-                [p._name for p in package_names],
+                [r._sparse for r in repo_data], [p._name for p in package_names], package_format_selection.value
             )
         ]
 
@@ -160,12 +294,57 @@ class SparseRepoData:
         ```python
         >>> from rattler import Channel, ChannelConfig
         >>> channel = Channel("dummy", ChannelConfig())
-        >>> subdir = "test-data/dummy/noarch"
         >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
-        >>> sparse_data = SparseRepoData(channel, subdir, path)
+        >>> sparse_data = SparseRepoData(channel, "linux-64", path)
         >>> sparse_data
-        SparseRepoData(subdir="test-data/dummy/noarch")
+        SparseRepoData(subdir="linux-64")
         >>>
         ```
         """
         return f'SparseRepoData(subdir="{self.subdir}")'
+
+    def __enter__(self) -> SparseRepoData:
+        """
+        Returns the `SparseRepoData` instance itself. This is used to
+        enable the use of the `with` statement to automatically close
+        the instance when done.
+
+        Examples
+        --------
+        ```python
+        >>> from rattler import Channel, ChannelConfig
+        >>> channel = Channel("dummy", ChannelConfig())
+        >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
+        >>> with SparseRepoData(channel, "linux-64", path) as sparse_data:
+        ...     print(sparse_data)
+        ...
+        SparseRepoData(subdir="linux-64")
+        >>>
+        ```
+        """
+        return self
+
+    def __exit__(
+        self,
+        exctype: Optional[Type[BaseException]],
+        excinst: Optional[BaseException],
+        exctb: Optional[TracebackType],
+    ) -> Literal[False]:
+        """
+        Closes the `SparseRepoData` instance when exiting the `with` statement.
+
+        Examples
+        --------
+        ```python
+        >>> from rattler import Channel, ChannelConfig
+        >>> channel = Channel("dummy", ChannelConfig())
+        >>> path = "../test-data/channels/dummy/linux-64/repodata.json"
+        >>> with SparseRepoData(channel, "linux-64", path) as sparse_data:
+        ...     print(sparse_data)
+        ...
+        SparseRepoData(subdir="linux-64")
+        >>>
+        ```
+        """
+        self.close()
+        return False

rattler/solver/solver.py

@@ -6,7 +6,7 @@ from rattler import Channel, Platform, VirtualPackage, SparseRepoData
 from rattler.match_spec.match_spec import MatchSpec
 
 from rattler.channel import ChannelPriority
-from rattler.rattler import py_solve, PyMatchSpec, py_solve_with_sparse_repodata
+from rattler.rattler import py_solve, PyMatchSpec, py_solve_with_sparse_repodata, PyPackageFormatSelection
 
 from rattler.platform.platform import PlatformLiteral
 from rattler.repo_data.gateway import Gateway
@@ -127,6 +127,7 @@ async def solve_with_sparse_repodata(
     exclude_newer: Optional[datetime.datetime] = None,
     strategy: SolveStrategy = "highest",
     constraints: Optional[Sequence[MatchSpec | str]] = None,
+    use_only_tar_bz2: bool = False,
 ) -> List[RepoDataRecord]:
     """
     Resolve the dependencies and return the `RepoDataRecord`s
@@ -171,6 +172,7 @@ async def solve_with_sparse_repodata(
         constraints: Additional constraints that should be satisfied by the solver.
             Packages included in the `constraints` are not necessarily installed,
             but they must be satisfied by the solution.
+        use_only_tar_bz2: If `True` only `.tar.bz2` packages are used. If `False` `.conda` packages are preferred.
 
     Returns:
         Resolved list of `RepoDataRecord`s.
@@ -191,6 +193,9 @@ async def solve_with_sparse_repodata(
             ],
             channel_priority=channel_priority.value,
             timeout=int(timeout / datetime.timedelta(microseconds=1)) if timeout else None,
+            package_format_selection=PyPackageFormatSelection.OnlyTarBz2
+            if use_only_tar_bz2
+            else PyPackageFormatSelection.PreferConda,
             exclude_newer_timestamp_ms=int(exclude_newer.replace(tzinfo=datetime.timezone.utc).timestamp() * 1000)
             if exclude_newer
             else None,