constants.py

Overview

The constants.py file serves as a centralized location within the InfiniFlow system for defining global constant values that are used throughout the application. These constants include configuration settings, limits on input parameters, API versioning, and standard string prefixes. By consolidating these values, the file ensures consistency, simplifies maintenance, and reduces the risk of magic numbers or strings scattered across the codebase.

This file contains only constant variable declarations and does not define any classes or functions. These constants primarily configure limits (such as name lengths), service identifiers, versioning, and timing parameters.

Detailed Explanation of Constants

NAME_LENGTH_LIMIT

• Type: int

• Value: 2**10 (which equals 1024)

• Purpose: Defines the maximum allowed length for generic names within the system. This limit helps validate user input or system-generated identifiers to prevent excessively long strings that could cause errors or degrade performance.

• Usage Example:

  if len(name) > NAME_LENGTH_LIMIT:
      raise ValueError("Name exceeds maximum allowed length.")
  

IMG_BASE64_PREFIX

• Type: str

• Value: "data:image/png;base64,"

• Purpose: A standard prefix used when embedding base64-encoded PNG images in HTML or other contexts. This prefix is typically prepended to base64 strings to form valid data URLs.

• Usage Example:

  img_data_url = IMG_BASE64_PREFIX + base64_encoded_image_str
  

SERVICE_CONF

• Type: str

• Value: "service_conf.yaml"

• Purpose: Filename for the main service configuration file. This constant standardizes the filename used when loading or referencing service configurations.

• Usage Example:

  with open(SERVICE_CONF, "r") as conf_file:
      service_config = yaml.safe_load(conf_file)
  

API_VERSION

• Type: str

• Value: "v1"

• Purpose: Indicates the current API version used by the system. This constant facilitates version control and backward compatibility for API endpoints.

• Usage Example:

  api_endpoint = f"/api/{API_VERSION}/resource"
  

RAG_FLOW_SERVICE_NAME

• Type: str

• Value: "ragflow"

• Purpose: Specifies the service name for the RAG (Retrieval-Augmented Generation) flow component. This is likely used in service discovery, logging, or messaging within the system.

• Usage Example:

  logger.info(f"Starting service: {RAG_FLOW_SERVICE_NAME}")
  

REQUEST_WAIT_SEC

• Type: int

• Value: 2

• Purpose: Defines the base wait time (in seconds) between retries or polling intervals when waiting for a response from a request.

• Usage Example:

  time.sleep(REQUEST_WAIT_SEC)
  

REQUEST_MAX_WAIT_SEC

• Type: int

• Value: 300

• Purpose: Specifies the maximum total wait time (in seconds) allowed for a request before timing out or giving up.

• Usage Example:

  start_time = time.time()
  while time.time() - start_time < REQUEST_MAX_WAIT_SEC:
      # retry logic
  

DATASET_NAME_LIMIT

• Type: int

• Value: 128

• Purpose: Limits the maximum length of dataset names to ensure they are within acceptable bounds for storage or display.

• Usage Example:

  if len(dataset_name) > DATASET_NAME_LIMIT:
      raise ValueError("Dataset name is too long.")
  

FILE_NAME_LEN_LIMIT

• Type: int

• Value: 255

• Purpose: Defines the maximum length for file names, aligning with common file system constraints.

• Usage Example:

  if len(file_name) > FILE_NAME_LEN_LIMIT:
      raise ValueError("File name exceeds allowed length.")
  

Implementation Details

• The constants are defined using uppercase naming conventions to clearly indicate their immutability and global usage.

• Numeric limits like NAME_LENGTH_LIMIT use bit-shift operations (e.g., 2**10) for readability and clarity.

• String constants are used to avoid hardcoding values multiple times, reducing risk of inconsistency.

• Timing constants (REQUEST_WAIT_SEC and REQUEST_MAX_WAIT_SEC) provide a configurable way to control request polling behavior, which can help in managing system responsiveness and resource utilization.

Interaction with Other System Components

• Configuration Loading: SERVICE_CONF is used by configuration loaders to locate and parse service settings.

• API Routing: API_VERSION is leveraged in REST or RPC API route definitions to manage versioning.

• Request Handling: The wait-related constants (REQUEST_WAIT_SEC and REQUEST_MAX_WAIT_SEC) assist request handlers or client utilities in managing retries and timeouts.

• Data Validation: Length limits (NAME_LENGTH_LIMIT, DATASET_NAME_LIMIT, FILE_NAME_LEN_LIMIT) enforce validation rules across modules that handle user input, dataset registration, or file operations.

• Image Handling: IMG_BASE64_PREFIX is utilized when encoding images for web or UI components.

• Service Identification: RAG_FLOW_SERVICE_NAME helps modules identify or log messages related to the RAG flow service.

By centralizing these constants, the file promotes maintainability and consistency across the InfiniFlow application.

Visual Diagram

flowchart TD
    A[constants.py] --> B[NAME_LENGTH_LIMIT]
    A --> C[IMG_BASE64_PREFIX]
    A --> D[SERVICE_CONF]
    A --> E[API_VERSION]
    A --> F[RAG_FLOW_SERVICE_NAME]
    A --> G[REQUEST_WAIT_SEC]
    A --> H[REQUEST_MAX_WAIT_SEC]
    A --> I[DATASET_NAME_LIMIT]
    A --> J[FILE_NAME_LEN_LIMIT]

    B --> K[Used for input validation]
    C --> L[Used for image data URLs]
    D --> M[Service config file reference]
    E --> N[API versioning in routes]
    F --> O[Service identification]
    G --> P[Request polling interval]
    H --> Q[Request timeout threshold]
    I --> R[Dataset name validation]
    J --> S[File name validation]

Summary

constants.py is a utility file containing important fixed values that govern naming rules, API versions, service names, request timings, and configuration file naming within the InfiniFlow system. It plays a foundational role in maintaining consistent behavior, improving code clarity, and facilitating configuration management across multiple modules.