Dynamic Example Helpers

Functions to generate dynamic examples for help text:

get_example_modules


def get_example_modules(
    limit:int=2, # Maximum number of module names to return
    config:Optional=None, # Optional configuration to use
)->str: # Comma-separated list of module names

Get example module names dynamically.


get_example_factories


def get_example_factories(
    module_name:str=None, # Optional module name to get factories from (uses first module if None)
    limit:int=4, # Maximum number of factory names to return
    config:Optional=None, # Optional configuration to use
)->str: # Comma-separated list of factory names

Get example factory names dynamically.


get_example_features


def get_example_features(
    module_name:str=None, # Optional module name to get features from (uses first module if None)
    limit:int=3, # Maximum number of feature names to return
    config:Optional=None, # Optional configuration to use
)->str: # Comma-separated list of feature names

Get example feature names dynamically.


get_example_helpers


def get_example_helpers(
    module_name:str=None, # Optional module name to get helpers from (uses first module if None)
    limit:int=2, # Maximum number of helper names to return
    config:Optional=None, # Optional configuration to use
)->str: # Comma-separated list of helper function names

Get example helper function names dynamically.


get_example_core_utils


def get_example_core_utils(
    limit:int=2, # Maximum number of utility names to return
    config:Optional=None, # Optional configuration to use
)->str: # Comma-separated list of core utility names

Get example core utility names dynamically.


get_combine_classes_example


def get_combine_classes_example(
    
)->str: # Example code string using combine_classes

Get a dynamic example of combine_classes usage.


get_example_test_code


def get_example_test_code(
    limit_chars:int=50, # Maximum length of the returned code example
)->str: # Example code string extracted from test functions

Get an actual code example from test functions.

Export