RHOAIENG-28843: Package huggingface detector #41
Closed
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
Reviewer's GuideThis PR restructures the repository into a standardized Python package under src/guardrails_detectors, configures packaging with pyproject.toml and hatchling, updates CI workflows for Docker and PyPI publishing, and adjusts imports, documentation, and tests to the new module layout. Class diagram for updated detector registry structureclassDiagram
class BaseDetectorRegistry {
+__init__()
<<abstract>>
}
class RegexDetectorRegistry {
+__init__()
}
class FileTypeDetectorRegistry {
+__init__()
}
BaseDetectorRegistry <|-- RegexDetectorRegistry
BaseDetectorRegistry <|-- FileTypeDetectorRegistry
Class diagram for updated FastAPI app structure in built_inclassDiagram
class FastAPI {
}
class Instrumentator {
}
class ContentAnalysisHttpRequest {
}
class ContentsAnalysisResponse {
}
class BaseDetectorRegistry {
}
class RegexDetectorRegistry {
}
class FileTypeDetectorRegistry {
}
FastAPI --> Instrumentator
FastAPI --> BaseDetectorRegistry
FastAPI --> RegexDetectorRegistry
FastAPI --> FileTypeDetectorRegistry
FastAPI --> ContentAnalysisHttpRequest
FastAPI --> ContentsAnalysisResponse
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @AmberJBlue - I've reviewed your changes - here's some feedback:
- In tests/conftest.py you reference an undefined
src_pathwhen setting up module paths—make sure to definesrc_path(e.g. asos.path.join(project_root, 'src')) or correct the path variable so imports resolve properly. - Update the Docker build context in build-and-push.yaml to match the new package layout (e.g. use
src/guardrails_detectorsas the build context instead of the olddetectorsfolder) to prevent broken builds. - Double-check the package name in your publish-package.yaml (URL and PyPI name) to ensure it matches the hyphenated project name (
guardrails-detectors) defined in pyproject.toml.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In tests/conftest.py you reference an undefined `src_path` when setting up module paths—make sure to define `src_path` (e.g. as `os.path.join(project_root, 'src')`) or correct the path variable so imports resolve properly.
- Update the Docker build context in build-and-push.yaml to match the new package layout (e.g. use `src/guardrails_detectors` as the build context instead of the old `detectors` folder) to prevent broken builds.
- Double-check the package name in your publish-package.yaml (URL and PyPI name) to ensure it matches the hyphenated project name (`guardrails-detectors`) defined in pyproject.toml.
## Individual Comments
### Comment 1
<location> `.github/workflows/build-and-push.yaml:86` </location>
<code_context>
+ echo 'LABEL quay.expires-after=7d#' >> src/guardrails_detectors/Dockerfile.builtIn
- name: Build image
- run: docker build -t ${{ env.IMAGE_NAME }}:$TAG -f detectors/Dockerfile.hf detectors
+ run: docker build -t ${{ env.IMAGE_NAME }}:$TAG -f src/guardrails_detectors/Dockerfile.hf detectors
- name: Log in to Quay
run: docker login -u ${{ secrets.QUAY_ROBOT_USERNAME }} -p ${{ secrets.QUAY_ROBOT_SECRET }} quay.io
</code_context>
<issue_to_address>
Docker build context may be incorrect after directory move.
Update the build context to 'src/guardrails_detectors' to ensure all necessary files are included in the Docker build.
</issue_to_address>
### Comment 2
<location> `.github/workflows/build-and-push.yaml:92` </location>
<code_context>
run: docker push ${{ env.IMAGE_NAME }}:$TAG
- name: Build built-in detector image
- run: docker build -t ${{ env.BUILTIN_IMAGE_NAME }}:$TAG -f detectors/Dockerfile.builtIn detectors
+ run: docker build -t ${{ env.BUILTIN_IMAGE_NAME }}:$TAG -f src/guardrails_detectors/Dockerfile.builtIn detectors
- name: Push to Quay CI repo
run: docker push ${{ env.BUILTIN_IMAGE_NAME }}:$TAG
</code_context>
<issue_to_address>
Potential mismatch between Dockerfile location and build context.
If required files are now in 'src/guardrails_detectors', using 'detectors' as the build context may cause build failures or incomplete images.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| echo 'LABEL quay.expires-after=7d#' >> src/guardrails_detectors/Dockerfile.builtIn | ||
| - name: Build image | ||
| run: docker build -t ${{ env.IMAGE_NAME }}:$TAG -f detectors/Dockerfile.hf detectors | ||
| run: docker build -t ${{ env.IMAGE_NAME }}:$TAG -f src/guardrails_detectors/Dockerfile.hf detectors |
There was a problem hiding this comment.
issue (bug_risk): Docker build context may be incorrect after directory move.
Update the build context to 'src/guardrails_detectors' to ensure all necessary files are included in the Docker build.
| run: docker push ${{ env.IMAGE_NAME }}:$TAG | ||
| - name: Build built-in detector image | ||
| run: docker build -t ${{ env.BUILTIN_IMAGE_NAME }}:$TAG -f detectors/Dockerfile.builtIn detectors | ||
| run: docker build -t ${{ env.BUILTIN_IMAGE_NAME }}:$TAG -f src/guardrails_detectors/Dockerfile.builtIn detectors |
There was a problem hiding this comment.
issue (bug_risk): Potential mismatch between Dockerfile location and build context.
If required files are now in 'src/guardrails_detectors', using 'detectors' as the build context may cause build failures or incomplete images.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Restructure code to follow Red Hat AI Python Packaging Best Practices to make the HuggingFace detector package compliant and prepare for publishing guardrails-detectors
Summary by Sourcery
Restructure the detectors project into a compliant Python package layout, adjust import paths, and add packaging metadata and workflows for publishing to PyPI and building container images.
Enhancements:
Build:
CI:
Documentation:
Tests: