API Reference

User privacy settings module for activity visibility control.

This module provides CRUD operations and data models for user privacy settings including activity visibility levels and various data hiding options for activities.

Exports

• CRUD: get_user_privacy_settings_by_user_id, create_user_privacy_settings, edit_user_privacy_settings
• Schemas: UsersPrivacySettingsBase, UsersPrivacySettingsCreate, UsersPrivacySettingsRead, UsersPrivacySettingsUpdate
• Models: UsersPrivacySettings (ORM model)
• Enums: ActivityVisibility

ActivityVisibility

Bases: Enum

Activity visibility levels.

Attributes:

Name	Type	Description
PUBLIC		Visible to everyone.
FOLLOWERS		Visible only to followers.
PRIVATE		Visible only to the user.

Source code in backend/app/users/users_privacy_settings/schema.py

class ActivityVisibility(Enum):
    """
    Activity visibility levels.

    Attributes:
        PUBLIC: Visible to everyone.
        FOLLOWERS: Visible only to followers.
        PRIVATE: Visible only to the user.
    """

    PUBLIC = "public"
    FOLLOWERS = "followers"
    PRIVATE = "private"

UsersPrivacySettingsBase

Bases: BaseModel

Base schema for user privacy settings.

Attributes:

Name	Type	Description
default_activity_visibility	ActivityVisibility | None	Default activity visibility level.
hide_activity_start_time	StrictBool | None	Hide start time from activities.
hide_activity_location	StrictBool | None	Hide location data from activities.
hide_activity_map	StrictBool | None	Hide map visualization from activities.
hide_activity_hr	StrictBool | None	Hide heart rate data from activities.
hide_activity_power	StrictBool | None	Hide power data from activities.
hide_activity_cadence	StrictBool | None	Hide cadence data from activities.
hide_activity_elevation	StrictBool | None	Hide elevation data from activities.
hide_activity_speed	StrictBool | None	Hide speed data from activities.
hide_activity_pace	StrictBool | None	Hide pace data from activities.
hide_activity_laps	StrictBool | None	Hide lap data from activities.
hide_activity_workout_sets_steps	StrictBool | None	Hide workout sets and steps from activities.
hide_activity_gear	StrictBool | None	Hide gear information from activities.

Source code in backend/app/users/users_privacy_settings/schema.py

class UsersPrivacySettingsBase(BaseModel):
    """
    Base schema for user privacy settings.

    Attributes:
        default_activity_visibility: Default activity visibility
            level.
        hide_activity_start_time: Hide start time from
            activities.
        hide_activity_location: Hide location data from
            activities.
        hide_activity_map: Hide map visualization from
            activities.
        hide_activity_hr: Hide heart rate data from activities.
        hide_activity_power: Hide power data from activities.
        hide_activity_cadence: Hide cadence data from
            activities.
        hide_activity_elevation: Hide elevation data from
            activities.
        hide_activity_speed: Hide speed data from activities.
        hide_activity_pace: Hide pace data from activities.
        hide_activity_laps: Hide lap data from activities.
        hide_activity_workout_sets_steps: Hide workout sets and
            steps from activities.
        hide_activity_gear: Hide gear information from
            activities.
    """

    default_activity_visibility: ActivityVisibility | None = Field(
        default=ActivityVisibility.PUBLIC,
        description="Default activity visibility (public, followers, private)",
    )
    hide_activity_start_time: StrictBool | None = Field(
        default=False, description="Hide activity start time"
    )
    hide_activity_location: StrictBool | None = Field(
        default=False, description="Hide activity location"
    )
    hide_activity_map: StrictBool | None = Field(
        default=False, description="Hide activity map"
    )
    hide_activity_hr: StrictBool | None = Field(
        default=False, description="Hide activity heart rate"
    )
    hide_activity_power: StrictBool | None = Field(
        default=False, description="Hide activity power"
    )
    hide_activity_cadence: StrictBool | None = Field(
        default=False, description="Hide activity cadence"
    )
    hide_activity_elevation: StrictBool | None = Field(
        default=False, description="Hide activity elevation"
    )
    hide_activity_speed: StrictBool | None = Field(
        default=False, description="Hide activity speed"
    )
    hide_activity_pace: StrictBool | None = Field(
        default=False, description="Hide activity pace"
    )
    hide_activity_laps: StrictBool | None = Field(
        default=False, description="Hide activity laps"
    )
    hide_activity_workout_sets_steps: StrictBool | None = Field(
        default=False, description="Hide activity workout sets and steps"
    )
    hide_activity_gear: StrictBool | None = Field(
        default=False, description="Hide activity gear"
    )

    model_config = ConfigDict(
        from_attributes=True,
        extra="forbid",
        validate_assignment=True,
        use_enum_values=True,
    )

UsersPrivacySettingsCreate

Bases: UsersPrivacySettingsBase

Pydantic model for creating user privacy settings.

Inherits all attributes from UsersPrivacySettingsBase.

Source code in backend/app/users/users_privacy_settings/schema.py

