Project User module

Queries

Set of ProjectUser queries.

Source code in kili/entrypoints/queries/project_user/__init__.py

class QueriesProjectUser:
    """Set of ProjectUser queries."""

    # pylint: disable=too-many-arguments,redefined-builtin,dangerous-default-value,invalid-name

    def __init__(self, auth: KiliAuth):
        """Initialize the subclass.

        Args:
            auth: KiliAuth object
        """
        self.auth = auth

    @overload
    def project_users(
        self,
        project_id: str,
        email: Optional[str] = None,
        id: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: List[str] = [
            "activated",
            "id",
            "role",
            "starred",
            "user.email",
            "user.id",
        ],
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: bool = False,
        *,
        as_generator: Literal[True],
    ) -> Generator[Dict, None, None]:
        ...

    @overload
    def project_users(
        self,
        project_id: str,
        email: Optional[str] = None,
        id: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: List[str] = [
            "activated",
            "id",
            "role",
            "starred",
            "user.email",
            "user.id",
        ],
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: bool = False,
        *,
        as_generator: Literal[False] = False,
    ) -> List[Dict]:
        ...

    @typechecked
    def project_users(
        self,
        project_id: str,
        email: Optional[str] = None,
        id: Optional[str] = None,
        organization_id: Optional[str] = None,
        fields: List[str] = [
            "activated",
            "id",
            "role",
            "starred",
            "user.email",
            "user.id",
        ],
        first: Optional[int] = None,
        skip: int = 0,
        disable_tqdm: bool = False,
        *,
        as_generator: bool = False,
    ) -> Iterable[Dict]:
        # pylint: disable=line-too-long
        """Return project users (possibly with their KPIs) that match a set of criteria.

        Args:
            project_id: Identifier of the project
            email: Email of the user
            id: Identifier of the user
            organization_id: Identifier of the user's organization
            fields: All the fields to request among the possible fields for the projectUsers
                See [the documentation](https://docs.kili-technology.com/reference/graphql-api#projectuser) for all possible fields.
            first: Maximum number of users to return
            skip: Number of project users to skip
            disable_tqdm: If `True`, the progress bar will be disabled
            as_generator: If `True`, a generator on the project users is returned.

        Returns:
            A result object which contains the query if it was successful,
                or an error message.

        Examples:
            ```
            # Retrieve consensus marks of all users in project
            >>> kili.project_users(project_id=project_id, fields=['consensusMark', 'user.email'])
            ```
        """
        where = ProjectUserWhere(
            project_id=project_id, email=email, _id=id, organization_id=organization_id
        )
        disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
        options = QueryOptions(disable_tqdm, first, skip)
        project_users_gen = ProjectUserQuery(self.auth.client)(where, fields, options)

        if as_generator:
            return project_users_gen
        return list(project_users_gen)

    @typechecked
    def count_project_users(
        self,
        project_id: str,
        email: Optional[str] = None,
        id: Optional[str] = None,
        organization_id: Optional[str] = None,
    ) -> int:
        """Counts the number of projects and their users that match a set of criteria.

        Args:
            email: Email of the user
            id: Identifier of the user
            organization_id: Identifier of the user's organization
            project_id: Identifier of the project

        Returns:
            The number of project users with the parameters provided
        """
        where = ProjectUserWhere(
            project_id=project_id, email=email, _id=id, organization_id=organization_id
        )
        return ProjectUserQuery(self.auth.client).count(where)

count_project_users(self, project_id, email=None, id=None, organization_id=None)

Counts the number of projects and their users that match a set of criteria.

Parameters:

Name	Type	Description	Default
email	Optional[str]	Email of the user	None
id	Optional[str]	Identifier of the user	None
organization_id	Optional[str]	Identifier of the user's organization	None
project_id	str	Identifier of the project	required

Returns:

Type	Description
int	The number of project users with the parameters provided

Source code in kili/entrypoints/queries/project_user/__init__.py

@typechecked
def count_project_users(
    self,
    project_id: str,
    email: Optional[str] = None,
    id: Optional[str] = None,
    organization_id: Optional[str] = None,
) -> int:
    """Counts the number of projects and their users that match a set of criteria.

    Args:
        email: Email of the user
        id: Identifier of the user
        organization_id: Identifier of the user's organization
        project_id: Identifier of the project

    Returns:
        The number of project users with the parameters provided
    """
    where = ProjectUserWhere(
        project_id=project_id, email=email, _id=id, organization_id=organization_id
    )
    return ProjectUserQuery(self.auth.client).count(where)

project_users(self, project_id, email=None, id=None, organization_id=None, fields=['activated', 'id', 'role', 'starred', 'user.email', 'user.id'], first=None, skip=0, disable_tqdm=False, *, as_generator=False)

Return project users (possibly with their KPIs) that match a set of criteria.

Parameters:

Name	Type	Description	Default
project_id	str	Identifier of the project	required
email	Optional[str]	Email of the user	None
id	Optional[str]	Identifier of the user	None
organization_id	Optional[str]	Identifier of the user's organization	None
fields	List[str]	All the fields to request among the possible fields for the projectUsers See the documentation for all possible fields.	['activated', 'id', 'role', 'starred', 'user.email', 'user.id']
first	Optional[int]	Maximum number of users to return	None
skip	int	Number of project users to skip	0
disable_tqdm	bool	If True, the progress bar will be disabled	False
as_generator	bool	If True, a generator on the project users is returned.	False

Returns:

Type	Description
Iterable[Dict]	A result object which contains the query if it was successful, or an error message.

Examples:

# Retrieve consensus marks of all users in project
>>> kili.project_users(project_id=project_id, fields=['consensusMark', 'user.email'])

Source code in kili/entrypoints/queries/project_user/__init__.py

@typechecked
def project_users(
    self,
    project_id: str,
    email: Optional[str] = None,
    id: Optional[str] = None,
    organization_id: Optional[str] = None,
    fields: List[str] = [
        "activated",
        "id",
        "role",
        "starred",
        "user.email",
        "user.id",
    ],
    first: Optional[int] = None,
    skip: int = 0,
    disable_tqdm: bool = False,
    *,
    as_generator: bool = False,
) -> Iterable[Dict]:
    # pylint: disable=line-too-long
    """Return project users (possibly with their KPIs) that match a set of criteria.

    Args:
        project_id: Identifier of the project
        email: Email of the user
        id: Identifier of the user
        organization_id: Identifier of the user's organization
        fields: All the fields to request among the possible fields for the projectUsers
            See [the documentation](https://docs.kili-technology.com/reference/graphql-api#projectuser) for all possible fields.
        first: Maximum number of users to return
        skip: Number of project users to skip
        disable_tqdm: If `True`, the progress bar will be disabled
        as_generator: If `True`, a generator on the project users is returned.

    Returns:
        A result object which contains the query if it was successful,
            or an error message.

    Examples:
        ```
        # Retrieve consensus marks of all users in project
        >>> kili.project_users(project_id=project_id, fields=['consensusMark', 'user.email'])
        ```
    """
    where = ProjectUserWhere(
        project_id=project_id, email=email, _id=id, organization_id=organization_id
    )
    disable_tqdm = disable_tqdm_if_as_generator(as_generator, disable_tqdm)
    options = QueryOptions(disable_tqdm, first, skip)
    project_users_gen = ProjectUserQuery(self.auth.client)(where, fields, options)

    if as_generator:
        return project_users_gen
    return list(project_users_gen)