Gone Global!

[ian-young]

Gone Global

Description

This PR refactors the camera compatibility script to include type annotations, improve function definitions, and update functionality for better clarity and maintainability. The following changes have been implemented:

1. Type Annotations Added:

   • Added type hints to function signatures for better readability and to support type checking.
   • Updated CompatibleModel class and all relevant functions with appropriate types.

2. Refactored find_matching_camera Function:

   • Updated to accept a list of CompatibleModel objects directly, improving clarity and functionality.

3. New tabulate_data Function:

   • Introduced tabulate_data function to handle data tabulation and printing, separating concerns for better modularity.

4. Updated identify_model_column Function:

   • Improved the identify_model_column function to use a set for column_values to avoid duplicate processing.
   • Enhanced comments and cleaned up the logic for clarity.

5. Improved Documentation:

   • Updated docstrings to reflect the new type annotations and provide clear explanations of the function parameters and return types.

6. Code Formatting:

   • Made minor adjustments to align with PEP 8 and improve code readability.

Changes

• CompatibleModel class:

  • Added type annotations to the init and str methods.

• Function Definitions:

  • get_camera_list: Updated type hints to handle List[CompatibleModel] and Dict[str, CompatibleModel].
  • find_matching_camera: Changed to accept verkada_cameras as a parameter.
  • parse_compatibility_list: Updated docstring to reflect new return type.
  • read_customer_list: Simplified return type annotation.
  • tabulate_data: Added to handle data printing in a tabulated format.
  • identify_model_column: Updated to use a set for column values and added improved comments.

• Updated stubs:

  • process stub is updated so the expected tuple output is correct.

Example Usage

The refactored functions now include type hints, making it easier to understand the expected inputs and outputs. For instance, the identify_model_column function now requires both the raw customer data and the list of Verkada camera models to determine the best matching column index.

Type of change

• [x] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

How Has This Been Tested?

The changes have been tested with CSV outputs using the following steps:

1. Ran the script using the CSV found in the repository.
2. Checked output printed in terminal was formatted properly.
3. Checked the output saved to the file matched the original output.

• [x] Test A: CSV import
• [x] Test B: Terminal outputs
• [x] Test C: CSV output matched original

Test Configuration:

• Firmware version: N/A
• Hardware: N/A
• Toolchain: Python 3.12.5
• SDK: Visual Studio Code

Checklist

• [x] My code follows the PEP8 style guidelines.
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [x] My changes generate no new warnings
• [x] I have added tests that prove my fix is effective or that my feature works
• [x] New and existing unit tests pass locally with my changes
• [x] Any dependent changes have been merged and published in downstream modules