🔍 Code Extractor

Factory function that creates and initializes a PDFGenerator instance with registered fonts and optional custom style initialization, using a non-standard instantiation pattern to bypass __init__.

Purpose

This function provides a controlled way to instantiate PDFGenerator objects, particularly useful for avoiding style initialization conflicts when styles have already been registered. It manually sets up the generator's attributes, registers fonts, and conditionally initializes custom styles based on the skip_styles parameter. This is especially useful in testing scenarios or when multiple PDFGenerator instances need to be created without re-registering styles.

Source Code

def get_pdf_generator(skip_styles: bool = False) -> PDFGenerator:
    """
    Get a PDFGenerator instance with optional style initialization skipping.
    
    Parameters
    ----------
    skip_styles : bool
        Whether to skip custom style initialization to avoid errors
        
    Returns
    -------
    PDFGenerator
        Initialized PDF generator
    """
    generator = PDFGenerator.__new__(PDFGenerator)
    
    # Set default attributes
    generator.styles = getSampleStyleSheet()
    generator.font_dir = settings.FONT_DIR
    generator.logo_path = settings.LOGO_PATH
    
    # Register fonts
    generator._register_fonts(generator.font_dir)
    
    # Initialize styles only if not skipping
    if not skip_styles:
        try:
            generator._initialize_custom_styles()
        except KeyError as e:
            # Style already exists, use existing styles
            logger.warning(f"Using existing styles due to conflict: {e}")
    
    return generator

Parameters

Parameter Details

skip_styles: Boolean flag that controls whether custom style initialization should be skipped. When True, only default ReportLab styles are used, avoiding potential KeyError exceptions from duplicate style registration. When False (default), attempts to initialize custom styles and falls back gracefully if conflicts occur. Use True when you know styles are already registered or want to use only default styles.

Return Value

Type: PDFGenerator

Returns a fully initialized PDFGenerator instance with registered fonts and styles. The instance has its styles attribute set to ReportLab's sample stylesheet, font_dir and logo_path configured from settings, and fonts registered. If skip_styles is False and no conflicts occur, custom styles are also initialized. The returned object is ready to generate PDF documents.

Dependencies

• reportlab
• CDocs

Required Imports

from reportlab.lib.styles import getSampleStyleSheet
from CDocs.config import settings

Usage Example

# Basic usage with default style initialization
generator = get_pdf_generator()

# Usage skipping custom styles (useful for testing or avoiding conflicts)
generator = get_pdf_generator(skip_styles=True)

# Use the generator to create PDFs
pdf_content = generator.generate_report(data={'title': 'My Report', 'content': 'Report content'})

# When creating multiple instances in the same session
generator1 = get_pdf_generator()
generator2 = get_pdf_generator(skip_styles=True)  # Skip to avoid style re-registration

Best Practices

• Use skip_styles=True when creating multiple PDFGenerator instances in the same process to avoid style registration conflicts
• Ensure settings.FONT_DIR and settings.LOGO_PATH are properly configured before calling this function
• The function uses __new__ to bypass normal __init__ constructor, which is an advanced pattern - understand the PDFGenerator class structure before modifying
• The function gracefully handles KeyError exceptions during style initialization, logging warnings instead of failing
• Consider using skip_styles=True in unit tests to isolate style-related issues
• The returned generator is stateful - create new instances for concurrent PDF generation operations

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class PDFGenerator 53.1% similar

  PDF document generation for reports and controlled documents This class provides methods to generate PDF documents from scratch, including audit reports, document covers, and certificate pages.

  From: /tf/active/vicechatdev/CDocs/utils/pdf_utils.py

• function export_to_pdf 48.5% similar

  Exports a document with text and data sections to a PDF file using ReportLab, handling custom styling, section ordering, and content formatting including Quill Delta to HTML/Markdown conversion.

  From: /tf/active/vicechatdev/vice_ai/new_app.py

• function add_formatted_content_to_pdf 45.5% similar

  Processes markdown elements and adds them to a PDF document story with appropriate formatting, handling headers, paragraphs, lists, and tables.

  From: /tf/active/vicechatdev/vice_ai/complex_app.py

• function add_formatted_content_to_pdf_v1 44.4% similar

  Converts processed markdown elements into formatted PDF content by adding paragraphs, headers, lists, and tables to a ReportLab story object with appropriate styling.

  From: /tf/active/vicechatdev/vice_ai/new_app.py

• function export_to_pdf_v1 43.9% similar

  Converts a document object with sections and references into a formatted PDF file using ReportLab, supporting multiple heading levels, text content with markdown/HTML processing, and reference management.

  From: /tf/active/vicechatdev/vice_ai/complex_app.py