🔍 Code Extractor

Validates the installation status of all required Python packages for the DocChat application by attempting to import each dependency and logging the results.

Purpose

This function performs a dependency check for the DocChat application to ensure all required packages are installed before the application runs. It verifies the presence of packages needed for document processing (pypdf, python-docx), vector databases (chromadb), LLM integrations (langchain variants), and embeddings (sentence_transformers). The function provides detailed feedback about missing packages and installation instructions, making it useful for deployment validation and troubleshooting.

Source Code

def check_dependencies(app):
    """
    Check if all required DocChat dependencies are installed.
    
    Args:
        app: Flask application instance
        
    Returns:
        dict: Status information about dependencies
    """
    required_packages = [
        'chromadb',
        'langchain',
        'langchain_openai',
        'langchain_anthropic',
        'langchain_google_genai',
        'sentence_transformers',
        'pypdf',
        'python-docx'
    ]
    
    results = {
        'all_installed': True,
        'packages': {}
    }
    
    for package in required_packages:
        try:
            __import__(package.replace('-', '_'))
            results['packages'][package] = 'installed'
        except ImportError:
            results['packages'][package] = 'missing'
            results['all_installed'] = False
    
    if not results['all_installed']:
        logger.warning("⚠️  Some DocChat dependencies are missing:")
        for pkg, status in results['packages'].items():
            if status == 'missing':
                logger.warning(f"   - {pkg}")
        logger.warning("   Install with: pip install -r docchat/requirements.txt")
    else:
        logger.info("✅ All DocChat dependencies are installed")
    
    return results

Parameters

Parameter Details

app: Flask application instance. While passed as a parameter, it is not actually used in the function body. This parameter likely exists for consistency with other initialization functions or for potential future use in accessing application configuration or logging settings.

Return Value

Returns a dictionary with two keys: 'all_installed' (boolean indicating whether all dependencies are present) and 'packages' (dictionary mapping each package name to its status string, either 'installed' or 'missing'). Example: {'all_installed': False, 'packages': {'chromadb': 'installed', 'langchain': 'missing', ...}}

Dependencies

• chromadb
• langchain
• langchain_openai
• langchain_anthropic
• langchain_google_genai
• sentence_transformers
• pypdf
• python-docx
• logging

Required Imports

import logging

Conditional/Optional Imports

These imports are only needed under specific conditions:

import chromadb

import langchain

import langchain_openai

import langchain_anthropic

import langchain_google_genai

import sentence_transformers

import pypdf

import docx

Usage Example

from flask import Flask
import logging

# Setup logger
logger = logging.getLogger(__name__)
logging.basicConfig(level=logging.INFO)

# Create Flask app
app = Flask(__name__)

# Check dependencies
results = check_dependencies(app)

if results['all_installed']:
    print("All dependencies are installed!")
else:
    print("Missing packages:")
    for pkg, status in results['packages'].items():
        if status == 'missing':
            print(f"  - {pkg}")

# Access individual package status
if results['packages']['chromadb'] == 'installed':
    print("ChromaDB is available")

Best Practices

• Ensure a logger is configured before calling this function, as it relies on a module-level 'logger' variable
• Call this function during application initialization or startup to catch missing dependencies early
• Note that the 'app' parameter is currently unused; consider removing it or utilizing it for accessing app-specific configuration
• The function converts package names with hyphens to underscores for import (e.g., 'python-docx' becomes 'python_docx'), which is correct Python behavior
• This function only checks if packages can be imported, not their versions; consider adding version validation if specific versions are required
• The function uses __import__() which is appropriate for dynamic imports but doesn't validate package functionality
• Consider wrapping the function call in a try-except block to handle unexpected import errors gracefully

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function get_integration_status 73.8% similar

  Retrieves the integration status of the DocChat blueprint within a Flask application, including registration status, configuration details, and dependency checks.

  From: /tf/active/vicechatdev/docchat/integration.py

• function check_dependencies_v1 73.1% similar

  Validates the presence of required Python packages by attempting to import them and returns a list of any missing dependencies.

  From: /tf/active/vicechatdev/email-forwarder/run_service.py

• function integrate_docchat 68.7% similar

  One-line integration function that configures and registers the DocChat component into a Flask application, handling dependency checking, configuration, and blueprint registration.

  From: /tf/active/vicechatdev/docchat/integration.py

• function register_docchat 59.0% similar

  Registers a DocChat Flask blueprint with a Flask application instance, handling path configuration and error logging.

  From: /tf/active/vicechatdev/docchat/integration.py

• function configure_docchat 55.0% similar

  Configures DocChat module settings by overriding default configuration values from a Flask application instance and optional keyword arguments.

  From: /tf/active/vicechatdev/docchat/integration.py