isolate 0.12.9__tar.gz → 0.12.11__tar.gz

isolate-0.12.11/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: PyPI release
+
+on:
+  release:
+    types:
+    - published
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Install deps
+        run: python -m pip install --upgrade pip setuptools_scm build
+
+      - name: Build
+        run: python -m build
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: pypi
+      url: https://pypi.org/p/isolate
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+

isolate-0.12.11/.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+  schedule:
+    - cron: '30 5 * * *' # every day at 5:30 UTC
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.8", "3.9", "3.10", "3.11"]
+        include:
+        - os: macos-latest
+          python: "3.8"
+        - os: macos-latest
+          python: "3.11"
+    steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python }}
+
+    - name: Install mamba
+      uses: mamba-org/setup-micromamba@v1
+      with:
+        environment-name: ci
+        create-args: >-
+          python=${{ matrix.python }}
+        condarc: |
+          channels:
+            - anaconda
+            - conda-forge
+            - pytorch
+
+    - uses: actions/checkout@v3
+      with:
+        repository: pyenv/pyenv
+        ref: v2.3.6
+        path: pyenv
+
+    - name: Install dependencies
+      run: |
+        python -m pip install -e ".[test]"
+
+    - name: Install uv
+      run: |
+        python -m pip install uv
+
+    - uses: pre-commit/action@v3.0.1
+
+    - name: Test
+      run: |
+        export ISOLATE_PYENV_EXECUTABLE=pyenv/bin/pyenv
+        python -m pytest -vvv

isolate-0.12.11/.gitignore

@@ -0,0 +1,125 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# anti lolenv
+Pipfile*
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# vim
+*.swp
+
+/src/isolate/_isolate_version.py

isolate-0.12.11/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: 'v0.3.4'
+  hooks:
+  - id: ruff
+    args: [--fix, --exit-non-zero-on-fix]
+    exclude: ".*(_pb2.py|_pb2.pyi|_pb2_grpc.py)$"
+  - id: ruff-format
+    exclude: ".*(_pb2.py|_pb2.pyi|_pb2_grpc.py)$"
+- repo: https://github.com/asottile/setup-cfg-fmt
+  rev: v1.20.1
+  hooks:
+  - id: setup-cfg-fmt
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.2.0
+  hooks:
+  - id: mypy
+    args:
+    - --disallow-incomplete-defs
+    - --ignore-missing-imports
+    - --no-warn-no-return
+    exclude: ".*(_pb2.py|_pb2.pyi|_pb2_grpc.py)$"
+    additional_dependencies: [types-protobuf]
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+  - id: codespell
+    exclude: ".*(_pb2.py|_pb2.pyi|_pb2_grpc.py)$"

{isolate-0.12.9 → isolate-0.12.11}/PKG-INFO

@@ -1,28 +1,29 @@
 Metadata-Version: 2.1
 Name: isolate
-Version: 0.12.9
+Version: 0.12.11
 Summary: Managed isolated environments for Python
-Home-page: https://github.com/fal-ai/isolate
-Author: Features & Labels
-Author-email: hello@fal.ai
-Requires-Python: >=3.8,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Provides-Extra: build
-Provides-Extra: grpc
-Provides-Extra: server
-Requires-Dist: PyYAML (>=6.0) ; extra == "build"
-Requires-Dist: grpcio (>=1.49)
-Requires-Dist: importlib-metadata (>=4.4) ; python_version < "3.10"
-Requires-Dist: platformdirs
-Requires-Dist: protobuf
-Requires-Dist: tblib (>=1.7.0)
-Requires-Dist: virtualenv (>=20.4) ; extra == "build"
-Project-URL: Repository, https://github.com/fal-ai/isolate
+Author-email: Features & Labels <hello@fal.ai>
+Project-URL: Issues, https://github.com/fal-ai/isolate/issues
+Project-URL: Source, https://github.com/fal-ai/isolate
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio>=1.49
+Requires-Dist: protobuf
+Requires-Dist: tblib>=1.7.0
+Requires-Dist: platformdirs
+Requires-Dist: importlib-metadata>=4.4; python_version < "3.10"
+Provides-Extra: build
+Requires-Dist: virtualenv>=20.4; extra == "build"
+Requires-Dist: PyYAML>=6.0; extra == "build"
+Provides-Extra: test
+Requires-Dist: isolate[build]; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: cloudpickle>=2.2.0; extra == "test"
+Requires-Dist: dill>=0.3.5.1; extra == "test"
+Requires-Dist: pytest-rerunfailures; extra == "test"
+Provides-Extra: dev
+Requires-Dist: isolate[test]; extra == "dev"
 
 # Isolate
 
