prefect-gitlab 0.3.1__tar.gz → 0.3.3__tar.gz

{prefect_gitlab-0.3.1/prefect_gitlab.egg-info → prefect_gitlab-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: prefect-gitlab
-Version: 0.3.1
+Version: 0.3.3
 Summary: A Prefect collection for working with GitLab repositories.
 Author-email: "Prefect Technologies, Inc." <help@prefect.io>
 License: Apache License 2.0
@@ -11,32 +11,18 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: prefect>=3.0.0
 Requires-Dist: python-gitlab>=3.12.0
 Requires-Dist: tenacity>=8.2.3
-Provides-Extra: dev
-Requires-Dist: aiohttp; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: interrogate; extra == "dev"
-Requires-Dist: mkdocs-gen-files; extra == "dev"
-Requires-Dist: mkdocs-material; extra == "dev"
-Requires-Dist: mkdocs; extra == "dev"
-Requires-Dist: mkdocstrings[python]; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: pillow; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pytest-asyncio; extra == "dev"
-Requires-Dist: pytest>=8.3; extra == "dev"
-Requires-Dist: pytest-env; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
+Dynamic: license-file
 
 # prefect-gitlab
 

prefect_gitlab-0.3.3/prefect_gitlab/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.3.3'
+__version_tuple__ = version_tuple = (0, 3, 3)
+
+__commit_id__ = commit_id = 'gd77914141'

prefect_gitlab-0.3.3/prefect_gitlab/credentials.py

@@ -0,0 +1,91 @@
+"""Module used to enable authenticated interactions with GitLab"""
+
+from typing import Optional
+from urllib.parse import urlparse, urlunparse
+
+from gitlab import Gitlab
+from pydantic import Field, SecretStr
+
+from prefect.blocks.core import Block
+
+
+class GitLabCredentials(Block):
+    """
+    Store a GitLab personal access token to interact with private GitLab
+    repositories.
+
+    Attributes:
+        token: The personal access token to authenticate with GitLab.
+        url: URL to self-hosted GitLab instances.
+
+    Examples:
+        Load stored GitLab credentials:
+        ```python
+        from prefect_gitlab import GitLabCredentials
+        gitlab_credentials_block = GitLabCredentials.load("BLOCK_NAME")
+        ```
+    """
+
+    _block_type_name = "GitLab Credentials"
+    _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/55edIimT4g9gbjhkh5a3Sp/dfdb9391d8f45c2e93e72e3a4d350771/gitlab-logo-500.png?h=250"
+
+    token: Optional[SecretStr] = Field(
+        title="Personal Access Token",
+        default=None,
+        description="A GitLab Personal Access Token with read_repository scope.",
+    )
+    url: Optional[str] = Field(
+        default=None, title="URL", description="URL to self-hosted GitLab instances."
+    )
+
+    def format_git_credentials(self, url: str) -> str:
+        """
+        Format and return the full git URL with GitLab credentials embedded.
+
+        Handles both personal access tokens and deploy tokens correctly:
+        - Personal access tokens: prefixed with "oauth2:"
+        - Deploy tokens (username:token format): used as-is
+        - Already prefixed tokens: not double-prefixed
+
+        Args:
+            url: Repository URL (e.g., "https://gitlab.com/org/repo.git")
+
+        Returns:
+            Complete URL with credentials embedded
+
+        Raises:
+            ValueError: If token is not configured
+        """
+        if not self.token:
+            raise ValueError("Token is required for GitLab authentication")
+
+        token_value = self.token.get_secret_value()
+
+        # Deploy token detection: contains ":" but not "oauth2:" prefix
+        # Deploy tokens should not have oauth2: prefix (GitLab 16.3.4+ rejects them)
+        # See: https://github.com/PrefectHQ/prefect/issues/10832
+        if ":" in token_value and not token_value.startswith("oauth2:"):
+            credentials = token_value
+        # Personal access token: add oauth2: prefix
+        # See: https://github.com/PrefectHQ/prefect/issues/16836
+        elif not token_value.startswith("oauth2:"):
+            credentials = f"oauth2:{token_value}"
+        else:
+            # Already prefixed
+            credentials = token_value
+
+        # Insert credentials into URL
+        parsed = urlparse(url)
+        return urlunparse(parsed._replace(netloc=f"{credentials}@{parsed.netloc}"))
+
+    def get_client(self) -> Gitlab:
+        """
+        Gets an authenticated GitLab client.
+
+        Returns:
+            An authenticated GitLab client.
+        """
+        # ref: https://python-gitlab.readthedocs.io/en/stable/
+        gitlab = Gitlab(url=self.url, oauth_token=self.token.get_secret_value())
+        gitlab.auth()
+        return gitlab

{prefect_gitlab-0.3.1 → prefect_gitlab-0.3.3}/prefect_gitlab/repositories.py

@@ -43,6 +43,7 @@ Examples:
 
 import io
 import shutil
+import subprocess
 import urllib.parse
 from pathlib import Path
 from tempfile import TemporaryDirectory
@@ -51,8 +52,8 @@ from typing import Optional, Tuple, Union
 from pydantic import Field
 from tenacity import retry, stop_after_attempt, wait_fixed, wait_random
 
+from prefect._internal.compatibility.async_dispatch import async_dispatch
 from prefect.filesystems import ReadableDeploymentStorage
-from prefect.utilities.asyncutils import sync_compatible
 from prefect.utilities.processutils import run_process
 from prefect_gitlab.credentials import GitLabCredentials
 
@@ -135,7 +136,6 @@ class GitLabRepository(ReadableDeploymentStorage):
 
         return str(content_source), str(content_destination)
 
-    @sync_compatible
     @retry(
         stop=stop_after_attempt(MAX_CLONE_ATTEMPTS),
         wait=wait_fixed(CLONE_RETRY_MIN_DELAY_SECONDS)
@@ -145,13 +145,14 @@ class GitLabRepository(ReadableDeploymentStorage):
         ),
         reraise=True,
     )
-    async def get_directory(
+    async def aget_directory(
         self, from_path: Optional[str] = None, local_path: Optional[str] = None
     ) -> None:
         """
         Clones a GitLab project specified in `from_path` to the provided `local_path`;
         defaults to cloning the repository reference configured on the Block to the
-        present working directory.
+        present working directory. Async version.
+
         Args:
             from_path: If provided, interpreted as a subdirectory of the underlying
                 repository that will be copied to the provided local path.
@@ -184,3 +185,48 @@ class GitLabRepository(ReadableDeploymentStorage):
             shutil.copytree(
                 src=content_source, dst=content_destination, dirs_exist_ok=True
             )
+
+    @retry(
+        stop=stop_after_attempt(MAX_CLONE_ATTEMPTS),
+        wait=wait_fixed(CLONE_RETRY_MIN_DELAY_SECONDS)
+        + wait_random(
+            CLONE_RETRY_MIN_DELAY_JITTER_SECONDS,
+            CLONE_RETRY_MAX_DELAY_JITTER_SECONDS,
+        ),
+        reraise=True,
+    )
+    @async_dispatch(aget_directory)
+    def get_directory(
+        self, from_path: Optional[str] = None, local_path: Optional[str] = None
+    ) -> None:
+        """
+        Clones a GitLab project specified in `from_path` to the provided `local_path`;
+        defaults to cloning the repository reference configured on the Block to the
+        present working directory.
+
+        Args:
+            from_path: If provided, interpreted as a subdirectory of the underlying
+                repository that will be copied to the provided local path.
+            local_path: A local path to clone to; defaults to present working directory.
+        """
+        cmd = ["git", "clone", self._create_repo_url()]
+        if self.reference:
+            cmd += ["-b", self.reference]
+
+        if self.git_depth is not None:
+            cmd += ["--depth", str(self.git_depth)]
+
+        with TemporaryDirectory(suffix="prefect") as tmp_dir:
+            cmd.append(tmp_dir)
+
+            result = subprocess.run(cmd, capture_output=True, text=True)
+            if result.returncode != 0:
+                raise OSError(f"Failed to pull from remote:\n {result.stderr}")
+
+            content_source, content_destination = self._get_paths(
+                dst_dir=local_path, src_dir=tmp_dir, sub_directory=from_path
+            )
+
+            shutil.copytree(
+                src=content_source, dst=content_destination, dirs_exist_ok=True
+            )

{prefect_gitlab-0.3.1 → prefect_gitlab-0.3.3/prefect_gitlab.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: prefect-gitlab
-Version: 0.3.1
+Version: 0.3.3
 Summary: A Prefect collection for working with GitLab repositories.
 Author-email: "Prefect Technologies, Inc." <help@prefect.io>
 License: Apache License 2.0
@@ -11,32 +11,18 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: prefect>=3.0.0
 Requires-Dist: python-gitlab>=3.12.0
 Requires-Dist: tenacity>=8.2.3
-Provides-Extra: dev
-Requires-Dist: aiohttp; extra == "dev"
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: interrogate; extra == "dev"
-Requires-Dist: mkdocs-gen-files; extra == "dev"
-Requires-Dist: mkdocs-material; extra == "dev"
-Requires-Dist: mkdocs; extra == "dev"
-Requires-Dist: mkdocstrings[python]; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: pillow; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: pytest-asyncio; extra == "dev"
-Requires-Dist: pytest>=8.3; extra == "dev"
-Requires-Dist: pytest-env; extra == "dev"
-Requires-Dist: pytest-xdist; extra == "dev"
+Dynamic: license-file
 
 # prefect-gitlab
 

prefect_gitlab-0.3.3/prefect_gitlab.egg-info/requires.txt

@@ -0,0 +1,3 @@
+prefect>=3.0.0
+python-gitlab>=3.12.0
+tenacity>=8.2.3

{prefect_gitlab-0.3.1 → prefect_gitlab-0.3.3}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "prefect-gitlab"
 description = "A Prefect collection for working with GitLab repositories."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 license = { text = "Apache License 2.0" }
 keywords = ["prefect"]
 authors = [{ name = "Prefect Technologies, Inc.", email = "help@prefect.io" }]
@@ -16,16 +16,16 @@ classifiers = [
   "Intended Audience :: System Administrators",
   "License :: OSI Approved :: Apache Software License",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Topic :: Software Development :: Libraries",
 ]
 dependencies = ["prefect>=3.0.0", "python-gitlab>=3.12.0", "tenacity>=8.2.3"]
 dynamic = ["version"]
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
   "aiohttp",
   "coverage",
@@ -74,3 +74,6 @@ show_missing = true
 asyncio_default_fixture_loop_scope = "session"
 asyncio_mode = "auto"
 env = ["PREFECT_TEST_MODE=1"]
+
+[tool.uv.sources]
+prefect = { path = "../../../" }

prefect_gitlab-0.3.3/tests/test_credentials.py

@@ -0,0 +1,46 @@
+from unittest.mock import MagicMock
+
+import pytest
+from prefect_gitlab.credentials import GitLabCredentials
+
+
+def test_gitlab_credentials_get_client(monkeypatch):
+    mock_gitlab = MagicMock()
+    monkeypatch.setattr("prefect_gitlab.credentials.Gitlab", mock_gitlab)
+    gitlab_credentials = GitLabCredentials(
+        url="https://gitlab.example.com", token="my-token"
+    )
+    gitlab_credentials.get_client()
+    mock_gitlab.assert_called_once_with(
+        url=gitlab_credentials.url,
+        oauth_token=gitlab_credentials.token.get_secret_value(),
+    )
+    mock_gitlab.assert_called_once()
+
+
+def test_format_git_credentials_personal_access_token():
+    """Test that personal access tokens get oauth2: prefix and are embedded in URL."""
+    credentials = GitLabCredentials(token="my-personal-token")
+    result = credentials.format_git_credentials("https://gitlab.com/org/repo.git")
+    assert result == "https://oauth2:my-personal-token@gitlab.com/org/repo.git"
+
+
+def test_format_git_credentials_deploy_token():
+    """Test that deploy tokens (username:token format) are used as-is in URL."""
+    credentials = GitLabCredentials(token="deploy-user:deploy-token-value")
+    result = credentials.format_git_credentials("https://gitlab.com/org/repo.git")
+    assert result == "https://deploy-user:deploy-token-value@gitlab.com/org/repo.git"
+
+
+def test_format_git_credentials_already_prefixed():
+    """Test that already-prefixed tokens don't get double-prefixed in URL."""
+    credentials = GitLabCredentials(token="oauth2:my-token")
+    result = credentials.format_git_credentials("https://gitlab.com/org/repo.git")
+    assert result == "https://oauth2:my-token@gitlab.com/org/repo.git"
+
+
+def test_format_git_credentials_no_token_raises():
+    """Test that missing token raises ValueError."""
+    credentials = GitLabCredentials()
+    with pytest.raises(ValueError, match="Token is required for GitLab authentication"):
+        credentials.format_git_credentials("https://gitlab.com/org/repo.git")

{prefect_gitlab-0.3.1 → prefect_gitlab-0.3.3}/tests/test_repositories.py

@@ -1,7 +1,8 @@
 import os
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Set, Tuple
+from typing import Coroutine, Set, Tuple
+from unittest.mock import AsyncMock
 
 import prefect_gitlab
 import pytest
@@ -9,8 +10,6 @@ from prefect_gitlab.credentials import GitLabCredentials
 from prefect_gitlab.repositories import GitLabRepository  # noqa: E402
 from pydantic import SecretStr
 
-from prefect.testing.utilities import AsyncMock
-
 
 class TestGitLab:
     def setup_test_directory(
@@ -253,3 +252,45 @@ class TestGitLab:
         print(mock.call_count)
         # Verify that the function retried the expected number of times
         assert mock.call_count == MAX_CLONE_ATTEMPTS
+
+
+class TestGitLabRepositoryAsyncDispatch:
+    """Tests for GitLabRepository.get_directory migrated from @sync_compatible to @async_dispatch.
+
+    These tests verify the critical behavior from issue #15008 where
+    @sync_compatible would incorrectly return coroutines in sync context.
+    """
+
+    def test_get_directory_sync_context_returns_none_not_coroutine(self, monkeypatch):
+        """get_directory must return None (not coroutine) in sync context.
+
+        This is the critical regression test for issues #14712 and #14625.
+        """
+        import subprocess
+        from unittest.mock import MagicMock
+
+        mock_result = MagicMock()
+        mock_result.returncode = 0
+        mock_result.stderr = ""
+        monkeypatch.setattr(subprocess, "run", MagicMock(return_value=mock_result))
+
+        g = GitLabRepository(repository="prefect")
+        result = g.get_directory()
+
+        assert not isinstance(result, Coroutine), "sync context returned coroutine"
+        assert result is None
+
+    async def test_get_directory_async_context_returns_coroutine(self, monkeypatch):
+        """get_directory should dispatch to async and return coroutine in async context."""
+
+        class p:
+            returncode = 0
+
+        mock = AsyncMock(return_value=p())
+        monkeypatch.setattr(prefect_gitlab.repositories, "run_process", mock)
+
+        g = GitLabRepository(repository="prefect")
+        result = g.get_directory()
+
+        assert isinstance(result, Coroutine)
+        await result  # should complete without error

prefect_gitlab-0.3.1/prefect_gitlab/_version.py

@@ -1,16 +0,0 @@
-# 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.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)

prefect_gitlab-0.3.1/prefect_gitlab/credentials.py

@@ -1,50 +0,0 @@
-"""Module used to enable authenticated interactions with GitLab"""
-
-from typing import Optional
-
-from gitlab import Gitlab
-from pydantic import Field, SecretStr
-
-from prefect.blocks.core import Block
-
-
-class GitLabCredentials(Block):
-    """
-    Store a GitLab personal access token to interact with private GitLab
-    repositories.
-
-    Attributes:
-        token: The personal access token to authenticate with GitLab.
-        url: URL to self-hosted GitLab instances.
-
-    Examples:
-        Load stored GitLab credentials:
-        ```python
-        from prefect_gitlab import GitLabCredentials
-        gitlab_credentials_block = GitLabCredentials.load("BLOCK_NAME")
-        ```
-    """
-
-    _block_type_name = "GitLab Credentials"
-    _logo_url = "https://images.ctfassets.net/gm98wzqotmnx/55edIimT4g9gbjhkh5a3Sp/dfdb9391d8f45c2e93e72e3a4d350771/gitlab-logo-500.png?h=250"
-
-    token: Optional[SecretStr] = Field(
-        title="Personal Access Token",
-        default=None,
-        description="A GitLab Personal Access Token with read_repository scope.",
-    )
-    url: Optional[str] = Field(
-        default=None, title="URL", description="URL to self-hosted GitLab instances."
-    )
-
-    def get_client(self) -> Gitlab:
-        """
-        Gets an authenticated GitLab client.
-
-        Returns:
-            An authenticated GitLab client.
-        """
-        # ref: https://python-gitlab.readthedocs.io/en/stable/
-        gitlab = Gitlab(url=self.url, oauth_token=self.token.get_secret_value())
-        gitlab.auth()
-        return gitlab

prefect_gitlab-0.3.1/prefect_gitlab.egg-info/requires.txt

@@ -1,19 +0,0 @@
-prefect>=3.0.0
-python-gitlab>=3.12.0
-tenacity>=8.2.3
-
-[dev]
-aiohttp
-coverage
-interrogate
-mkdocs-gen-files
-mkdocs-material
-mkdocs
-mkdocstrings[python]
-mypy
-pillow
-pre-commit
-pytest-asyncio
-pytest>=8.3
-pytest-env
-pytest-xdist

prefect_gitlab-0.3.1/tests/test_credentials.py

@@ -1,17 +0,0 @@
-from unittest.mock import MagicMock
-
-from prefect_gitlab.credentials import GitLabCredentials
-
-
-def test_gitlab_credentials_get_client(monkeypatch):
-    mock_gitlab = MagicMock()
-    monkeypatch.setattr("prefect_gitlab.credentials.Gitlab", mock_gitlab)
-    gitlab_credentials = GitLabCredentials(
-        url="https://gitlab.example.com", token="my-token"
-    )
-    gitlab_credentials.get_client()
-    mock_gitlab.assert_called_once_with(
-        url=gitlab_credentials.url,
-        oauth_token=gitlab_credentials.token.get_secret_value(),
-    )
-    mock_gitlab.assert_called_once()