Consolidate completion checks by iamshravanijadhav · Pull Request #312 · creativecommons/quantifying · GitHub
Skip to content

Consolidate completion checks - #312

Open
iamshravanijadhav wants to merge 2 commits into
creativecommons:mainfrom
iamshravanijadhav:consolidate-completion-check
Open

iamshravanijadhav wants to merge 2 commits into
creativecommons:mainfrom
iamshravanijadhav:consolidate-completion-check

Conversation

@iamshravanijadhav

Copy link
Copy Markdown
Contributor

Fixes

Description

This PR moves the completion check used by the process and report scripts into one shared function.

I replaced check_completion_file_exists with check_for_completion(args, files) in scripts/shared.py and updated the 8 scripts that were using the old function.

The shared check now also supports --enable-save and --force.

Technical details

The new function takes a dictionary in the form {file_path: minimum_lines} and checks whether the expected output files are present and complete.

For the current process and report scripts, the minimum line count is not required, so the files are passed with None.

Tests

  • Ran python -m py_compile on the modified files.
  • Ran git diff --check.
  • Tested complete and incomplete files manually.
  • Tested that --force skips the completion check.
  • Ran python -m unittest discover (0 tests found).

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 (also see Avoiding generative AI development tools — Creative Commons Open Source).
  • 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 unit tests and/or test scripts 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.

@iamshravanijadhav
iamshravanijadhav requested review from a team as code owners October 8, 2026 08:06
@iamshravanijadhav
iamshravanijadhav requested review from TimidRobot and possumbilities and removed request for a team October 8, 2026 08:06

@TimidRobot TimidRobot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thank you!

This work stands on it's own, but it would benefit from updating the fetch scripts, as well.

Comment thread scripts/shared.py
Comment on lines +52 to +53

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please expand this a little more to explain expected data structure of files and that minimum_lines can be 0 or None to skip that check.

@iamshravanijadhav

Copy link
Copy Markdown
Contributor Author

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.

Consolidate completion check

3 participants