Skip to content

_TaskCollectPip

_TaskCollectPip

Bases: TaskCollectPipV1

Internal TaskCollectPip schema

Differences with its parent class (TaskCollectPip):

1. We check if the package corresponds to a path in the filesystem, and
   whether it exists (via new validator `check_local_package`, new
   method `is_local_package` and new attribute `package_path`).
2. We include an additional `package_manifest` attribute.
3. We expose an additional attribute `package_name`, which is filled
   during task collection.
Source code in fractal_server/tasks/v1/_TaskCollectPip.py
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
class _TaskCollectPip(TaskCollectPipV1):
    """
    Internal TaskCollectPip schema

    Differences with its parent class (`TaskCollectPip`):

        1. We check if the package corresponds to a path in the filesystem, and
           whether it exists (via new validator `check_local_package`, new
           method `is_local_package` and new attribute `package_path`).
        2. We include an additional `package_manifest` attribute.
        3. We expose an additional attribute `package_name`, which is filled
           during task collection.
    """

    package_name: Optional[str] = None
    package_path: Optional[Path] = None
    package_manifest: Optional[ManifestV1] = None

    @property
    def is_local_package(self) -> bool:
        return bool(self.package_path)

    @root_validator(pre=True)
    def check_local_package(cls, values):
        """
        Checks if package corresponds to an existing path on the filesystem

        In this case, the user is providing directly a package file, rather
        than a remote one from PyPI. We set the `package_path` attribute and
        get the actual package name and version from the package file name.
        """
        if "/" in values["package"]:
            package_path = Path(values["package"])
            if not package_path.is_absolute():
                raise ValueError("Package path must be absolute")
            if package_path.exists():
                values["package_path"] = package_path
                (
                    values["package"],
                    values["version"],
                    *_,
                ) = package_path.name.split("-")
            else:
                raise ValueError(f"Package {package_path} does not exist.")
        return values

    @property
    def package_source(self) -> str:
        """
        NOTE: As of PR #1188 in `fractal-server`, the attribute
        `self.package_name` is normalized; this means e.g. that `_` is
        replaced by `-`. To guarantee backwards compatibility with
        `Task.source` attributes created before this change, we still replace
        `-` with `_` upon generation of the `source` attribute, in this
        method.
        """
        if not self.package_name or not self.package_version:
            raise ValueError(
                "Cannot construct `package_source` property with "
                f"{self.package_name=} and {self.package_version=}."
            )
        if self.is_local_package:
            collection_type = "pip_local"
        else:
            collection_type = "pip_remote"

        package_extras = self.package_extras or ""
        if self.python_version:
            python_version = f"py{self.python_version}"
        else:
            python_version = ""

        source = ":".join(
            (
                collection_type,
                self.package_name.replace("-", "_"),  # see method docstring
                self.package_version,
                package_extras,
                python_version,
            )
        )
        return source

    def check(self):
        """
        Verify that the package has all attributes that are needed to continue
        with task collection
        """
        if not self.package_name:
            raise ValueError("`package_name` attribute is not set")
        if not self.package_version:
            raise ValueError("`package_version` attribute is not set")
        if not self.package_manifest:
            raise ValueError("`package_manifest` attribute is not set")

package_source: str property

NOTE: As of PR #1188 in fractal-server, the attribute self.package_name is normalized; this means e.g. that _ is replaced by -. To guarantee backwards compatibility with Task.source attributes created before this change, we still replace - with _ upon generation of the source attribute, in this method.

check()

Verify that the package has all attributes that are needed to continue with task collection

Source code in fractal_server/tasks/v1/_TaskCollectPip.py
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def check(self):
    """
    Verify that the package has all attributes that are needed to continue
    with task collection
    """
    if not self.package_name:
        raise ValueError("`package_name` attribute is not set")
    if not self.package_version:
        raise ValueError("`package_version` attribute is not set")
    if not self.package_manifest:
        raise ValueError("`package_manifest` attribute is not set")

check_local_package(values)

Checks if package corresponds to an existing path on the filesystem

In this case, the user is providing directly a package file, rather than a remote one from PyPI. We set the package_path attribute and get the actual package name and version from the package file name.

Source code in fractal_server/tasks/v1/_TaskCollectPip.py
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@root_validator(pre=True)
def check_local_package(cls, values):
    """
    Checks if package corresponds to an existing path on the filesystem

    In this case, the user is providing directly a package file, rather
    than a remote one from PyPI. We set the `package_path` attribute and
    get the actual package name and version from the package file name.
    """
    if "/" in values["package"]:
        package_path = Path(values["package"])
        if not package_path.is_absolute():
            raise ValueError("Package path must be absolute")
        if package_path.exists():
            values["package_path"] = package_path
            (
                values["package"],
                values["version"],
                *_,
            ) = package_path.name.split("-")
        else:
            raise ValueError(f"Package {package_path} does not exist.")
    return values