Skip to content

Refactor and Document check_env.check()#1826

Open
bmos wants to merge 7 commits intomove-coop:mainfrom
bmos:check_env
Open

Refactor and Document check_env.check()#1826
bmos wants to merge 7 commits intomove-coop:mainfrom
bmos:check_env

Conversation

@bmos
Copy link
Copy Markdown
Collaborator

@bmos bmos commented Apr 10, 2026

What is this change?

  • Add comprehensive documentation to check_env.check().
  • Do not allow optional to be treated as a positional parameter.
  • Rename field parameter to value for clarity, with deprecation warning for old parameter name.
  • Adjust a few nonstandard imports of check directly rather than via importing check_env.

Considerations for discussion

  • Despite being a core function used in many connectors, check_env.check() was minimally documented.
  • Allowing users to provide boolean values for positional parameters is not recommended as their intention can be confusing.

How to test the changes (if needed)

  • CI tests should be adequate

Breaking Changes

Breaking changes are changes to our public API which may require existing users to change their code. If there are no breaking changes, any existing parsons user should not need to do anything after updating their parsons version.

Does this PR introduce breaking changes?
  • label: Breaking change — This PR introduces one or more breaking changes.
  • label: Non-breaking change — This PR does not introduce one or more breaking changes.

@github-actions github-actions bot added python Pull requests that update Python code non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 10, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 10, 2026

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  parsons/aws
  lambda_distribute.py 205
  parsons/notifications
  slack.py 128
  parsons/redash
  redash.py
  parsons/utilities
  check_env.py 39-44
Project Total  

This report was generated by python-coverage-comment-action

@github-actions github-actions bot added breaking-change applied only to PRs, indicates when something has a breaking change to be flagged in release notes and removed non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 10, 2026
@bmos bmos marked this pull request as ready for review April 10, 2026 23:28
@github-actions github-actions bot added non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. breaking-change applied only to PRs, indicates when something has a breaking change to be flagged in release notes and removed breaking-change applied only to PRs, indicates when something has a breaking change to be flagged in release notes non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. labels Apr 10, 2026
@bmos
Copy link
Copy Markdown
Collaborator Author

bmos commented Apr 13, 2026

Do we consider these breaking changes?
I think this function is only used within connectors?

@bmos bmos marked this pull request as draft April 15, 2026 16:27
@github-actions github-actions bot added the testing Work type - writing or changing code tests for core Parsons features or Parsons connectors label Apr 15, 2026
@github-actions github-actions bot added non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. and removed breaking-change applied only to PRs, indicates when something has a breaking change to be flagged in release notes labels Apr 15, 2026
@bmos bmos marked this pull request as ready for review April 15, 2026 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

non-breaking-change Status - Indicates that the code in this PR does not have any breaking changes. python Pull requests that update Python code testing Work type - writing or changing code tests for core Parsons features or Parsons connectors

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant