Title: Muqeet Shaikh — R23-T016: Refactor ciphers/xor_cipher.py (268 lines) · Issue #20 · S-AI-Projects/TheAlgorithms-Python · GitHub
Open Graph Title: Muqeet Shaikh — R23-T016: Refactor ciphers/xor_cipher.py (268 lines) · Issue #20 · S-AI-Projects/TheAlgorithms-Python
X Title: Muqeet Shaikh — R23-T016: Refactor ciphers/xor_cipher.py (268 lines) · Issue #20 · S-AI-Projects/TheAlgorithms-Python
Description: Student: Muqeet Shaikh Task: R23-T016 · 6 of 10 Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python Assigned working branch: student/e26b07f0731 Goal Improve the structure of a large file without changing behaviour, using t...
Open Graph Description: Student: Muqeet Shaikh Task: R23-T016 · 6 of 10 Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python Assigned working branch: student/e26b07f0731 Goal Improve the structure of a large ...
X Description: Student: Muqeet Shaikh Task: R23-T016 · 6 of 10 Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python Assigned working branch: student/e26b07f0731 Goal Improve the structure of a large ...
Opengraph URL: https://github.com/S-AI-Projects/TheAlgorithms-Python/issues/20
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Muqeet Shaikh — R23-T016: Refactor ciphers/xor_cipher.py (268 lines)","articleBody":"\u003c!-- sai-task-v1:R23-T016 -->\n\n## Student: Muqeet Shaikh\n\n**Task:** R23-T016 · 6 of 10\n**Repository:** https://github.com/S-AI-Projects/TheAlgorithms-Python\n**Assigned working branch:** `student/e26b07f0731`\n\n## Goal\n\nImprove the structure of a large file without changing behaviour, using tests as a safety net. The XORCipher class repeats similar logic across string and file methods – extract shared helpers.\n\n## Steps\n\n1. Run the tests and coverage first and save the baseline.\n2. Identify duplicated or overly long code (Ruff's C90 complexity check: `uvx ruff check --select C90 ciphers/xor_cipher.py`).\n3. Refactor in small commits (extract helpers, clearer names), running the tests after each commit.\n4. Write REFACTOR.md: before/after complexity numbers and what you changed.\n5. Make the code change in the repository: ciphers/xor_cipher.py: shared helpers extracted from the duplicated string/file encryption logic; all doctests unchanged and passing. Re-run the automated check and the repo's own tests afterwards.\n6. Prepare the PR: on branch R23-T016, commit the code change plus your work/R23-T016/ evidence, put your findings in the PR description and open the PR against the org fork. For a later upstream PR, create a second branch containing only the code change (no work/ folder).\n\n## Done when\n\n☐ ciphers/xor_cipher.py: the duplicated logic between encrypt/decrypt/encrypt_string/decrypt_string (and the file methods) is moved into shared helper(s).\n☐ REFACTOR.md shows the C90 complexity of the worst method before and after (from `ruff check --select C90`).\n☐ All 16 existing doctests pass after every commit (commit history shows tests run); public method names and signatures are unchanged.\n\n\u003cdetails>\n\u003csummary>Additional task guidance\u003c/summary>\n\n\nAdditional curated task guidance\n\nItem:\n`ciphers/xor_cipher.py` (268 lines; 16 doctests)\n\nTask type:\nRefactor for readability\n\nCode change (goes into the PR):\nciphers/xor_cipher.py: shared helpers extracted from the duplicated string/file encryption logic; all doctests unchanged and passing.\n\nAutomated check:\nuvx ruff check ciphers/xor_cipher.py && uv run pytest ciphers/xor_cipher.py\n\nPrerequisites:\nLinux/WSL2/Codespaces with uv (https://docs.astral.sh/uv/getting-started/installation/); run `uv sync --group=test` once – it installs the Python version CI uses (.python-version = 3.15t) and the test dependencies, about 1–2 GB\n\nUpstream PR rules:\nFollow CONTRIBUTING.md: type hints on every parameter/return, doctests for valid and erroneous input, snake_case file names, no duplicate of an existing implementation, no hand edits to DIRECTORY.md. CI (pytest with doctests, ruff) must pass – bots close PRs without tests or type hints. Keep work/ (benchmarks, notes, property tests) out of the upstream branch; put results in the PR description.\n\nSource (pinned):\nhttps://github.com/TheAlgorithms/Python/blob/574d100b7181956e9c8384552fd078165e4cc326/ciphers/xor_cipher.py\n\nChange:\nNo change recorded\n\nPR destination:\nPreserved pilot guidance\n\n\n\u003c/details>\n\n## Submission checklist\n\n- [ ] Complete this task and its checks.\n- [ ] Add the required evidence and link your pull request here.\n- [ ] Select this **S-AI-Projects fork** as the PR base repository.\n- [ ] Request instructor review.\n\nKeep this PR focused on this task. Do not submit assignment PRs to the upstream repository.","author":{"url":"https://github.com/ankushbisht01","@type":"Person","name":"ankushbisht01"},"datePublished":"2026-11-03T18:40:26Z","url":"https://github.com/S-AI-Projects/TheAlgorithms-Python/issues/20"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:bf8dcae8-2154-efba-6dcf-04a458096f57 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E06A:1AFD68:16C6B1:20C560:6AFDCF6D |
| html-safe-nonce | 95877f682e3282e4dcd7ad38fbedd6b317255edd85fbc3e6b35fd55734868005 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMDZBOjFBRkQ2ODoxNkM2QjE6MjBDNTYwOjZBRkRDRjZEIiwidmlzaXRvcl9pZCI6IjcyOTA1NjY3ODE4NDI2MDc5ODEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | bfc77a9774acb91bac97394674a35a4d6b60acfc87e1ce09ba9cfea9890a8613 |
| hovercard-subject-tag | issue:6188931545 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/S-AI-Projects/TheAlgorithms-Python/20/issue_layout |
| twitter:image | https://opengraph.githubassets.com/22a449f5d851835288154084723d8404648b8369c9d585dcd6425e1374552386/S-AI-Projects/TheAlgorithms-Python/issues/20 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/22a449f5d851835288154084723d8404648b8369c9d585dcd6425e1374552386/S-AI-Projects/TheAlgorithms-Python/issues/20 |
| og:image:alt | Student: Muqeet Shaikh Task: R23-T016 · 6 of 10 Repository: https://github.com/S-AI-Projects/TheAlgorithms-Python Assigned working branch: student/e26b07f0731 Goal Improve the structure of a large ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | ankushbisht01 |
| hostname | github.com |
| expected-hostname | github.com |
| None | 26886a40b582b821a7a76351e0a2f42b6d6160854b6e2520db24f31fd7be5da7 |
| turbo-cache-control | no-preview |
| go-import | github.com/S-AI-Projects/TheAlgorithms-Python git https://github.com/S-AI-Projects/TheAlgorithms-Python.git |
| octolytics-dimension-user_id | 351892385 |
| octolytics-dimension-user_login | S-AI-Projects |
| octolytics-dimension-repository_id | 1444141022 |
| octolytics-dimension-repository_nwo | S-AI-Projects/TheAlgorithms-Python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | true |
| octolytics-dimension-repository_parent_id | 63476337 |
| octolytics-dimension-repository_parent_nwo | TheAlgorithms/Python |
| octolytics-dimension-repository_network_root_id | 63476337 |
| octolytics-dimension-repository_network_root_nwo | TheAlgorithms/Python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 68ebaa631a1d248d69ebde4b9c5defd3a19aeb2f |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width