Uh oh!
There was an error while loading. Please reload this page.
Add CLI script for resume text/link extraction - #185
Conversation
📝 WalkthroughWalkthroughAdds a new CLI utility Changes
Sequence DiagramsequenceDiagram
participant User as User
participant CLI as CLI Parser
participant Processor as File Processor
participant DocExt as extract_document_text
participant LinkExt as ResumeProfileExtractor
participant Formatter as Output Formatter
User->>CLI: Run script with files & options
CLI->>CLI: Parse args (--text-max, --json, files)
CLI->>Processor: Process each file path
loop per file
Processor->>DocExt: extract_document_text(file)
DocExt-->>Processor: extracted text
Processor->>LinkExt: _extract_website_link_candidates(text)
LinkExt-->>Processor: link candidates + scores
Processor-->>CLI: FileResult(path, text_len, text, links)
end
CLI->>Formatter: Choose pretty or JSON output
Formatter-->>User: Display formatted results
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds a developer-facing CLI utility to quickly run the shared resume document text extractor and surface URL candidates produced by the current resume link-extraction heuristics.
Changes:
- Introduces
scripts/resume_text_link_test.pyCLI to extract text from one or more resume files. - Prints extracted website link candidates (with confidence scores) in either pretty text or JSON.
- Adds optional extracted-text truncation control via
--text-max.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| except Exception as exc: # pragma: no cover - runtime diagnostic path | ||
| print(f"error: failed to process {path}: {exc}") | ||
| exit_code = 1 |
There was a problem hiding this comment.
This error message is printed to stdout; when running with --json it will break JSON parsing. Please write errors to stderr (e.g., print(..., file=sys.stderr)) so the JSON output on stdout remains clean.
| if not path.is_file(): | ||
| print(f"error: missing file: {path}") | ||
| exit_code = 1 | ||
| continue |
There was a problem hiding this comment.
In --json mode this print() writes error text to stdout, which will corrupt the JSON output and make it non-machine-readable. Please send error messages to stderr (or use logging configured to stderr) so stdout remains valid JSON when --json is set.
There was a problem hiding this comment.
🧹 Nitpick comments (2)
scripts/resume_text_link_test.py (2)
107-117: Print errors to stderr instead of stdout.Error messages (lines 110, 116) are printed to stdout, which can contaminate the JSON output when piped. For CLI tools, errors should go to stderr.
♻️ Proposed fix
+import sys+ ... for file_arg in args.files: path = Path(file_arg) if not path.is_file(): - print(f"error: missing file: {path}")+ print(f"error: missing file: {path}", file=sys.stderr) exit_code = 1 continue try: results.append(_process_file(path)) except Exception as exc: # pragma: no cover - runtime diagnostic path - print(f"error: failed to process {path}: {exc}")+ print(f"error: failed to process {path}: {exc}", file=sys.stderr) exit_code = 1🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/resume_text_link_test.py` around lines 107 - 117, The error prints in the loop over args.files (using path.is_file checks and the exception handler around _process_file(path)) write to stdout and should be written to stderr; change the two print calls that report missing file and failed processing to write to stderr (e.g., print(..., file=sys.stderr) or sys.stderr.write) and ensure sys is imported at the top of the script so stderr is available.
58-67: Coupling to internal API.
_extract_website_link_candidatesis prefixed with an underscore, indicating it's an internal/private method. While it works (it's a staticmethod), this couples the script to implementation details that may change without notice.For a diagnostic script this is likely acceptable, but consider whether a public wrapper or exposing this as part of the public API would be more maintainable long-term.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/resume_text_link_test.py` around lines 58 - 67, The test helper _process_file is calling the private static method ResumeProfileExtractor._extract_website_link_candidates which couples the script to an internal API; change the code to call a public API instead (either use an existing public method that returns website links or add a new public static method on ResumeProfileExtractor such as extract_website_link_candidates that delegates to the current private impl), then update _process_file to call ResumeProfileExtractor.extract_website_link_candidates(text) (or the appropriate public method) so the script relies only on the public surface rather than the underscored internal method.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@scripts/resume_text_link_test.py`:
- Around line 107-117: The error prints in the loop over args.files (using
path.is_file checks and the exception handler around _process_file(path)) write
to stdout and should be written to stderr; change the two print calls that
report missing file and failed processing to write to stderr (e.g., print(...,
file=sys.stderr) or sys.stderr.write) and ensure sys is imported at the top of
the script so stderr is available.
- Around line 58-67: The test helper _process_file is calling the private static
method ResumeProfileExtractor._extract_website_link_candidates which couples the
script to an internal API; change the code to call a public API instead (either
use an existing public method that returns website links or add a new public
static method on ResumeProfileExtractor such as extract_website_link_candidates
that delegates to the current private impl), then update _process_file to call
ResumeProfileExtractor.extract_website_link_candidates(text) (or the appropriate
public method) so the script relies only on the public surface rather than the
underscored internal method.
There was a problem hiding this comment.
🧹 Nitpick comments (2)
scripts/resume_text_extractor.py (2)
58-67: Relying on a private method_extract_website_link_candidates.The underscore prefix indicates this is an internal implementation detail of
ResumeProfileExtractor. Private methods may change or be removed without notice, which could break this script silently.Consider exposing a public API for this functionality if it's intended for external use, or document the coupling risk if this is acceptable for an internal diagnostic tool.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/resume_text_extractor.py` around lines 58 - 67, The code in _process_file currently calls the private ResumeProfileExtractor._extract_website_link_candidates which is an unstable internal API; change this by either invoking a documented public method on ResumeProfileExtractor (e.g., a new extract_website_links or existing public extractor method) or implement the link extraction locally in this module and remove the private call. Update _process_file to call the chosen public function or local helper and add a short comment about the coupling decision if you must rely on an internal method.
107-117: Send error messages to stderr.Error messages are printed to stdout, which mixes them with normal output. In
--jsonmode, this would produce invalid JSON if any file fails. CLI tools should emit errors to stderr to keep stdout clean for actual output.♻️ Proposed fix
+import sys+ ... for file_arg in args.files: path = Path(file_arg) if not path.is_file(): - print(f"error: missing file: {path}")+ print(f"error: missing file: {path}", file=sys.stderr) exit_code = 1 continue try: results.append(_process_file(path)) except Exception as exc: # pragma: no cover - runtime diagnostic path - print(f"error: failed to process {path}: {exc}")+ print(f"error: failed to process {path}: {exc}", file=sys.stderr) exit_code = 1🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/resume_text_extractor.py` around lines 107 - 117, The loop that validates and processes args.files prints error messages to stdout (using print) which can corrupt --json output; update the error prints in that loop (the checks around Path(file_arg).is_file() and the except Exception handling that wraps _process_file(path)) to write to stderr instead (e.g., use print(..., file=sys.stderr) or an equivalent stderr logger) and ensure sys is imported at top if not already; keep exit_code handling the same.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@scripts/resume_text_extractor.py`:
- Around line 58-67: The code in _process_file currently calls the private
ResumeProfileExtractor._extract_website_link_candidates which is an unstable
internal API; change this by either invoking a documented public method on
ResumeProfileExtractor (e.g., a new extract_website_links or existing public
extractor method) or implement the link extraction locally in this module and
remove the private call. Update _process_file to call the chosen public function
or local helper and add a short comment about the coupling decision if you must
rely on an internal method.
- Around line 107-117: The loop that validates and processes args.files prints
error messages to stdout (using print) which can corrupt --json output; update
the error prints in that loop (the checks around Path(file_arg).is_file() and
the except Exception handling that wraps _process_file(path)) to write to stderr
instead (e.g., use print(..., file=sys.stderr) or an equivalent stderr logger)
and ensure sys is imported at top if not already; keep exit_code handling the
same.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #!/usr/bin/env python3 | ||
| """Command-line helper to exercise resume text and link extraction.""" |
There was a problem hiding this comment.
PR description says it adds scripts/resume_text_link_test.py, but the actual added file is scripts/resume_text_extractor.py. Please update the PR description (or rename the script) so the documentation matches what was merged.
| def _process_file(path: Path) -> FileResult: | ||
| raw = path.read_bytes() | ||
| text = extract_document_text(raw, filename=path.name) | ||
| link_candidates = ResumeProfileExtractor._extract_website_link_candidates(text) |
There was a problem hiding this comment.
This script calls ResumeProfileExtractor._extract_website_link_candidates, which is a private (underscore-prefixed) API and could change without notice. Consider exposing a small public helper (e.g., a non-underscored function/method that returns the normalized links + confidence) and have the CLI use that instead.
| def_process_file(path: Path) ->FileResult: | |
| raw=path.read_bytes() | |
| text=extract_document_text(raw, filename=path.name) | |
| link_candidates=ResumeProfileExtractor._extract_website_link_candidates(text) | |
| defextract_website_link_candidates(text: str) ->list[tuple[str, float]]: | |
| """Public helper to extract normalized website links and confidence scores.""" | |
| returnResumeProfileExtractor._extract_website_link_candidates(text) | |
| def_process_file(path: Path) ->FileResult: | |
| raw=path.read_bytes() | |
| text=extract_document_text(raw, filename=path.name) | |
| link_candidates=extract_website_link_candidates(text) |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
scripts/resume_text_extractor.py (1)
59-61: Consider coordinating with library maintainers to expose a public API.This wrapper calls
ResumeProfileExtractor._extract_website_link_candidates, which is marked as private (leading underscore). While the wrapper itself provides a clean public interface for CLI usage, relying on private methods creates fragile coupling—the internal method's signature or behavior may change without notice.If this extraction logic is intended for CLI/external use, consider requesting that the library expose a public method (e.g.,
extract_website_link_candidates) that this script can call instead.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@scripts/resume_text_extractor.py` around lines 59 - 61, The wrapper extract_website_link_candidates currently calls the private ResumeProfileExtractor._extract_website_link_candidates which creates fragile coupling; change this to use a public API instead: coordinate with the library maintainers to expose a public method (e.g., ResumeProfileExtractor.extract_website_link_candidates) and update this script to call that public method, or implement a local fallback extraction routine in this script if the public API is not yet available, and file/mention an upstream request to add the public function so the CLI no longer depends on the leading-underscore private method.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@scripts/resume_text_extractor.py`:
- Around line 59-61: The wrapper extract_website_link_candidates currently calls
the private ResumeProfileExtractor._extract_website_link_candidates which
creates fragile coupling; change this to use a public API instead: coordinate
with the library maintainers to expose a public method (e.g.,
ResumeProfileExtractor.extract_website_link_candidates) and update this script
to call that public method, or implement a local fallback extraction routine in
this script if the public API is not yet available, and file/mention an upstream
request to add the public function so the CLI no longer depends on the
leading-underscore private method.
Uh oh!
There was an error while loading. Please reload this page.
Description
Added scripts/resume_text_extractor.py: a command-line utility that reads resume files, extracts text via shared helpers, and prints candidate links.
The script uses a public helper wrapper in the CLI module for normalized link extraction with confidence scores to avoid calling private resume extractor internals directly.
The tool supports JSON and plain text output, optional full-text or truncated output, and multiple input files per run.
Related Issue
None.
How Has This Been Tested?
Reviewed the diff against origin/main and verified the script formatting and checks pass during commit-time validation.
Summary by CodeRabbit