-
Notifications
You must be signed in to change notification settings - Fork 796
feat(rails): declare and validate rail dependencies #2195
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Pouyanpi
wants to merge
9
commits into
develop
Choose a base branch
from
pouyanpi/rail-library-requirements
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
8389b69
feat(rails): model Python package requirements
Pouyanpi fd38fe2
feat(rails): validate configured rail requirements
Pouyanpi b49b14a
refactor(library): declare rail runtime dependencies
Pouyanpi cd63406
chore(deps): remove rail installation extras
Pouyanpi 9309801
test(rails): validate F5 requirements
Pouyanpi 70a4ebd
fix(rails): clarify dependency install guidance
Pouyanpi 7cfc26e
docs(rails): document dependency validation
Pouyanpi 2b371dc
fix(rails): address dependency review feedback
Pouyanpi f545de8
test(rails): isolate unknown validator error
Pouyanpi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import shlex | ||
| from pathlib import Path | ||
|
|
||
| import typer | ||
|
|
||
| from nemoguardrails.manifests import ( | ||
| RequirementStatus, | ||
| configured_rail_manifests, | ||
| default_rail_catalog, | ||
| validate_rail_requirements, | ||
| ) | ||
| from nemoguardrails.rails.llm.config import RailsConfig | ||
|
|
||
| app = typer.Typer() | ||
|
|
||
|
|
||
| @app.command("validate") | ||
| def validate_rails( | ||
| config: Path = typer.Option(Path("config"), "--config", exists=True, help="Guardrails configuration path."), | ||
| runtime: bool = typer.Option(False, "--runtime", help="Import declared Python packages after static checks."), | ||
| ): | ||
| """Validate dependencies declared by configured rails.""" | ||
| rails_config = RailsConfig.from_path(str(config)) | ||
| catalog = default_rail_catalog() | ||
| manifests = configured_rail_manifests(rails_config, catalog) | ||
| report = validate_rail_requirements(manifests, runtime=runtime) | ||
| if not report.results: | ||
| typer.echo("No catalog rails are configured.") | ||
| for result in report.results: | ||
| typer.echo(f"{result.rail_name}:") | ||
| if not result.checks: | ||
| typer.echo(" [OK] no declared requirements") | ||
| for check in result.checks: | ||
| label = { | ||
| RequirementStatus.OK: "OK", | ||
| RequirementStatus.WARNING: "WARNING", | ||
| RequirementStatus.ERROR: "ERROR", | ||
| RequirementStatus.INFO: "INFO", | ||
| }[check.status] | ||
| typer.echo(f" [{label}] {check.kind}: {check.name} ({check.message})") | ||
| if report.required_packages_to_install: | ||
| packages = " ".join(shlex.quote(package) for package in report.required_packages_to_install) | ||
| typer.echo(f"Install required packages with: pip install {packages}") | ||
| if report.optional_packages_to_install: | ||
| packages = " ".join(shlex.quote(package) for package in report.optional_packages_to_install) | ||
| typer.echo(f"Install optional packages to enable additional functionality with: pip install {packages}") | ||
| if not report.valid: | ||
| raise typer.Exit(1) |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use the canonical package name.
Replace “NeMo Guardrails extras” with wording that refers to “the NVIDIA NeMo Guardrails library,” for example: “Rail-specific Python packages are not included in extras for the NVIDIA NeMo Guardrails library.”
As per coding guidelines, “Refer to this package as ‘the NVIDIA NeMo Guardrails library’.”
🤖 Prompt for AI Agents
Source: Coding guidelines