build(pip): add dependency on java-api #291
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
igniton-api 8.3.1.post2 now depends on java-api
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates stubs and tooling to align with ignition-api-stubs 8.3.1.post2’s new dependency on java-api and adjusts type hints and tox configs accordingly. Class diagram for updated TransactionManager type hintsclassDiagram
class TransactionManager {
+str transaction_id
+__init__(database: Union[str, unicode], isolation_level: Optional[int], timeout: Optional[int]) None
}
Flow diagram for updated tox typecheck and stubgen environmentsflowchart LR
dev["Developer runs tox"] --> tox["tox"]
tox --> typecheck_env["testenv:typecheck (python3.12)"]
tox --> stubgen_env["testenv:stubgen (python3.12)"]
tox --> stubs_typecheck_env["incendium-stubs testenv:typecheck"]
typecheck_env --> deps_typecheck["deps: ignition-api-stubs>=8.3, mypy[python2]==0.971"]
deps_typecheck --> mypy_src["mypy src"]
stubgen_env --> deps_stubgen["deps: mypy[python2]==0.971"]
deps_stubgen --> stubgen_cmd["stubgen src -> incendium-stubs/stubs"]
stubs_typecheck_env --> deps_stubs_typecheck["deps: requirements.txt, mypy[python2]==0.971"]
deps_stubs_typecheck --> mypy_stubs["mypy stubs"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Dropping
generate-hashesand all the--hashpins fromincendium-stubs/requirements.txtweakens reproducibility/supply-chain guarantees; if this isn’t intentional, consider keeping hashes or explaining why they’re no longer needed. - The
mypy[python2]==0.971andbase_python = python3.12settings are now duplicated across multiple tox envs; consider reintroducing a shared section or factor to avoid drift if these need to change later.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Dropping `generate-hashes` and all the `--hash` pins from `incendium-stubs/requirements.txt` weakens reproducibility/supply-chain guarantees; if this isn’t intentional, consider keeping hashes or explaining why they’re no longer needed.
- The `mypy[python2]==0.971` and `base_python = python3.12` settings are now duplicated across multiple tox envs; consider reintroducing a shared section or factor to avoid drift if these need to change later.
## Individual Comments
### Comment 1
<location> `incendium/tox.ini:48` </location>
<code_context>
black
docformatter
- flake8==5.0.4
+ flake8@ git+https://github.com/coatl-dev/flake8.git@5.0.4
isort
pydoclint
</code_context>
<issue_to_address>
**suggestion:** Pinning flake8 to a commit hash instead of a tag would improve reproducibility.
Tags like `@5.0.4` can be retagged, which may change the resolved code over time. For fully reproducible linting, prefer pinning to a specific commit SHA (e.g. `@<commit-hash>`) and, if helpful, noting which release that SHA corresponds to.
Suggested implementation:
```
flake8@ git+https://github.com/coatl-dev/flake8.git@<flake8-5.0.4-commit-sha> # flake8 5.0.4
```
You’ll need to:
1. Look up the exact commit SHA that corresponds to the `5.0.4` tag in `https://github.com/coatl-dev/flake8.git`.
2. Replace `<flake8-5.0.4-commit-sha>` with that full SHA (e.g. `a1b2c3d4e5f6...`).
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| black | ||
| docformatter | ||
| flake8==5.0.4 | ||
| flake8@ git+https://github.com/coatl-dev/flake8.git@5.0.4 |
Contributor
There was a problem hiding this comment.
suggestion: Pinning flake8 to a commit hash instead of a tag would improve reproducibility.
Tags like @5.0.4 can be retagged, which may change the resolved code over time. For fully reproducible linting, prefer pinning to a specific commit SHA (e.g. @<commit-hash>) and, if helpful, noting which release that SHA corresponds to.
Suggested implementation:
flake8@ git+https://github.com/coatl-dev/flake8.git@<flake8-5.0.4-commit-sha> # flake8 5.0.4
You’ll need to:
- Look up the exact commit SHA that corresponds to the
5.0.4tag inhttps://github.com/coatl-dev/flake8.git. - Replace
<flake8-5.0.4-commit-sha>with that full SHA (e.g.a1b2c3d4e5f6...).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
igniton-api 8.3.1.post2 now depends on java-api
Summary by Sourcery
Update ignition-related stubs and tooling to support the new java-api dependency and adjust type-checking configuration for Python 3.12 while preserving Python 2 type checking where needed.
Bug Fixes:
Enhancements:
Build:
Tests: