Constants Module

The constants module provides package-wide constant values used across spryx-core. These constants serve as singleton instances and standard values to maintain consistency throughout the codebase.

Key Features

Singleton Sentinels: Shared instances of sentinel objects
Global Access: Centralized location for commonly used constants

API Reference

Constants used throughout the spryx-core package.

This module defines constants that are used across the package, such as sentinel instances.

Usage Examples

NOT_GIVEN Sentinel

The most important constant is the NOT_GIVEN sentinel, which is a singleton instance of the NotGiven class:

from spryx_core import NOT_GIVEN

# Using NOT_GIVEN as a default parameter value
def update_user(name=NOT_GIVEN, email=NOT_GIVEN):
    updates = {}

    if name is not NOT_GIVEN:
        updates["name"] = name

    if email is not NOT_GIVEN:
        updates["email"] = email

    return updates

# Usage
update_user(name="John")        # {"name": "John"}
update_user(email="j@test.com") # {"email": "j@test.com"}
update_user()                   # {}

Best Practices

Import from Top Level: For commonly used constants like NOT_GIVEN, import directly from the top-level package:

from spryx_core import NOT_GIVEN

Identity Comparison: When comparing against sentinel values, use the is operator for identity comparison:

if value is NOT_GIVEN:
    # Handle not given case

Consistency: Use the constants consistently throughout your codebase to maintain predictable behavior.