Skip to content

users_csv

Definition of /auth/users/csv/ route.

list_users(exclude_zero_jobs=False, start_timestamp_min=None, start_timestamp_max=None, superuser=Depends(current_superuser_act), db=Depends(get_async_db)) async

Provide csv table of users and some of their properties.

Source code in fractal_server/app/routes/admin/v2/users_csv.py 
 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
104
105
106
107
108
109
110
111
112
113
@router.get("/", response_class=StreamingResponse)
async def list_users(
    exclude_zero_jobs: bool = False,
    start_timestamp_min: AwareDatetime | None = None,
    start_timestamp_max: AwareDatetime | None = None,
    superuser: UserOAuth = Depends(current_superuser_act),
    db: AsyncSession = Depends(get_async_db),
) -> StreamingResponse:
    """
    Provide csv table of users and some of their properties.
    """
    stm_num_job = select(func.count(JobV2.id)).where(
        JobV2.user_email == UserOAuth.email
    )
    if start_timestamp_min is not None:
        stm_num_job = stm_num_job.where(
            JobV2.start_timestamp >= start_timestamp_min
        )
    if start_timestamp_max is not None:
        stm_num_job = stm_num_job.where(
            JobV2.start_timestamp <= start_timestamp_max
        )
    stm_user_groups = (
        select(func.aggregate_strings(UserGroup.name, _ARRAY_SEPARATOR))
        .select_from(
            join(
                LinkUserGroup,
                UserGroup,
                LinkUserGroup.group_id == UserGroup.id,
            )
        )
        .where(LinkUserGroup.user_id == UserOAuth.id)
    )

    stm = (
        select(
            Bundle(
                "my-bundle",
                UserOAuth.id,
                UserOAuth.email,
                Profile.username,
                func.array_to_string(
                    UserOAuth.slurm_accounts,
                    _ARRAY_SEPARATOR,
                ),
                func.array_to_string(
                    UserOAuth.project_dirs,
                    _ARRAY_SEPARATOR,
                ),
                stm_user_groups.scalar_subquery(),
                stm_num_job.scalar_subquery(),
            ),
        )
        .join(Profile, Profile.id == UserOAuth.profile_id)
        .order_by(UserOAuth.email)
    )
    res = await db.execute(stm)
    users = res.scalars().all()

    # Exclude users without jobs in the given time interval
    if exclude_zero_jobs:
        users = [row for row in users if row[-1] > 0]

    with io.StringIO() as output:
        writer = csv.writer(output)
        writer.writerow(_COLUMN_NAMES)
        writer.writerows(users)
        csv_string = output.getvalue()

    return StreamingResponse(
        csv_string,
        media_type="text/csv",
        headers={"Content-Disposition": "attachment"},
    )