class UsersPrivacySettingsCreate(UsersPrivacySettingsBase):
    """
    Pydantic model for creating user privacy settings.

    Inherits all attributes from UsersPrivacySettingsBase.
    """

UsersPrivacySettingsModel

Bases: Base

User privacy settings for activity visibility control.

Attributes:

Name	Type	Description
id	Mapped[int]	Primary key.
user_id	Mapped[int]	Foreign key to users table (unique).
default_activity_visibility	Mapped[str]	Default visibility level (public, followers, private).
hide_activity_start_time	Mapped[bool]	Hide activity start time.
hide_activity_location	Mapped[bool]	Hide activity location.
hide_activity_map	Mapped[bool]	Hide activity map.
hide_activity_hr	Mapped[bool]	Hide activity heart rate.
hide_activity_power	Mapped[bool]	Hide activity power.
hide_activity_cadence	Mapped[bool]	Hide activity cadence.
hide_activity_elevation	Mapped[bool]	Hide activity elevation.
hide_activity_speed	Mapped[bool]	Hide activity speed.
hide_activity_pace	Mapped[bool]	Hide activity pace.
hide_activity_laps	Mapped[bool]	Hide activity laps.
hide_activity_workout_sets_steps	Mapped[bool]	Hide activity workout sets and steps.
hide_activity_gear	Mapped[bool]	Hide activity gear.
user	Mapped[bool]	Relationship to Users model.

Source code in backend/app/users/users_privacy_settings/models.py

class UsersPrivacySettings(Base):
    """
    User privacy settings for activity visibility control.

    Attributes:
        id: Primary key.
        user_id: Foreign key to users table (unique).
        default_activity_visibility: Default visibility level
            (public, followers, private).
        hide_activity_start_time: Hide activity start time.
        hide_activity_location: Hide activity location.
        hide_activity_map: Hide activity map.
        hide_activity_hr: Hide activity heart rate.
        hide_activity_power: Hide activity power.
        hide_activity_cadence: Hide activity cadence.
        hide_activity_elevation: Hide activity elevation.
        hide_activity_speed: Hide activity speed.
        hide_activity_pace: Hide activity pace.
        hide_activity_laps: Hide activity laps.
        hide_activity_workout_sets_steps: Hide activity workout
            sets and steps.
        hide_activity_gear: Hide activity gear.
        user: Relationship to Users model.
    """

    __tablename__ = "users_privacy_settings"

    id: Mapped[int] = mapped_column(
        primary_key=True,
        autoincrement=True,
    )
    user_id: Mapped[int] = mapped_column(
        ForeignKey("users.id", ondelete="CASCADE"),
        nullable=False,
        unique=True,
        index=True,
        comment="User ID that the privacy settings belongs",
    )
    default_activity_visibility: Mapped[str] = mapped_column(
        String(20),
        default="public",
        nullable=False,
        comment="public, followers, private",
    )
    hide_activity_start_time: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity start time",
    )
    hide_activity_location: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity location",
    )
    hide_activity_map: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity map",
    )
    hide_activity_hr: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity heart rate",
    )
    hide_activity_power: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity power",
    )
    hide_activity_cadence: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity cadence",
    )
    hide_activity_elevation: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity elevation",
    )
    hide_activity_speed: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity speed",
    )
    hide_activity_pace: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity pace",
    )
    hide_activity_laps: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity laps",
    )
    hide_activity_workout_sets_steps: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity workout sets and steps",
    )
    hide_activity_gear: Mapped[bool] = mapped_column(
        default=False,
        nullable=False,
        comment="Hide activity gear",
    )

    # Define a relationship to the Users model
    # TODO: Change to Mapped["User"] when all modules use mapped
    users = relationship("Users", back_populates="users_privacy_settings")

UsersPrivacySettingsRead

Bases: UsersPrivacySettingsBase

Schema for reading user privacy settings.

Attributes:

Name	Type	Description
id	StrictInt	Unique identifier for the privacy settings record.
user_id	StrictInt	Foreign key reference to the user.

Source code in backend/app/users/users_privacy_settings/schema.py

class UsersPrivacySettingsRead(UsersPrivacySettingsBase):
    """
    Schema for reading user privacy settings.

    Attributes:
        id: Unique identifier for the privacy settings record.
        user_id: Foreign key reference to the user.
    """

    id: StrictInt = Field(
        ..., ge=1, description="Unique identifier for privacy settings"
    )
    user_id: StrictInt = Field(
        ..., ge=1, description="Foreign key reference to the user"
    )

UsersPrivacySettingsUpdate

Bases: UsersPrivacySettingsBase

Schema for updating user privacy settings.

Inherits all validation from UsersPrivacySettingsBase. All fields are optional for partial updates.

Source code in backend/app/users/users_privacy_settings/schema.py

class UsersPrivacySettingsUpdate(UsersPrivacySettingsBase):
    """
    Schema for updating user privacy settings.

    Inherits all validation from UsersPrivacySettingsBase.
    All fields are optional for partial updates.
    """

