Class GitRef

sdk/python/src/dagger/client/gen.py:9475–9593

A git ref (tag, branch, or commit).

@typecheck
class GitRef(Type):
    """A git ref (tag, branch, or commit)."""

    async def commit(self) -> str:
        """The resolved commit id at this ref.

        Returns
        -------
        str
            The `String` scalar type represents textual data, represented as
            UTF-8 character sequences. The String type is most often used by
            GraphQL to represent free-form human-readable text.

        Raises
        ------
        ExecuteTimeoutError
            If the time to execute the query exceeds the configured timeout.
        QueryError
            If the API returns an error.
        """
        _args: list[Arg] = []
        _ctx = self._select("commit", _args)
        return await _ctx.execute(str)

    def common_ancestor(self, other: Self) -> Self:
        """Find the best common ancestor between this ref and another ref.

        Parameters
        ----------
        other:
            The other ref to compare against.
        """
        _args = [
            Arg("other", other),
        ]
        _ctx = self._select("commonAncestor", _args)
        return GitRef(_ctx)

    async def id(self) -> str:
        """A unique identifier for this GitRef.

        Note
        ----
        This is lazily evaluated, no operation is actually run.

        Returns
        -------
        str
            The `ID` scalar type represents a unique identifier, often used to
            refetch an object or as key for a cache. The ID type appears in a
            JSON response as a String; however, it is not intended to be
            human-readable. When expected as an input type, any string (such
            as `"4"`) or integer (such as `4`) input value will be accepted as
            an ID.

        Raises
        ------
        ExecuteTimeoutError