Skip to content

Conversation

@Opsmithe
Copy link

@Opsmithe Opsmithe commented Nov 24, 2025

Fixes

Problem

Process and report scripts fail with cryptic FileNotFoundError exceptions when required data files don't exist, providing unhelpful error messages to users.

Solution

Added safe_open_file() function to shared.py that validates file existence before operations and converts FileNotFoundError to meaningful QuantifyingException messages.

Changes

  • Added safe_open_file() function in scripts/shared.py
  • Updated all process scripts to use safe file validation:
    • scripts/2-process/gcs_process.py (3 calls)
    • scripts/2-process/github_process.py (1 call)
  • Updated all report scripts to use safe file validation:
    • scripts/3-report/gcs_report.py (9 calls)
    • scripts/3-report/github_report.py (2 calls)

Before/After

Before:

FileNotFoundError: [Errno 2] No such file or directory: 'github_1_count.csv'

After:

QuantifyingException: Cannot process GitHub count data file: github_1_count.csv does not exist

Testing

  • All static analysis checks pass (black, flake8, isort)
  • Existing exception handling in scripts catches QuantifyingException
  • Scripts exit gracefully with helpful error messages

Files Changed

  • scripts/shared.py
  • scripts/2-process/gcs_process.py
  • scripts/2-process/github_process.py
  • scripts/3-report/gcs_report.py
  • scripts/3-report/github_report.py

Checklist

  • I have read and understood the Developer Certificate of Origin (DCO), below, which covers the contents of this pull request (PR).
  • My pull request doesn't include code or content generated with AI.
  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Opsmithe Opsmithe requested review from a team as code owners November 24, 2025 09:30
@Opsmithe Opsmithe requested review from Shafiya-Heena and TimidRobot and removed request for a team November 24, 2025 09:30
@cc-open-source-bot cc-open-source-bot moved this to In review in TimidRobot Nov 24, 2025
@TimidRobot TimidRobot self-assigned this Nov 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

Add shared function to open data files and handle errors

2 participants