create_user_privacy_settings

create_user_privacy_settings(user_id, db)

Create privacy settings for a user.

Parameters:

Name	Type	Description	Default
user_id	int	The ID of the user to create settings for.	required
db	Session	SQLAlchemy database session.	required

Returns:

Type	Description
UsersPrivacySettings	The created UsersPrivacySettings model.

Raises:

Type	Description
HTTPException	409 error if settings already exist.
HTTPException	500 error if database operation fails.

Source code in backend/app/users/users_privacy_settings/crud.py

@core_decorators.handle_db_errors
def create_user_privacy_settings(
    user_id: int, db: Session
) -> users_privacy_settings_models.UsersPrivacySettings:
    """
    Create privacy settings for a user.

    Args:
        user_id: The ID of the user to create settings for.
        db: SQLAlchemy database session.

    Returns:
        The created UsersPrivacySettings model.

    Raises:
        HTTPException: 409 error if settings already exist.
        HTTPException: 500 error if database operation fails.
    """
    try:
        # Create a new user privacy settings with model defaults
        db_privacy_settings = users_privacy_settings_models.UsersPrivacySettings(
            user_id=user_id,
        )

        # Add the user privacy settings to the database
        db.add(db_privacy_settings)
        db.commit()
        db.refresh(db_privacy_settings)

        # Return the user privacy settings
        return db_privacy_settings
    except IntegrityError as integrity_error:
        # Rollback the transaction
        db.rollback()

        # Raise an HTTPException with a 409 Conflict status code
        raise HTTPException(
            status_code=status.HTTP_409_CONFLICT,
            detail="Privacy settings already exist for this user",
        ) from integrity_error

edit_user_privacy_settings

edit_user_privacy_settings(user_id, user_privacy_settings_data, db)

Update privacy settings for a specific user.

Parameters:

Name	Type	Description	Default
user_id	int	The ID of the user to update settings for.	required
user_privacy_settings_data	UsersPrivacySettingsUpdate	Schema with fields to update.	required
db	Session	SQLAlchemy database session.	required

Returns:

Type	Description
UsersPrivacySettings	The updated UsersPrivacySettings model.

Raises:

Type	Description
HTTPException	404 error if settings not found.
HTTPException	500 error if database operation fails.

Source code in backend/app/users/users_privacy_settings/crud.py

@core_decorators.handle_db_errors
def edit_user_privacy_settings(
    user_id: int,
    user_privacy_settings_data: users_privacy_settings_schema.UsersPrivacySettingsUpdate,
    db: Session,
) -> users_privacy_settings_models.UsersPrivacySettings:
    """
    Update privacy settings for a specific user.

    Args:
        user_id: The ID of the user to update settings for.
        user_privacy_settings_data: Schema with fields to update.
        db: SQLAlchemy database session.

    Returns:
        The updated UsersPrivacySettings model.

    Raises:
        HTTPException: 404 error if settings not found.
        HTTPException: 500 error if database operation fails.
    """
    # Get the user privacy settings by the user id
    db_user_privacy_settings = get_user_privacy_settings_by_user_id(user_id, db)

    if db_user_privacy_settings is None:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail="User privacy settings not found",
        )

    # Dictionary of the fields to update if they are not None
    privacy_settings_dict = user_privacy_settings_data.model_dump(
        exclude_unset=True, exclude={"user_id", "id"}
    )
    # Iterate over the fields and update dynamically
    for key, value in privacy_settings_dict.items():
        setattr(db_user_privacy_settings, key, value)

    # Commit the transaction
    db.commit()
    db.refresh(db_user_privacy_settings)

    # Return the updated user privacy settings
    return db_user_privacy_settings

get_user_privacy_settings_by_user_id

get_user_privacy_settings_by_user_id(user_id, db)

Retrieve privacy settings for a specific user.

Parameters:

Name	Type	Description	Default
user_id	int	The ID of the user to fetch settings for.	required
db	Session	SQLAlchemy database session.	required

Returns:

Type	Description
UsersPrivacySettings | None	The UsersPrivacySettings model if found, None otherwise.

Raises:

Type	Description
HTTPException	500 error if database query fails.

Source code in backend/app/users/users_privacy_settings/crud.py

@core_decorators.handle_db_errors
def get_user_privacy_settings_by_user_id(
    user_id: int, db: Session
) -> users_privacy_settings_models.UsersPrivacySettings | None:
    """
    Retrieve privacy settings for a specific user.

    Args:
        user_id: The ID of the user to fetch settings for.
        db: SQLAlchemy database session.

    Returns:
        The UsersPrivacySettings model if found, None otherwise.

    Raises:
        HTTPException: 500 error if database query fails.
    """
    # Get the user privacy settings by the user id
    stmt = select(users_privacy_settings_models.UsersPrivacySettings).where(
        users_privacy_settings_models.UsersPrivacySettings.user_id == user_id
    )
    return db.execute(stmt).scalar_one_or_none()