@@ -59,3 +60,27 @@ different) and can change it without any loss. Isolate is working towards a futu
 transititon is as seamless as the transition from your local environment to the remote
 environment.
 
+## Contributing
+
+### Installing in editable mode with dev dependencies
+
+```
+pip install -e '.[dev]'
+```
+
+### Running tests
+
+```
+pytest
+```
+
+### Pre-commit
+
+```
+pre-commit install
+```
+
+### Commit format
+
+Please follow [conventional commits specification](https://www.conventionalcommits.org/) for descriptions/messages.
+

{isolate-0.12.9 → isolate-0.12.11}/README.md

@@ -32,3 +32,28 @@ this problem lacked a universal interface which one can simply define a set of r
 different) and can change it without any loss. Isolate is working towards a future where this
 transititon is as seamless as the transition from your local environment to the remote
 environment.
+
+## Contributing
+
+### Installing in editable mode with dev dependencies
+
+```
+pip install -e '.[dev]'
+```
+
+### Running tests
+
+```
+pytest
+```
+
+### Pre-commit
+
+```
+pre-commit install
+```
+
+### Commit format
+
+Please follow [conventional commits specification](https://www.conventionalcommits.org/) for descriptions/messages.
+

isolate-0.12.11/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["setuptools", "wheel", "setuptools_scm[toml]>=7"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_file = "src/isolate/_isolate_version.py"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["isolate"]
+namespaces = false
+
+[project]
+name = "isolate"
+dynamic = ["version"]
+readme = "README.md"
+description = "Managed isolated environments for Python"
+authors = [{ name = "Features & Labels", email = "hello@fal.ai"}]
+requires-python = ">=3.8"
+dependencies = [
+    "grpcio>=1.49",
+    "protobuf",
+    # These are non-intrusive packages with no transitive dependencies.
+    # They are also used in the agents themselves.
+    "tblib>=1.7.0",
+    "platformdirs",
+    # For 3.10 and later, importlib-metadata's newer versions are included in the
+    # standard library.
+    'importlib-metadata>=4.4; python_version < "3.10"',
+]
+
+[project.urls]
+Issues = "https://github.com/fal-ai/isolate/issues"
+Source = "https://github.com/fal-ai/isolate"
+
+[project.optional-dependencies]
+build = [
+    # The following are build-related dependencies, and their usage sites are heavily
+    # guarded with optional_import() calls.
+    "virtualenv>=20.4",
+    "PyYAML>=6.0",
+]
+test = [
+    "isolate[build]",
+    "pytest",
+    "cloudpickle>=2.2.0",
+    "dill>=0.3.5.1",
+    "pytest-rerunfailures",
+]
+dev = [
+    "isolate[test]",
+]
+
+
+[project.entry-points."isolate.backends"]
+"virtualenv" = "isolate.backends.virtualenv:VirtualPythonEnvironment"
+"conda" = "isolate.backends.conda:CondaEnvironment"
+"local" = "isolate.backends.local:LocalPythonEnvironment"
+"isolate-server" = "isolate.backends.remote:IsolateServer"
+"pyenv" = "isolate.backends.pyenv:PyenvEnvironment"
+
+[tool.ruff]
+target-version = "py38"
+exclude = ["*_pb2.py", "*_pb2.pyi", "*_pb2_grpc.py"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "PLC", "PLE", "PLW", "I", "UP"]

isolate-0.12.11/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

isolate-0.12.11/src/isolate/__init__.py

@@ -0,0 +1,3 @@
+from isolate.registry import prepare_environment  # noqa: F401
+
+from ._version import __version__, version_tuple  # noqa: F401

isolate-0.12.11/src/isolate/_isolate_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.12.11'
+__version_tuple__ = version_tuple = (0, 12, 11)

isolate-0.12.11/src/isolate/_version.py

@@ -0,0 +1,6 @@
+try:
+    from ._isolate_version import version as __version__  # type: ignore[import]
+    from ._isolate_version import version_tuple  # type: ignore[import]
+except ImportError:
+    __version__ = "UNKNOWN"
+    version_tuple = (0, 0, __version__)  # type: ignore[assignment]

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/backends/_base.py

@@ -12,6 +12,7 @@ from typing import (
 )
 
 from isolate.backends.settings import DEFAULT_SETTINGS, IsolateSettings
+from isolate.exceptions import IsolateException
 from isolate.logs import Log, LogLevel, LogSource
 
 __all__ = [
@@ -27,7 +28,7 @@ CallResultType = TypeVar("CallResultType")
 BasicCallable = Callable[[], CallResultType]
 
 
-class EnvironmentCreationError(Exception):
+class EnvironmentCreationError(IsolateException):
     """Raised when the environment cannot be created."""
 
 
@@ -73,13 +74,14 @@ class BaseEnvironment(Generic[ConnectionKeyType]):
     def open_connection(
         self, connection_key: ConnectionKeyType
     ) -> EnvironmentConnection:
-        """Return a new connection to the environment with using the `connection_key`."""
+        """Return a new connection to the environment with using the
+        `connection_key`."""
         raise NotImplementedError
 
     @contextmanager
     def connect(self) -> Iterator[EnvironmentConnection]:
-        """Create the given environment (if it already doesn't exist) and establish a connection
-        to it."""
+        """Create the given environment (if it already doesn't exist) and establish a
+        connection to it."""
         connection_key = self.create()
         with self.open_connection(connection_key) as connection:
             yield connection

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/backends/common.py

@@ -246,10 +246,10 @@ def get_executable(command: str, home: str | None = None) -> Path:
         binary_path = shutil.which(command, path=path)
         if binary_path is not None:
             return Path(binary_path)
-    else:
-        # TODO: we should probably show some instructions on how you
-        # can install conda here.
-        raise FileNotFoundError(
-            f"Could not find the {command} executable. If the {command} executable is not available by default, please point isolate "
-            f" to the path where the {command} binary is available '{home}'."
-        )
+    # TODO: we should probably show some instructions on how you
+    # can install conda here.
+    raise FileNotFoundError(
+        f"Could not find the {command} executable. "
+        f"If the {command} executable is not available by default, please point "
+        f"isolate to the path where the {command} binary is available '{home}'."
+    )

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/backends/conda.py

@@ -212,5 +212,4 @@ def _depends_on(
             continue
 
         return True
-    else:
-        return False
+    return False

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/backends/pyenv.py

@@ -43,8 +43,9 @@ class PyenvEnvironment(BaseEnvironment[Path]):
         pyenv = _get_pyenv_executable()
         env_path = self.settings.cache_dir_for(self)
         with self.settings.cache_lock_for(env_path):
-            # PyEnv installs* the Python versions under $root/versions/$version, where we
-            # use versions/$version as the key and $root as the base directory (for pyenv).
+            # PyEnv installs* the Python versions under $root/versions/$version, where
+            # we use versions/$version as the key and $root as the base directory
+            # (for pyenv).
             #
             # [0]: https://github.com/pyenv/pyenv#locating-pyenv-provided-python-installations
             pyenv_root = env_path.parent.parent
@@ -126,15 +127,17 @@ def _get_pyenv_executable() -> Path:
     if _PYENV_EXECUTABLE_PATH:
         if not os.path.exists(_PYENV_EXECUTABLE_PATH):
             raise EnvironmentCreationError(
-                f"Path to pyenv executable not found! ISOLATE_PYENV_EXECUTABLE variable: {_PYENV_EXECUTABLE_PATH!r}"
+                "Path to pyenv executable not found! ISOLATE_PYENV_EXECUTABLE "
+                f"variable: {_PYENV_EXECUTABLE_PATH!r}"
             )
         return Path(_PYENV_EXECUTABLE_PATH)
 
     pyenv_path = shutil.which(_PYENV_EXECUTABLE_NAME)
     if pyenv_path is None:
         raise FileNotFoundError(
-            "Could not find the pyenv executable. If pyenv is not already installed in your system, please"
-            "install it first. If it is not in your PATH, then point ISOLATE_PYENV_COMMAND to the absolute path of the"
+            "Could not find the pyenv executable. If pyenv is not already installed "
+            "in your system, please install it first. If it is not in your PATH, "
+            "then point ISOLATE_PYENV_COMMAND to the absolute path of the "
             "pyenv executable."
         )
     return Path(pyenv_path)

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/backends/remote.py

@@ -51,8 +51,9 @@ class IsolateServer(BaseEnvironment[List[EnvironmentDefinition]]):
     def create(self, *, force: bool = False) -> list[EnvironmentDefinition]:
         if force is True:
             raise NotImplementedError(
-                "Only individual environments can be forcibly created, please set them up"
-                " manually by using the 'force_create' flag on the environment definition."
+                "Only individual environments can be forcibly created, please set "
+                "them up manually by using the 'force_create' flag on the "
+                "environment definition."
             )
 
         envs = []

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/connections/common.py

@@ -8,6 +8,8 @@ from typing import TYPE_CHECKING, Any, Iterator, cast
 
 from tblib import Traceback, TracebackParseError
 
+from isolate.exceptions import IsolateException
+
 if TYPE_CHECKING:
     from typing import Protocol
 
@@ -21,7 +23,7 @@ AGENT_SIGNATURE = "IS_ISOLATE_AGENT"
 
 
 @dataclass
-class SerializationError(Exception):
+class SerializationError(IsolateException):
     """An error that happened during the serialization process."""
 
     message: str

{isolate-0.12.9 → isolate-0.12.11}/src/isolate/connections/grpc/_base.py

@@ -16,10 +16,11 @@ from isolate.connections.common import serialize_object
 from isolate.connections.grpc import agent, definitions
 from isolate.connections.grpc.configuration import get_default_options
 from isolate.connections.grpc.interface import from_grpc
+from isolate.exceptions import IsolateException
 from isolate.logs import LogLevel, LogSource
 
 
-class AgentError(Exception):
+class AgentError(IsolateException):
     """An internal problem caused by (most probably) the agent."""
 
 
@@ -49,8 +50,8 @@ class GRPCExecutionBase(EnvironmentConnection):
                     channel_status.result(timeout=max_wait_timeout)
                 except grpc.FutureTimeoutError:
                     raise AgentError(
-                        f"Couldn't connect to the gRPC server in the agent (listening at {address}) "
-                        "in time."
+                        "Couldn't connect to the gRPC server in the agent "
+                        f"(listening at {address}) in time."
                     )
                 stub = definitions.AgentStub(channel)
                 stub._channel = channel  # type: ignore
@@ -69,15 +70,16 @@ class GRPCExecutionBase(EnvironmentConnection):
         #  ---------
         #  1. [controller]: Spawn the agent.
         #  2.      [agent]: Start listening at the given address.
-        #  3. [controller]: Await *at most* max_wait_timeout seconds for the agent to be available
-        #                   if it doesn't do it until then, raise an AgentError.
-        #  4. [controller]: If the server is available, then establish the bridge and pass the
-        #                   'function' as the input.
+        #  3. [controller]: Await *at most* max_wait_timeout seconds for the agent to
+        #                   be available if it doesn't do it until then,
+        #                   raise an AgentError.
+        #  4. [controller]: If the server is available, then establish the bridge and
+        #                   pass the 'function' as the input.
         #  5.      [agent]: Receive the function, deserialize it, start the execution.
-        #  6. [controller]: Watch agent for logs (stdout/stderr), and as soon as they appear
-        #                   call the log handler.
-        #  7.      [agent]: Once the execution of the function is finished, send the result
-        #                   using the same serialization method.
+        #  6. [controller]: Watch agent for logs (stdout/stderr), and as soon as they
+        #                   appear call the log handler.
+        #  7.      [agent]: Once the execution of the function is finished, send the
+        #                   result using the same serialization method.
         #  8. [controller]: Receive the result back and return it.
 
         method = self.environment.settings.serialization_method
@@ -106,7 +108,8 @@ class GRPCExecutionBase(EnvironmentConnection):
                     return cast(CallResultType, from_grpc(partial_result.result))
 
         raise AgentError(
-            "No result object was received from the agent (it never set is_complete to True)."
+            "No result object was received from the agent "
+            "(it never set is_complete to True)."
         )