docs: clarify sandbox limits and sync v1.6 docs - #218
Merged
Conversation
Closes #213: executor.py module/main() docstrings now state explicitly there is no OS-sandbox and no FS/network isolation, clarify that "isolated" means subprocess/namespace only, and direct users to run trusted solutions only — consistent with README.md and web.py. Closes #215: drop #190 (closed) from open follow-ups in docs/README.md and docs/claude-handoff.md while keeping #191 open; mark README `--watch` as an optional feature requiring the `[watch]` extra (watchfiles); merge the duplicate `### Added` sections under CHANGELOG 1.6.0 into one Added + one Changed and add a note disambiguating historical `[unreleased]` snapshots. Completes #140 acceptance: document Windows limitations of the future SandboxRunner/LocalRunner in docs/server-mode.md (POSIX-only primitives). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
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.
Summary
Documentation/docstring-only changes. No runtime behavior changes.
src/stepik_grader/core/executor.pymodule andmain()docstrings now explicitly state there is no OS-sandbox and no FS/network isolation, clarify that "isolated"/"изолированный" refers only to a separate subprocess and clean namespace (not OS-level isolation), and instruct users to run trusted solutions only. Wording aligned withREADME.mdandweb.py.docs/README.mdanddocs/claude-handoff.md: fix(glossary): validate MissingEntry kind/status on load #190 (closed) is no longer described as an open follow-up; fix(glossary): reduce false positives in exception-name detector #191 stays marked as the current open task.README.md:--watchmarked as an optional feature requiring the[watch]extra (watchfiles).CHANGELOG.md: merged the two adjacent### Addedblocks under1.6.0into a single### Added+### Changed; added a note clarifying that deeper[unreleased]entries are historical pre-release snapshots.docs/server-mode.md: documented Windows limitations of the futureSandboxRunner/LocalRunner(POSIX-only namespaces/seccomp/resource/SIGALRM; Windows needs an external container/VM/WSL backend).Part A audit (close-ready for main agent, covered by PR #216)
docs/result-contract.mdcovers case-result fields table, verdict semantics + consistency invariant, and serialization examples (delegated todocs/web-mvp.mdResultViewModel anddocs/server-mode.mdAPI JSON).docs/logging.mdcovers flag/env activation, log-file location, and secret-redaction rules.docs/server-mode.mdcovers endpoint contract, async request/response model, and error classes.docs/server-mode.mdcovers network-off, per-run temp dirs, quotas/rate limits, and residual risks.Testing
pytest tests/ -x -q --tb=short→ 793 passedruff check .→ All checks passedruff format --check .→ 80 files already formattedmypy src/stepik_grader --ignore-missing-imports→ Success, no issuespython scripts/check_docs_guardrails.py→ OK (320 local links resolve, README within budget)python scripts/check_version_consistency.py→ OK🤖 Generated with Claude Code