Skip to content

West Midlands | 26 March SDC | Iswat Bello | Sprint 4 | implement shell tools in python#505

Open
Iswanna wants to merge 8 commits into
CodeYourFuture:mainfrom
Iswanna:tools/sprint4/implement-shell-tools-in-python
Open

West Midlands | 26 March SDC | Iswat Bello | Sprint 4 | implement shell tools in python#505
Iswanna wants to merge 8 commits into
CodeYourFuture:mainfrom
Iswanna:tools/sprint4/implement-shell-tools-in-python

Conversation

@Iswanna
Copy link
Copy Markdown

@Iswanna Iswanna commented Apr 19, 2026

Learners, PR Template

Self checklist

  • I have titled my PR with Region | Cohort | FirstName LastName | Sprint | Assignment Title
  • My changes meet the requirements of the task
  • I have tested my changes
  • My changes follow the style guide

Changelist

In this PR, I implemented three core Unix shell utilities in Python: cat, ls, and wc.

cat/cat.py

  • Python implementation of file concatenation utility
  • -n/--number flag: number all output lines
  • -b/--number-nonblank flag: number only non-empty lines
  • Support single and multiple file arguments
  • Read files with UTF-8 encoding
  • Proper error handling with exit codes

ls/ls.py

  • Python implementation of directory listing
  • -1/--one-per-line flag: list one file per line
  • -a/--all flag: show hidden files (dotfiles)
  • Colour directories in blue using ANSI escape codes
  • Sort entries case-insensitively
  • Support custom directory path (default to current directory)
  • Proper error handling

wc/wc.py

  • Python implementation of word count utility
  • -l/--lines flag: print line counts
  • -w/--words flag: print word counts
  • -c/--bytes flag: print byte counts
  • Read from stdin when no files provided
  • Support multiple files with totals row
  • Byte counts calculated from raw file bytes for accuracy
  • Right-justified column formatting (4-char width)
  • Proper file not found error handling

Iswanna added 3 commits April 11, 2026 16:12
@Iswanna
Update .gitignore to exclude Python and Java files
c54ba92 
- Add .venv to ignore Python virtual environments
- Add *.class to ignore Java compiled class files
@Iswanna
feat(ls): add Python implementation with color support for directories
9963708 
- Implement ls/ls.py: Python version of ls utility
- Add -1/--one-per-line flag for single column output
- Add -a/--all flag to show hidden files (dotfiles)
- Color directories in blue using ANSI escape codes
- Sort entries case-insensitively for better readability
- Support custom directory path argument (default to current directory)
- Add error handling with proper exit codes
- Match behavior of JavaScript implementation
@Iswanna
feat(wc): add Python implementation with full flag support
29a7dde 
- Implement wc/wc.py: Python version of wc utility
- Support -l/--lines, -w/--words, -c/--bytes flags
- Read from stdin when no files provided
- Process multiple files with totals row
- Calculate byte counts using raw file bytes for accuracy
- Format output with right-justified columns (4-char width)
- Handle file not found errors with proper exit codes
- Match behavior of JavaScript implementation
- Add argparse for robust CLI argument parsing
@Iswanna Iswanna added 📅 Sprint 4 Assigned during Sprint 4 of this module Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. Module-Tools The name of the module. labels Apr 19, 2026
@behnamkvl behnamkvl added Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. and removed Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. labels May 12, 2026
behnamkvl
behnamkvl reviewed May 12, 2026
View reviewed changes
Comment thread implement-shell-tools/cat/cat.py
Copy link
Copy Markdown

@behnamkvl behnamkvl May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. "\n".join(output) omits the final newline, it is different from the behavour of the real cat. Please look at the screenshot.
Image
  1. line.strip() == "" is too agressive, it treats lines containing only space or tabs as blank, whil the real cat -b only skips truly empty lines.

Copy link
Copy Markdown
Author

@Iswanna Iswanna May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the review. I have made changes to the code.

Copy link
Copy Markdown

@behnamkvl behnamkvl May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, the implementation looks good now.

behnamkvl
behnamkvl reviewed May 12, 2026
View reviewed changes
Comment thread implement-shell-tools/ls/ls.py
Copy link
Copy Markdown

@behnamkvl behnamkvl May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation looks good to me.

Copy link
Copy Markdown
Author

@Iswanna Iswanna May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

behnamkvl
behnamkvl reviewed May 12, 2026
View reviewed changes
Comment thread implement-shell-tools/wc/wc.py
Copy link
Copy Markdown

@behnamkvl behnamkvl May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: The print_formatted_report takes args as a parameter just to read flag states, this implementation couples this funciton to the CLI layer. The cleaner design is to resolve which columns to show in main() and pass a simple set or list of flags down.

Copy link
Copy Markdown
Author

@Iswanna Iswanna May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback. I have implemented your suggestion.

Copy link
Copy Markdown

@behnamkvl behnamkvl May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the implementation looks good to me.

@behnamkvl behnamkvl added Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. and removed Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. labels May 14, 2026
Iswanna added 4 commits May 14, 2026 13:46
@Iswanna
feat(cat): refactor Python implementation for streaming and correctness
454bfc8 
- Replace read-all-then-process with line-by-line streaming
- Fix -b flag: only skip truly empty lines (not whitespace-only lines)
- Fix line numbering: use tabs after number to match real cat format
- Maintain line number across multiple files for -n and -b flags
- Improve error handling with file-specific error messages
@Iswanna
Merge branch 'tools/sprint4/implement-shell-tools-in-python' of https…
c19c165 
…://github.com/Iswanna/Module-Tools into tools/sprint4/implement-shell-tools-in-python
@Iswanna
refactor(wc): simplify flag handling and improve code clarity
e7ffcfe 
- Replace should_show_all_stats boolean with active_flags list
- Simplify print_formatted_report to accept flag list instead of args object
- Increase column width from 4 to 8 for better alignment with standard wc
- Remove unused os import
- Simplify comments for clarity
- Refactor flag resolution into straightforward list building
- Improve readability of argument parser definitions
@Iswanna
fix(wc): adjust column width from 8 to 4 characters for standard alig…
7c3b76b 
…nment

- Change rjust(8) to rjust(4) in print_formatted_report
- Matches real wc utility column formatting more closely
- Reduces excessive whitespace in output
- Update comment to reflect correct width value
@Iswanna Iswanna added Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. and removed Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. labels May 14, 2026
@Iswanna Iswanna requested a review from behnamkvl May 14, 2026 13:16
@behnamkvl behnamkvl added Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. and removed Needs Review Trainee to add when requesting review. PRs without this label will not be reviewed. labels May 14, 2026
behnamkvl
behnamkvl approved these changes May 14, 2026
View reviewed changes
Copy link
Copy Markdown

@behnamkvl behnamkvl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The imlementation looks good, please proceed to close the PR.

Comment thread implement-shell-tools/wc/wc.py
Copy link
Copy Markdown

@behnamkvl behnamkvl May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the implementation looks good to me.

@behnamkvl behnamkvl added Complete Volunteer to add when work is complete and all review comments have been addressed. and removed Review in progress This review is currently being reviewed. This label will be replaced by "Reviewed" soon. labels May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@behnamkvl behnamkvl behnamkvl approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

Complete Volunteer to add when work is complete and all review comments have been addressed. Module-Tools The name of the module. 📅 Sprint 4 Assigned during Sprint 4 of this module

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Iswanna @behnamkvl