Improve code readability across experimental workflow and utilities modules

[Copilot]

This PR significantly enhances code readability and maintainability across several key modules in the OpenFL codebase without breaking any existing functionality.

Key Improvements

Constants and Magic Values

• Extracted magic strings and numbers into well-named constants for better maintainability
• Added DEFAULT_EXP_PATTERN, RUNTIME_CLASS_NAME, RUN_METHOD_PATTERN and other constants
• Centralized configuration values like TREE_SYMBOLS and WORKSPACE_CONFIG_FILE

Enhanced Documentation

• Added comprehensive docstrings with proper formatting and structure
• Included detailed parameter descriptions, return types, and exception information
• Improved class-level documentation with clear attribute descriptions

Better Naming Conventions

• Renamed methods for clarity (e.g., __get_exp_name → _get_experiment_name)
• Fixed parameter naming that shadowed Python builtins (hash → hash_value)
• Used more descriptive variable names throughout
• Improved class naming (bcolors → TerminalColors with backward compatibility)

Type Safety and Structure

• Added proper type annotations for better IDE support and code understanding
• Enhanced error handling with specific exception types and clear messages
• Improved code organization with logical grouping and cleaner helper functions

Files Modified

openfl/experimental/workflow/notebooktools/code_analyzer.py

Major refactoring of the CodeAnalyzer class:

• Extracted constants for regex patterns and configuration values
• Improved method naming and documentation
• Enhanced error handling with descriptive messages
• Better variable naming throughout the class

openfl/experimental/workflow/interface/cli/cli_helper.py

Enhanced CLI helper functions:

• Added constants for tree symbols and path configurations
• Improved function documentation with comprehensive parameter descriptions
• Added proper type hints for all functions
• Better error handling in utility functions

openfl/utilities/utils.py

Fixed code quality issues:

• Renamed hash parameter to hash_value to avoid shadowing builtin
• Improved documentation formatting

tests/github/experimental/workflow/LocalRuntime/testflow_exclude.py

• Improved class naming with proper documentation
• Maintained backward compatibility through aliasing

Benefits

• Maintainability: Constants and clear naming make the code easier to modify
• Readability: Enhanced documentation and structure improve code comprehension
• Type Safety: Added type hints provide better development experience
• Quality: Fixed code smells and followed Python best practices
• Compatibility: All changes maintain full backward compatibility

All changes pass linting checks and maintain existing functionality while making the codebase significantly more readable and maintainable for future contributors.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.