Api reference

components.eyewear.public.blueprints ¶

admin_blueprint ¶

EyewearFrameOrderFilesGetQuerySchema ¶

Bases: Schema

Query schema for GET /frame_orders//files.

file_types `class-attribute` `instance-attribute` ¶

file_types = DelimitedList(Str(), required=True)

eyewear_admin_blueprint `module-attribute` ¶

eyewear_admin_blueprint = OwnedBlueprint(
    name="eyewear_admin", import_name=__name__
)

user_blueprint ¶

ContactLensExemptionRequestPostJsonSchema ¶

Bases: Schema

Schema for creating a contact lens out-of-shop exemption request.

beneficiary_id `class-attribute` `instance-attribute` ¶

beneficiary_id = Int(required=True)

price_in_cents `class-attribute` `instance-attribute` ¶

price_in_cents = Int(required=True, validate=Range(min=1))

purchase_date `class-attribute` `instance-attribute` ¶

purchase_date = Date(required=True)

eyewear_user_blueprint `module-attribute` ¶

eyewear_user_blueprint = OwnedBlueprint(
    name="eyewear", import_name=__name__
)

components.eyewear.public.business_logic ¶

frame_order ¶

get_last_eyewear_frame_order_for_user ¶

get_last_eyewear_frame_order_for_user(feature_user)

Retrieve the last eyewear frame order for a given user.

Parameters:

Name	Type	Description	Default
`feature_user`	`FeatureUser`	The user for whom to retrieve the eyewear frame order.	required

Returns:

Type	Description
`Optional[EyewearFrameOrderData]`	Optional[EyewearFrameOrderData]: The last eyewear frame order data if available, otherwise None.

Source code in components/eyewear/public/business_logic/frame_order.py

def get_last_eyewear_frame_order_for_user(
    feature_user: FeatureUser,
) -> Optional[EyewearFrameOrderData]:
    """
    Retrieve the last eyewear frame order for a given user.

    Args:
        feature_user (FeatureUser): The user for whom to retrieve the eyewear frame order.

    Returns:
        Optional[EyewearFrameOrderData]: The last eyewear frame order data if available, otherwise None.
    """
    eyewear_user = get_eyewear_user_from_user_id_and_app_id(
        user_id=int(feature_user.app_user_id), app_id=feature_user.app_id
    )

    return get_user_last_frame_order(eyewear_user) if eyewear_user else None

components.eyewear.public.commands ¶

app_group ¶

contact_lens_commands `module-attribute` ¶

contact_lens_commands = AppGroup('contact_lens')

eyewear_commands `module-attribute` ¶

eyewear_commands = AppGroup('eyewear')

register_all_commands ¶

register_all_commands()

Source code in components/eyewear/public/commands/app_group.py

def register_all_commands() -> None:  # noqa: D103
    register_contact_lens_commands()
    register_eyewear_commands()

register_contact_lens_commands ¶

register_contact_lens_commands()

Source code in components/eyewear/public/commands/app_group.py

def register_contact_lens_commands() -> None:  # noqa: D103
    from components.eyewear.public.commands.contact_lens_commands import (  # noqa: F401
        build_images_from_weiss_dir,
        cancel_old_unpaid_orders,
        import_catalog,
        notify_stale_orders,
        run_orders_reviewing,
        send_order_rating_notifications,
        send_unpaid_order_notifications,
        simulate_orders_reviewing,
        sync_packages_status_from_laposte,
    )

register_eyewear_commands ¶

register_eyewear_commands()

Source code in components/eyewear/public/commands/app_group.py

def register_eyewear_commands() -> None:  # noqa: D103
    from components.eyewear.public.commands.backfill_favorites_to_shop import (  # noqa: F401
        backfill_favorites_to_shop,
    )
    from components.eyewear.public.commands.eyewear_commands import (  # noqa: F401
        build_images_from_fittingbox_dir,
        build_images_from_photoshoot_dir,
        cancel_return_parcels,
        notify_stale_orders,
        send_order_rating_notifications,
        send_restock_alerts,
        sync_frames_stock_from_turing,
        sync_packages_status_from_sendcloud,
    )

backfill_favorites_to_shop ¶

backfill_favorites_to_shop(dry_run, limit, batch_size)

Backfill ShopFavorite rows from existing EyewearFavorite rows.

Idempotent (safe to re-run). Run with --dry-run first to estimate scope.

Source code in components/eyewear/public/commands/backfill_favorites_to_shop.py

@eyewear_commands.command()
@click.option(
    "--limit",
    type=int,
    default=None,
    help="Process at most this many EyewearUsers (testing).",
)
@click.option(
    "--batch-size",
    type=int,
    default=500,
    help="Number of EyewearUsers to process per transaction.",
)
@command_with_dry_run
def backfill_favorites_to_shop(
    dry_run: bool, limit: int | None, batch_size: int
) -> None:
    """Backfill ShopFavorite rows from existing EyewearFavorite rows.

    Idempotent (safe to re-run). Run with --dry-run first to estimate scope.
    """
    from components.eyewear.internal.business_logic.user_business_logic.backfill_favorites_to_shop import (
        backfill_favorites_to_shop as backfill,
    )

    backfill(dry_run=dry_run, limit=limit, batch_size=batch_size)