Professional iran system v1 1 0 10619367560126165419

[tahatehran]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @tahatehran, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request represents a significant architectural overhaul and professionalization of the iran-encoding library. It transitions from relying on external dependencies for text shaping and bidirectional handling to a self-contained, high-performance core. By directly porting the original C logic into both a pure Python implementation and an optional C extension, the library achieves greater stability, speed, and control over character encoding. The update also introduces sophisticated locale-aware processing, comprehensive testing, and user-friendly documentation, making it a robust solution for Iran System character encoding.

Highlights

• Core Logic Refactoring: The library's core encoding and decoding logic has been completely rewritten, removing external dependencies like arabic_reshaper and python-bidi. It now features a pure Python implementation directly ported from the original C code.
• C Extension for Performance: An optional C extension has been integrated to provide maximum performance for encoding and decoding operations. A new build_c_extension.py script automates the compilation process across different platforms.
• Intelligent Locale Detection and Number Handling: The library now includes intelligent locale detection, automatically identifying Persian ('fa') or English ('en') contexts. This enables smart number handling, converting numbers to Iran System format in Persian text and normalizing Persian digits to ASCII in English text.
• Comprehensive Documentation and Testing: Extensive new documentation has been added in both English and Farsi, covering usage guides, technical details, and troubleshooting. The test suite has been significantly expanded and improved for thorough coverage and reliability.
• Project Modernization: The .gitignore and setup.py files have been modernized, cleaning up ignore patterns and updating project metadata, dependencies, and classifiers for better maintainability and distribution.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Ignored Files

• Ignored by pattern: .github/workflows/** (5)
  • .github/workflows/ci.yml
  • .github/workflows/publish-to-pypi.yml
  • .github/workflows/python-package-conda.yml
  • .github/workflows/python-publish.yml
  • .github/workflows/qodana-ci.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This is a massive and impressive refactoring that significantly improves the library. The removal of external dependencies, introduction of a pure Python core ported from C, addition of an optional C extension, and the vastly improved API, tests, and documentation are all excellent changes. However, I've identified a critical security vulnerability and a high-severity data loss bug in the C implementation that must be addressed. I've also noted a minor issue with an orphaned CLI argument and an opportunity to strengthen one of the new test cases.

I am having trouble creating individual review comments. Click here to see my feedback.

iran_encoding/iran_system.c (299-308)

There is a critical buffer overflow vulnerability here. The finalReverse buffer has a fixed size of 2048 bytes, but the loop iterates len times without checking if len is greater than or equal to 2048. This can lead to a crash or arbitrary code execution if a long string is passed. To fix this, you should use dynamic memory allocation (malloc/free) or pass the buffer and its size as parameters to ensure memory safety.

iran_encoding/iran_system.c (161-164)

These fixed-size buffers of 2048 bytes introduce a risk of data loss. The check on line 164 (if (len >= 2048) len = 2047;) prevents a buffer overflow but does so by silently truncating user data. For a library function, this can lead to subtle and hard-to-debug issues. It would be better to either handle arbitrarily long strings (e.g., using dynamic memory allocation) or return an error if the input string is too long, as silent data corruption is dangerous.

iran_encoding/cli.py (44-45)

While the usage of the --config argument is correctly removed here, its definition in the ArgumentParser setup (line 18 of the file) is now orphaned. To complete the removal of this deprecated feature, the argument definition should also be deleted from the CLI parser.

tests/test_iran_system_v1.py (40-61)

This test's assertion on line 61 is too weak to be meaningful; it only checks the type of the output. To properly test the visual ordering, you should assert that the output matches the exact expected byte sequence.

        text = "سلام"
        encoded = encode(text, visual_ordering=True)
        # The expected visual order for "سلام" is 'م' 'ا' 'ل' 'س'
        expected_bytes = bytes([0xF4, 0x91, 0xF3, 0xA8])
        self.assertEqual(encoded, expected_bytes)

        decoded = decode(encoded)
        self.assertEqual(decoded, text)