├── .gitignore ├── AUTHORS ├── Changelog.txt ├── LICENSE ├── MANIFEST.in ├── Makefile ├── README.md ├── negar ├── __init__.py ├── constants.py ├── data │ └── immutable.words ├── gui.py └── virastar.py ├── setup.py └── tests ├── input_file ├── output └── test_unittest.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[co] 2 | 3 | # Packages 4 | *.egg 5 | *.egg-info 6 | dist 7 | build 8 | eggs 9 | parts 10 | bin 11 | var 12 | sdist 13 | develop-eggs 14 | .installed.cfg 15 | *.spec 16 | 17 | # Installer logs 18 | pip-log.txt 19 | 20 | # Unit test / coverage reports 21 | .coverage 22 | .tox 23 | 24 | #Translations 25 | *.mo 26 | 27 | #Mr Developer 28 | .mr.developer.cfg 29 | 30 | # IDE 31 | .idea/ 32 | .pydev/ 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Shahin Azad 2 | Alireza Savand 3 | Javad Razavian -------------------------------------------------------------------------------- /Changelog.txt: -------------------------------------------------------------------------------- 1 | 1.4.3 - 2025-01-28 2 | -- Save user defined immutable words under .config/python-negar 3 | 4 | 1.4.2 - 2025-01-23 5 | -- Fixed issue with همان‌طور، نشان‌دهنده 6 | 7 | 1.4.1 - 2025-01-06 8 | -- Fixed issue with immutability check. 9 | -- Added several additional immutable words. 10 | 11 | 1.4 - 2025-01-05 12 | -- Added a new feature to ignore text after #> as a comment trigger. 13 | 14 | 1.3 - 2025-01-01 15 | -- Enhanced the handling of immutable words to achieve greater accuracy in results. 16 | 17 | 1.2.15 - 2024-12-31 18 | -- Fixed issue #24 and added several new immutable words. 19 | 20 | 1.2.14 - 2024-12-30 21 | -- Fixed issue with prefix spacing in cases like "mi + space + ZWNJ + ". 22 | 23 | 1.2.13 - 2024-12-26 24 | -- Fixed issue with quotes after a dot where no space was allowed in between. 25 | 26 | 1.2.12 - 2024-12-23 27 | -- Fix critical issue with naming `immutable.words` 28 | 29 | 1.2.11 - 2024-12-23 30 | -- Typo Fix 31 | -- Renamed `untouchable.dat` to `immutable.words` 32 | 33 | 1.2.9 - 2024-05-07 34 | -- Fix subtle issue with immutable words which stick to non-literal symbols like Parentheses 35 | -- new test for immutable words 36 | 37 | 1.2.8 - 2023-09-21 38 | -- Fix subtle issue with triple dots at the end of sentence followed by another [?!.] 39 | 40 | 1.2.7 - 2023-08-07 41 | -- Remove dot from saving directory under Windows OS. 42 | 43 | 1.2.6 - 2023-08-07 44 | -- Better location for saving user defined immutable data under Windows OS. 45 | 46 | 1.2.5 - 2023-07-14 47 | -- Fix issues with texts that include backslashes as part of their context, such as LaTeX source code. 48 | 49 | 1.2.4 - 2023-06-15 50 | -- Fix the issue with multiple ! and ? and extra space after parentheses at the end of line 51 | 52 | 1.2.2 - 2023-06-13 53 | -- Fix the issue with the triple dots that was caused by the previous update 54 | 55 | 1.2.1 - 2023-05-23 56 | -- Fix an issue with punctuation like '،ساختمان' 57 | 58 | 1.2 - 2023-03-28 59 | -- Fix GUI execution issue 60 | 61 | 1.1.17 - 2022-12-21 62 | -- Fix the issue with می and نمی when they come as nouns, not prefixes. 63 | -- Several new immutable words: تنهای/تنهایی/تک‌وتنهایی 64 | 65 | 1.1.16 - 2022-09-11 66 | -- Fix issues with the following بهمان ,مهاجمان 67 | 68 | 1.1.15 - 2022-09-09 69 | -- Fix issues with the following بهتری, بهترین, مهتری, مهترین, کهتری, کهترین, توییتر, همان, همانی, بیتلی, بیتلز 70 | 71 | 1.1.14 - 2022-06-27 72 | -- Puts ZWNJ between مند، ور، پور suffixes and the words 73 | 74 | 1.1.13 - 2022-05-30 75 | -- نا should stick to the next word, like ناامن 76 | 77 | 1.1.12 - 2022-05-17 78 | -- some issues with words ending in *tan 79 | 80 | 1.1.11 - 2022-05-09 81 | -- supports versioning numbers, e.g 1.1.11 82 | 83 | 1.1.10 - 2012-05-04 84 | -- enconding issues on Windows 85 | 86 | 1.1.9 - 2012-05-04 87 | -- Update in compliance with `negar-gui` ver 0.2 88 | 89 | 1.1.8 - 2012-05-03 90 | -- minor issue with immutable words 91 | -- remove `disutils` as it's deprecated now 92 | 93 | 1.1.7 - 2012-04-21 94 | -- tab* will be replaced by space 95 | -- Code sanitization 96 | 97 | 1.1.6 - 2012-04-19 98 | -- minor issue with handling urls 99 | 100 | 1.1.5 - 2022-04-15 101 | -- New option: `exaggeration_zwnj` 102 | Recent writing rule for Persian text accepts both forms for some words like کتابها and کتاب‌ها 103 | It's entirely up to the user to opt for it. Negar's default is to separate the suffixes of the words as much as possile. 104 | 105 | 1.1.4 - 2022-04-12 106 | -- GUI removed from `python-negar` and is initiated as `negar-gui`. 107 | 108 | 1.1.3 - 2022-04-10 109 | -- `PyICU` is replaced by `pyuca` as the latter is more straightforward for Windows' installation. 110 | -- logo.ico for Windows 111 | 112 | 1.1.2 - 2022-04-08 113 | -- Support for new suffix گذار/گذاری and گزار/گزاری 114 | 115 | 1.1.1 - 2022-04-08 116 | -- Fixed an issue with `^mi*haye$` with using regex module 117 | -- Support for new suffix شناس/شناسی 118 | 119 | 1.1 - 2022-04-07 120 | -- Downgraded to PyQt5 for better support in Windows. 121 | 122 | 1.0.6 - 2022-04-07 123 | -- Using `enconding='utf8'` for all `open` commands as Windows default code page is `CP1251/CP1252`. 124 | 125 | 1.0.5 - 2022-04-06 126 | -- English numbers around the minus sign will change to Persian counterparts if --fix-english-num is used. 127 | 128 | 1.0.4 - 2022-04-06 129 | -- Fixed the issue with capital letters beside the English figures, e.g. `A4`. 130 | 131 | 1.0.3 - 2022-04-05 132 | -- Spaces around the point of a floating-point number will not appear. 133 | 134 | 1.0.2 - 2022-04-05 135 | -- In compliance with negar-cli 136 | 137 | 1.0.1 - 2022-04-04 138 | -- The option trim-leading-trailing-whitespaces renamed to trim-lt-whitespaces. 139 | -- Retouching the readme. 140 | 141 | 1.0.0 - 2022-04-04 142 | -- Fixed issue with *ei/eim/eid/and. 143 | 144 | 0.9.91 - 2022-04-04 145 | -- version regex updated 146 | 147 | 0.9.9 - 2022-04-03 148 | -- re.search is replaced with re.finditer as the former just finds the first occurrence of the pattern not all of them 149 | 150 | 0.9.8 - 2022-04-03 151 | -- Fixed the issue with multiple consecutive newlines 152 | 153 | 0.9.7 - 2022-04-02 154 | -- Preserves URLs 155 | 156 | 0.9.6 - 2022-04-02 157 | -- Fixed issue #21, suffix اش 158 | -- Immutable words updated 159 | 160 | 0.9.5 - 2022-04-01 161 | -- New options for trimming leading/trailing whitespaces 162 | 163 | 0.9.4 - 2022-04-01 164 | -- Fixed issue #20, extra space between ؟ and ! 165 | 166 | 0.9.3 - 2022-03-31 167 | -- Fixed issue #19; some cases than ended with *hayeshan (کتابهایشان) 168 | 169 | 0.9.2 - 2022-03-30 170 | -- Fixed some issues with ^bi* 171 | -- Fixed the issue of extra ZWNJ beside brackets 172 | 173 | 0.9.1 - 2022-03-30 174 | -- Supports bi* 175 | 176 | 0.9.0 - 2022-03-30 177 | -- Revision of functions' names and their docstrings and comments to fix issue #14 178 | 179 | 0.8.9 - 2022-03-29 180 | -- Support of import button via QFileDialog 181 | 182 | 0.8.8 - 2022-03-29 183 | -- constants.py would encompass some constants variables like __version__ 184 | -- Immutable words update 185 | 186 | 0.8.7 - 2022-03-29 187 | -- Fixed issue #4, users just add their own words to their private file-system 188 | 189 | 0.8.6 - 2022-03-28 190 | -- Fixed issue #17 and #12 191 | 192 | 0.8.5 - 2022-03-28 193 | -- QTableView uses PyICU to sort unicode words correctly 194 | 195 | 0.8.4 - 2022-03-28 196 | -- setup.py reads version automatically from negar/gui.py 197 | 198 | 0.8.3 - 2022-03-28 199 | -- Config Tab redesign 200 | 201 | 0.8.2 - 2022-03-27 202 | -- copy button redesign 203 | -- Immutable words revision 204 | 205 | 0.8.1 - 2022-03-27 206 | -- Auto Stretch of headers in QTableView 207 | -- No header name for QTableView 208 | 209 | 0.8.0 - 2022-03-26 210 | -- Extra Class for immutable words 211 | -- Shows immutable words in config tab via QTableView 212 | -- Immutable words update 213 | -- Right alignment for data in QTableView 214 | 215 | 0.7.4 - 2022-03-25 216 | -- Fixed special case with شان like و شان خود 217 | -- Fixed issue with relative import (https://stackoverflow.com/questions/16981921) 218 | 219 | 0.7.3 - 2022-03-25 220 | -- Immutable words update 221 | -- Fixed issue with import 222 | 223 | 0.7.2 - 2022-03-24 224 | -- A new button to save the output into clipboard, 225 | and it also saves the output into the clipboard automatically when the window is has been closed. 226 | 227 | 0.7.1 - 2022-03-23 228 | -- Fixed issue with `*yeh$` 229 | 230 | 0.7.0 - 2022-03-23 231 | -- F1-key shows a description about negar abilities 232 | 233 | 0.6.9 - 2022-03-22 234 | -- Esc key to close the window 235 | 236 | 0.6.8 - 2022-03-21 237 | -- os replaced by Pathlib 238 | -- Fixed some hot-keys in `Config` tab 239 | -- fixed the issue with 'می' at the beginning of the line 240 | 241 | 0.6.7 - 2022-03-20 242 | -- auto focus on input field 243 | 244 | 0.6.6 - 2022-03-19 245 | -- Fixed issue with words that contain 'ها' in the middle or at the end, like 'مهاباد' and 'دانشکده ها' 246 | -- Immutable words list update as well as redundancy removed 247 | -- Removing unwanted extra zwmjs 248 | -- Negar logo for better desktop switching 249 | 250 | 0.6.5 - 2022-03-18 251 | -- Font Size Slider relocate to the bottom 252 | -- Fixed issue with words that contain 'می' in the middle like 'سهمیه' 253 | -- Tremendous addition of words start with 'می' into immutable words 254 | 255 | 0.6.4 - 2022-03-18 256 | -- Font Size Slider 257 | 258 | 0.6.3 - 2022-03-18 259 | -- Fixed issue with some words like سهمیه 260 | -- Immutable list update 261 | -- Fixed issue with relative import in Python3 262 | 263 | 0.6.2 - 2022-03-17 264 | -- Fixed 17: Some addition to immutable words 265 | -- Revision in compliance with Python3.10 and PyQt6 266 | -- Fixed issue with setup 267 | 268 | 0.6.1 - 2012-02-23 Negar beginning 269 | -- Cleanup on README.md 270 | -- Fixed #2: Indentation and re-styling on virastar.py. 271 | -- Fixed #10: Packaged to pypi. 272 | 273 | 0.0.0 - 0000-00-00 274 | -- Fixed #8: Removed CLI part. 275 | -- Removed negar/negar.py. 276 | -- Added installation, usage section to README.md. 277 | 278 | 0.6 - 2012-09-01 -- First official release. 279 | -- First version of GUI added. 280 | -- Word separator added. 281 | -- Some command line improvements. 282 | -- More options added to command-line version 283 | 284 | 0.2 - 2012-08-05 Initial release. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include AUTHORS 3 | include *.txt 4 | include negar/logo.png 5 | include negar/data/*.words 6 | recursive-include docs *.txt 7 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | VER=$(shell grep __version__ negar/constants.py|cut -d= -f2|tr -d '\" '|head -1) 4 | 5 | .ONESHELL: 6 | 7 | ver: 8 | @echo python-negar ver. "$(VER)" 9 | 10 | .PHONY: uninstall 11 | uninstall: 12 | @echo "Uninstalling python-negar ..." 13 | pip uninstall python-negar 14 | 15 | setup: ver 16 | python setup.py sdist 17 | python setup.py bdist_wheel 18 | 19 | lins: ver setup 20 | pip install "dist/python_negar-$(VER)-py3-none-any.whl" 21 | 22 | pins: ver 23 | pip install python-negar=="$(VER)" 24 | 25 | upypi: setup 26 | twine upload "dist/python_negar-$(VER).tar.gz" 27 | 28 | utest: setup 29 | twine upload -r testpypi "dist/python_negar-$(VER).tar.gz" 30 | 31 | upload: setup upypi utest 32 | 33 | test: 34 | python -m unittest discover tests 35 | 36 | clean: 37 | @rm python_negar.egg-info/ -rfv 38 | @rm build/ -rfv 39 | @rm dist/ -rfv 40 | @rm gui.build/ -rfv 41 | @rm gui.dist/ -rfv 42 | @rm negar*.spec -rfv 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Negar 2 | ========== 3 | [![PyPI](https://img.shields.io/pypi/v/python-negar)](https://pypi.org/project/python-negar/) 4 | [![repo size](https://img.shields.io/github/repo-size/shahinism/python-negar.svg)](https://github.com/shahinism/python-negar/archive/master.zip) 5 | [![GitHub forks](https://img.shields.io/github/forks/shahinism/python-negar)](https://github.com/shahinism/python-negar/network) 6 | [![GitHub issues](https://img.shields.io/github/issues/shahinism/python-negar)](https://github.com/shahinism/python-negar/issues) 7 | [![GitHub license](https://img.shields.io/github/license/shahinism/python-negar)](https://github.com/shahinism/python-negar/blob/main/LICENSE) 8 | [![Downloads](https://pepy.tech/badge/python-negar)](https://pepy.tech/project/python-negar) 9 | [![Downloads](https://pepy.tech/badge/python-negar/month)](https://pepy.tech/project/python-negar) 10 | 11 | Negar is an editor(=virastar in Persian) for Persian text. The project is initially inspired by [virastar](https://github.com/aziz/virastar/blob/master/lib/virastar.rb). Thank you [Aziz](https://github.com/aziz) for your great job. 12 | 13 | ## [Demo View ![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://negar-web.streamlit.app/) 14 | 15 | Installation 16 | ============== 17 | 18 | ## PyPi 19 | 20 | **python-negar** is available on [PyPi](http://pypi.python.org/pypi/python-negar): 21 | 22 | $ pip install python-negar 23 | 24 | ## Git 25 | 26 | You can get the latest stable changes from the GitHub server: 27 | 28 | $ git clone https://github.com/shahinism/python-negar.git 29 | $ cd python-negar 30 | $ python setup.py install 31 | 32 | ## Zip, Tarball 33 | 34 | You can download the latest tarball. 35 | 36 | ### *nix 37 | 38 | Get the latest tarball & install: 39 | 40 | $ wget -O python-negar-master.tar.gz https://github.com/shahinism/python-negar/archive/master.tar.gz 41 | $ tar xvzf python-negar-master.tar.gz && cd python-negar-master 42 | $ python setup.py install 43 | 44 | ### Windows 45 | 46 | Download the latest zip archive. 47 | 48 | https://github.com/shahinism/python-negar/archive/master.zip 49 | 50 | Decompress it, and run the following command in the root directory of `python-negar` 51 | 52 | $ python setup.py install 53 | 54 | #### Requirements 55 | 56 | $ pip install regex 57 | 58 | Usage 59 | ====== 60 | 61 | Calling by default options: 62 | 63 | from negar.virastar import PersianEditor 64 | 65 | test = r"""قابلیت های ویراستار ' نگار ': 66 | * جایگزینی 67 | + خط تیره های پیاپی نظیر (--) و (---) با معادل های استاندارد شان 68 | + سه نقطه ی پیاپی (...) با کاراکتر استانداردش در زبان فارسی 69 | + علایمی نظیر کوتیشن فارسی با گیومه ؛ 'نگار' 70 | + اعداد عربی '١٢٣٤٥٦٧٨٩٠' و انگلیسی '1234567890' با معادل فارسی 71 | + کاراکتر های غیر فارسی نظیر ',;%يةك' با معادل های فارسی 72 | 73 | * تنظیم فاصله 74 | + کلماتی که با 'ی' پسوند همراه هستند مانند 'همه ی ' -- و البته امکان جایگزینی آن با حمزه 'ء' ( در صورت انتخاب کاربر ) 75 | + پرانتز ها یا دیگر علایم ؛ ( نگار ) 76 | + علائم نقطه‌گذاری ؛ بدون فاصله از قبل و با یک فاصله از بعد به استثنای اعداد اعشاری مانند 12.4 77 | + در پیشوند کلمات با نیم‌فاصله نظیر ' می شود '، ' میشود '، ' بی شک '، ' بیشک ' , ' خانه اش '، ' وظیفه شناس ' ، ' کمک تان ' و یا ' نمیرود ' 78 | + در پسوند کلمات با نیم‌فاصله نظیر کتابها، خوشترین -- و البته امکان عدم تنظیم (در صورت انتخاب کاربر) 79 | 80 | * جلوگیری از 81 | + استفاده ی بیش از یک علامت ؟؟؟؟ یا !!! 82 | + کشیـــــــــدگـــــــــــــــــی در کــــــــــــلمــــات 83 | + فضا های خالی بیش از حد""" 84 | 85 | print(PersianEditor(text)) 86 | 87 | result: 88 | 89 | قابلیت‌های ویراستار «نگار»: 90 | * جایگزینی 91 | + خط تیره‌های پیاپی نظیر (–) و (—) با معادل‌های استانداردشان 92 | + سه نقطه‌ی پیاپی (…) با کاراکتر استانداردش در زبان فارسی 93 | + علایمی نظیر کوتیشن فارسی با گیومه؛ «نگار» 94 | + اعداد عربی «۱۲۳۴۵۶۷۸۹۰» و انگلیسی «۱۲۳۴۵۶۷۸۹۰» با معادل فارسی 95 | + کاراکترهای غیر فارسی نظیر «، ؛ ٪یهک» با معادل‌های فارسی 96 | 97 | * تنظیم فاصله 98 | + کلماتی که با «ی» پسوند همراه هستند مانند «همه‌ی» – و البته امکان جایگزینی آن با حمزه «ء» (در صورت انتخاب کاربر) 99 | + پرانتزها یا دیگر علایم؛ (نگار) 100 | + علائم نقطه‌گذاری؛ بدون فاصله از قبل و با یک فاصله از بعد به استثنای اعداد اعشاری مانند ۱۲.۴ 101 | + در پیشوند کلمات با نیم‌فاصله نظیر «می‌شود»، «می‌شود»، «بی‌شک»، «بی‌شک»، «خانه‌اش»، «وظیفه‌شناس»، «کمک‌تان» و یا «نمی‌رود» 102 | + در پسوند کلمات با نیم‌فاصله نظیر کتاب‌ها، خوش‌ترین – و البته امکان عدم تنظیم (در صورت انتخاب کاربر) 103 | 104 | * جلوگیری از 105 | + استفاده‌ی بیش از یک علامت؟ یا! 106 | + کشیدگی در کلمات 107 | + فضاهای خالی بیش از حد 108 | 109 | Enabling extra features/args: 110 | 111 | ## 112 | args = [] 113 | args.append('fix-english-quotes') 114 | args.append('cleanup-spacing') 115 | print(PersianEditor(text, *args)) 116 | 117 | 118 | Full list of args with description: 119 | 120 | --fix-dashes Disable fix dashes feature 121 | --fix-three-dots Disable fix three dots feature 122 | --fix-english-quotes Disable fix english quotes feature 123 | --fix-hamzeh Disable fix hamzeh feature 124 | --hamzeh-with-yeh Use 'Hamzeh' instead of 'yeh' for fix hamzeh feature 125 | --fix-spacing-bq Disable fix spacing braces and qoutes feature 126 | --fix-arabic-num Disable fix arabic num feature 127 | --fix-english-num Disable fix english num feature 128 | --fix-non-persian-chars Disable fix misc non persian chars feature 129 | --fix-p-spacing Disable fix prefix spacing feature 130 | --fix-p-separate Disable fix prefix separating feature 131 | --fix-s-spacing Disable fix suffix spacing feature 132 | --fix-s-separate Disable fix suffix separating feature 133 | --aggresive Disable aggresive feature 134 | --cleanup-kashidas Disable cleanup kashidas feature 135 | --cleanup-ex-marks Disable cleanup extra marks feature 136 | --cleanup-spacing Disable cleanup spacing feature 137 | --trim-lt-whitespaces Disable Trim leading trailing whitespaces 138 | --exaggerating_zwnj Disable suffix separation as much as possible 139 | 140 | GUI & CLI 141 | ====== 142 | There are two companions with this repository to support GUI and CLI, named `negar-gui` and `negar-cli`, respectively. 143 | 144 | Both of them are available on PyPI. 145 | 146 | * https://pypi.org/project/negar-gui/ 147 | 148 | * https://pypi.org/project/negar-cli/ 149 | 150 | 151 | ## Contributors 152 | 153 | 154 | 155 | 156 | -------------------------------------------------------------------------------- /negar/__init__.py: -------------------------------------------------------------------------------- 1 | # app data 2 | import pkgutil 3 | 4 | __path__ = pkgutil.extend_path(__path__, __name__) 5 | __path__.reverse() -------------------------------------------------------------------------------- /negar/constants.py: -------------------------------------------------------------------------------- 1 | import platform 2 | from pathlib import Path 3 | 4 | __version__ = "1.4.3" 5 | 6 | DATAFILE = Path(__file__).parent.absolute() / "data/immutable.words" 7 | APPDATA = "AppData/Roaming/" if platform.system() == "Windows" else ".config/" 8 | USERFILE = Path.home() / f"{APPDATA}python-negar" 9 | 10 | INFO = f"""قابلیت های ویراستار ' نگار ' -- نسخه {__version__} : 11 | * جایگزینی 12 | ╛═ خط تیره های پیاپی نظیر (--) و (---) با معادل های استاندارد شان 13 | ╛═ سه نقطه ی پیاپی (...) با کاراکتر استانداردش در زبان فارسی 14 | ╛═ علایمی نظیر کوتیشن فارسی با گیومه ؛ 'نگار' 15 | ╛═ اعداد عربی '١٢٣٤٥٦٧٨٩٠' و انگلیسی '1234567890' با معادل فارسی 16 | ╛═ کاراکتر های غیر فارسی نظیر ',;%يةك' با معادل های فارسی 17 | * تنظیم فاصله 18 | ╛═ کلماتی که با 'ی' پسوند همراه هستند مانند 'همه ی ' -- و البته امکان جایگزینی آن با حمزه 'ء' ( در صورت انتخاب کاربر ) 19 | ╛═ پرانتز ها یا دیگر علایم ؛ ( نگار ) 20 | ╛═ علائم نقطه‌گذاری ؛ بدون فاصله از قبل و با یک فاصله از بعد به استثنای اعداد اعشاری/نسخه نرم‌افزاری مانند 12.4/1.2.4 21 | ╛═ در پیشوند کلمات با نیم‌فاصله نظیر ' می شود '، ' میشود '، ' بی شک '، ' بیشک ' , ' خانه اش '، ' وظیفه شناس ' ، ' کمک تان ' و یا ' نمیرود ' 22 | ╛═ در پسوند کلمات با نیم‌فاصله نظیر کتابها، خوشترین -- و البته امکان عدم تنظیم (در صورت انتخاب کاربر) 23 | * جلوگیری از 24 | ╛═ استفاده ی بیش از یک علامت ؟؟؟؟ یا !!! 25 | ╛═ کشیـــــــــدگـــــــــــــــــی در کــــــــــــلمــــات 26 | ╛═ فضا های خالی بیش از حد""" 27 | 28 | URLREGX = r"""#https://gist.github.com/gruber/8891611 29 | \b 30 | ( # Capture 1: entire matched URL 31 | (?: 32 | https?|ftp: # URL protocol and colon 33 | (?: 34 | /{1,3} # 1-3 slashes 35 | | # or 36 | [a-z0-9%] # Single letter or digit or '%' 37 | # (Trying not to match e.g. "URI::Escape") 38 | ) 39 | | # or 40 | # looks like domain name followed by a slash: 41 | [a-z0-9.\-]+[.] 42 | (?:[a-z]{2,4}) #com|net|org|edu|gov|mil|aero|asia|biz|cat|coop|info|int|jobs|mobi|museum|name|post|pro|tel|travel|xxx|io|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cs|cu|cv|cx|cy|cz|dd|de|dj|dk|dm|do|dz|ec|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|me|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj| Ja|sk|sl|sm|sn|so|sr|ss|st|su|sv|sx|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zw) 43 | [/?] 44 | ) 45 | (?: # One or more: 46 | [^\s()<>{}\[\]]+ # Run of non-space, non-()<>{}[] 47 | | # or 48 | \([^\s()]*?\([^\s()]+\)[^\s()]*?\) # balanced parens, one level deep: (…(…)…) 49 | | 50 | \([^\s]+?\) # balanced parens, non-recursive: (…) 51 | )+ 52 | (?: # End with: 53 | \([^\s()]*?\([^\s()]+\)[^\s()]*?\) # balanced parens, one level deep: (…(…)…) 54 | | 55 | \([^\s]+?\) # balanced parens, non-recursive: (…) 56 | | # or 57 | [^\s`!()\[\]{};:'".,<>?«»“”‘’] # not a space or one of these punct chars 58 | ) 59 | | # OR, the following to match naked domains: 60 | (?: 61 | (?> pip install negar-gui") 8 | print("After installing negar-gui, `negar` would be an alias for `negar-gui`") 9 | 10 | if __name__=="__main__": 11 | main() 12 | -------------------------------------------------------------------------------- /negar/virastar.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # ruff: noqa: T201 3 | 4 | import enum 5 | import re 6 | import sys 7 | from pathlib import Path 8 | from contextlib import suppress 9 | 10 | import regex 11 | 12 | sys.path.append( 13 | Path(__file__).parent.parent.as_posix() 14 | ) # https://stackoverflow.com/questions/16981921 15 | from negar.constants import DATAFILE, INFO, URLREGX, USERFILE # noqa: E402 16 | 17 | 18 | class State(enum.Enum): 19 | save = 1 20 | restore = 2 21 | 22 | 23 | class PersianEditor: 24 | """Persian Text Editor for some sanitization task called Virastary in Persian.""" 25 | 26 | def __init__(self, text, *args): 27 | # Check to see if `arg` exists in `args` or not 28 | parse_args = lambda arg: arg not in args # noqa: E731 29 | self._prepositions = ( 30 | "از|در|به|با|بر|برای|بی|درباره|تا|را|جز|بدون|چون|مانند|مثل" 31 | "|زیر|روی|همراه|مگر|الا|اندر|زی|برت|الا|زی|چو|سوای|پایین" 32 | "|پشت|پهلوی|پس|پیش|بالای|بیرون|درون|توی|غیر|کنار|مقابل|بهر" 33 | ) 34 | self.text = text 35 | self._cleanup_zwnj = False 36 | # checking for undesired options 37 | self._aggresive = parse_args("aggresive") 38 | self._fix_hamzeh = parse_args("fix-hamzeh") 39 | self._fix_dashes = parse_args("fix-dashes") 40 | self._fix_three_dots = parse_args("fix-three-dots") 41 | self._hamzeh_with_yeh = parse_args("hamzeh-with-yeh") 42 | self._fix_prefix_spacing = parse_args("fix-p-spacing") 43 | self._fix_prefix_separate = parse_args("fix-p-separate") 44 | self._fix_suffix_spacing = parse_args("fix-s-spacing") 45 | self._fix_suffix_separate = parse_args("fix-s-separate") 46 | self._fix_english_quotes = parse_args("fix-english-quotes") 47 | self._fix_arabic_numbers = parse_args("fix-arabic-num") 48 | self._fix_english_numbers = parse_args("fix-english-num") 49 | self._cleanup_spacing = parse_args("cleanup-spacing") 50 | self._cleanup_kashidas = parse_args("cleanup-kashidas") 51 | self._cleanup_extra_marks = parse_args("cleanup-ex-marks") 52 | self._exaggerating_zwnj = parse_args("exaggerating-zwnj") 53 | self._fix_misc_non_persian_chars = parse_args("fix-non-persian-chars") 54 | self._fix_spacing_for_braces_and_quotes = parse_args("fix-spacing-bq") 55 | self._trim_leading_trailing_whitespaces = parse_args("trim-lt-whitespaces") 56 | 57 | ImmutableWords() # to generate the immutable words 58 | self.cleanup() 59 | 60 | def cleanup(self): 61 | self.__handle_comments__(State.save) 62 | self.__handle_urls__(State.save) 63 | # fix punctuation spaces at first 64 | # : ; , ! ? and their Persian counterparts should have one space after and no space before 65 | # An exception is triple dots, which should be handled first 66 | self.fix_three_dots() if self._fix_three_dots else None 67 | self.aggressive() if self._aggresive else None 68 | self.text = re.sub( 69 | r"[ ‌ ]*([…:;,؛،.؟!]{1})[ ‌ ]*", 70 | r"\1 ", 71 | self.text, 72 | ) 73 | if self._trim_leading_trailing_whitespaces: 74 | self.text = "\n".join([line.strip() for line in self.text.split("\n")]) 75 | self.fix_dashes() if self._fix_dashes else None 76 | self.fix_english_quotes() if self._fix_english_quotes else None 77 | self.fix_hamzeh() if self._fix_hamzeh else None 78 | self.cleanup_zwnj() if self._cleanup_zwnj else None 79 | self.char_validator() if self._fix_misc_non_persian_chars else None 80 | self.fix_arabic_numbers() if self._fix_arabic_numbers else None 81 | self.fix_english_numbers() if self._fix_english_numbers else None 82 | self.__handle_immutable_words__(State.save) 83 | self.fix_prefix_spacing() if self._fix_prefix_spacing else None 84 | self.fix_prefix_separate() if self._fix_prefix_separate else None 85 | self.fix_suffix_spacing() if self._fix_suffix_spacing else None 86 | self.fix_suffix_separate() if self._fix_suffix_separate else None 87 | self.__handle_immutable_words__(State.restore) 88 | self.fix_spacing_for_braces_and_quotes() \ 89 | if self._fix_spacing_for_braces_and_quotes else None 90 | self.cleanup_redundant_zwnj() 91 | self.cleanup_spacing() if self._cleanup_spacing else None 92 | self.text = re.sub( 93 | r"…([.؟!])", 94 | r"… \1", 95 | self.text, 96 | ) 97 | if self._trim_leading_trailing_whitespaces: 98 | self.text = "\n".join([line.strip() for line in self.text.split("\n")]) 99 | self.__handle_urls__(State.restore) 100 | self.__handle_comments__(State.restore) 101 | return self.text 102 | 103 | def __repr__(self): 104 | return self.text 105 | 106 | __str__ = __repr__ 107 | 108 | def __handle_comments__(self, state): 109 | """Extract comments, process the content, and reinsert the comments at the end.""" 110 | if state == State.save: 111 | self.comments = list(set(re.findall(r"#>.*$", self.text, re.I | re.M))) 112 | self.comments.sort(key=lambda x: len(x), reverse=True) 113 | for i, comment in enumerate(self.comments): 114 | self.text = regex.sub(rf"{re.escape(comment)}", rf"__COMMENT__#{i}__", self.text) 115 | if state == State.restore: 116 | for i, comment in enumerate(self.comments): 117 | self.text = re.sub(f"__COMMENT__#{i}__", comment, self.text) 118 | 119 | def __handle_urls__(self, state): 120 | """Remove URLs temporarily and reinsert them at the end of the process.""" 121 | if state == State.save: 122 | self.urls = list(set(re.findall(URLREGX, self.text, re.M | re.I | re.X))) 123 | self.urls.sort(key=lambda x: len(x), reverse=True) 124 | for i, url in enumerate(self.urls): 125 | self.text = regex.sub(rf"{re.escape(url)}", rf"__URL__#{i}__", self.text) 126 | if state == State.restore: 127 | for i, url in enumerate(self.urls): 128 | self.text = re.sub(f"__URL__#{i}__", url, self.text) 129 | 130 | def __handle_immutable_words__(self, state): 131 | """Remove immutable words temporarily and reapply them at the end of the process.""" 132 | if state == State.save: 133 | self.immutable_words = {} 134 | words = re.findall(r"\b[\w\u200c]+\b", self.text, re.UNICODE) 135 | for i, word in enumerate(words): 136 | if (word := word.strip()) in ImmutableWords.get(): 137 | self.immutable_words[i] = word 138 | self.text = regex.sub(rf"\b{word}\b", rf"__IMM__#{i}__", self.text) 139 | if state == State.restore: 140 | for imm_key, imm_word in self.immutable_words.items(): 141 | self.text = re.sub(f"__IMM__#{imm_key}__", imm_word, self.text) 142 | 143 | def fix_dashes(self): 144 | """Replace double and triple dashes with `ndash` and `mdash`, respectively.""" 145 | self.text = re.sub(r"-{3}", r"—", self.text) 146 | self.text = re.sub(r"-{2}", r"–", self.text) 147 | 148 | def fix_three_dots(self): 149 | """Replace three dots with an ellipsis.""" 150 | self.text = re.sub(r"\s*\.{3,}(\s)*", r"…\1", self.text) 151 | 152 | def fix_english_quotes(self): 153 | """Replace English quotes with their Persian counterparts.""" 154 | self.text = re.sub(r"([\"'`]+)(.+?)(\1)", r"«\2»", self.text) 155 | 156 | def fix_hamzeh(self): 157 | """Replace trailing 'ه ی' with 'هٔ' or 'ه‌ی'. 158 | 159 | --the last one is achievable if hamzeh_with_yeh set. 160 | """ 161 | if self._hamzeh_with_yeh: 162 | self.text = re.sub(r"(\S)(ه[\s]+[یي])(\b)", r"\1ه‌ی\3", self.text) 163 | else: 164 | self.text = re.sub(r"(\S)(ه[\s]+[یي])(\b)", r"\1هٔ\3", self.text) 165 | 166 | def cleanup_zwnj(self): 167 | """Remove unnecessary ZWNJ that are succeeded/preceded by a space.""" 168 | self.text = re.sub(r"\s+|\s+", r" ", self.text) 169 | 170 | def cleanup_redundant_zwnj(self): 171 | """Remove unwanted ZWNJs which are added by some sanitization tasks.""" 172 | self.text = re.sub(r"([ءاأدذرزژوؤ])‌+", r"\1", self.text) 173 | self.text = re.sub(r"(‌)+", r"\1", self.text) 174 | 175 | def char_validator(self): 176 | """Replace invalid characters with valid ones.""" 177 | bad_chars = ",;%يةك" 178 | good_chars = "،؛٪یهک" 179 | self.text = self.char_translator(bad_chars, good_chars, self.text) 180 | 181 | def fix_arabic_numbers(self): 182 | """Translate Arabic numbers to their Persian counterparts.""" 183 | persian_numbers = "۱۲۳۴۵۶۷۸۹۰" 184 | arabic_numbers = "١٢٣٤٥٦٧٨٩٠" 185 | self.text = self.char_translator( 186 | arabic_numbers, 187 | persian_numbers, 188 | self.text, 189 | ) 190 | 191 | def fix_english_numbers(self): 192 | """Translate English numbers to their Persian counterparts.""" 193 | persian_numbers = "۱۲۳۴۵۶۷۸۹۰" 194 | english_numbers = "1234567890" 195 | self.text = self.char_translator( 196 | english_numbers, 197 | persian_numbers, 198 | self.text, 199 | ) 200 | 201 | # Avoids to change English numbers in strings like 'Text12', 'Text_12', or 'A4' 202 | self.text = re.sub( 203 | r"[۰-۹]+[a-zA-Z_]{1,}[۰-۹]+|[a-zA-Z_]{1,}[۰-۹]+|[۰-۹]+[a-zA-Z_]{1,}", 204 | lambda m: self.char_translator(persian_numbers, english_numbers, m.group()), 205 | self.text, 206 | ) 207 | 208 | def fix_prefix_spacing(self): 209 | """Put ZWNJ between a word and its prefix (mi* nemi* bi* na*).""" 210 | self.text = re.sub(r"\b(بی|نا)([\s|‌]+)(?!(می)\b)", r"\1‌", self.text) 211 | # the following case is for the mi(n.) and nemi(n.) 212 | self.text = re.sub(rf"\b(ن?می)([\s|‌]+)(?!(.|{self._prepositions})\b)", r"\1‌", self.text) 213 | 214 | def fix_prefix_separate(self): 215 | """Put ZWNJ between a word and its prefix (mi* nemi* bi*).""" 216 | # regx = re.compile(r"\b(بی|ن?می)‌*([^\[\]\(\)\s]+)") # \b for words like سهمیه 217 | regx = regex.compile( 218 | r""" 219 | \b(بی|ن?می)‌* 220 | ([^\[\]\(\)\s]+) 221 | (?=3.8", 37 | classifiers=[ 38 | "Environment :: Console", 39 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 40 | "Programming Language :: Python", 41 | "Programming Language :: Python :: 3", 42 | ], 43 | ) 44 | -------------------------------------------------------------------------------- /tests/input_file: -------------------------------------------------------------------------------- 1 | نگار قابلیت های زیر را داراست: 2 | * خط تیره های پیاپی نظیر (--) و (---) را به معادل های استاندارد شان تبدیل می کند. 3 | * سه نقطه ی پیاپی را (...) به کاراکتر استانداردش در زبان فارسی تبدیل می کند. 4 | * علایمی نظیر کوتیشن فارسی را 'نگار' به گیومه تبدیل می کند. 5 | * کلماتی مانند 'همه ی ' که با 'ی' پسوند همراه هستند را به صورت درست می‌نویسد و در صورت انتخاب کاربر می‌تواند آن را با حمزه 'ء' جایگزین کند. 6 | * فاصله گذاری نادرست پرانتز ها نظیر ( نگار ) یا دیگر علایم را به صورت صحیح تنظیم می کند. 7 | * اعداد عربی مانند '١٢٣٤٥٦٧٨٩٠' و انگلیسی مانند '1234567890' را به معادل فارسی شان تبدیل می کند. 8 | * کاراکتر های غیر فارسی را شامل ',;%يةك' به معادل های فارسی شان تبدیل می کند. 9 | * کلماتی که با فاصله ی اشتباه به صورت ' می شود '، ' بی شک '، ' خانه اش '، ' وظیفه شناس ' و یا ' کمک تان ' نوشته شده‌، به صورت درست فاصله گذاری میشوند. 10 | * کلماتی که به اشتباه بدون فاصله به صورت ' میشود '، ' بیشک ' , یا ' نمیرود ' نوشته شده‌، به صورت درست فاصله گذاری میشوند. 11 | * از استفاده ی بیش از یک علامت ؟؟؟؟ یا !!! جلوگیری می کند. 12 | * کلماتی که به صورت کشیـــــــــده نوشته شده اند را به صورت درست می نویسد. 13 | * از فاصله گذاری بیش از حد جلوگیری می کند. 14 | * علائم نقطه‌گذاری به درستی تنظیم میشوند . بدون فاصله از قبل و با یک فاصله از بعد . استثناء اعداد اعشاری هستند مانند 12.4 که نباید فاصله بگیرد . -------------------------------------------------------------------------------- /tests/output: -------------------------------------------------------------------------------- 1 | نگار قابلیت‌‌‌های زیر را داراست‌: 2 | * خط تیره‌‌‌های پیاپی نظیر (‌‌–‌‌) و (‌‌—‌‌) را به معادل‌‌‌های استاندارد‌‌‌شان تبدیل می‌‌‌کند‌. 3 | * سه نقطه‌ی پیاپی را (‌‌…‌‌) به کاراکتر استانداردش در زبان فارسی تبدیل می‌‌‌کند‌. 4 | * علایمی نظیر کوتیشن فارسی را «‌‌نگار‌‌» به گیومه تبدیل می‌‌‌کند‌. 5 | * کلماتی مانند «‌‌همه‌ی‌‌» که با «‌‌ی‌‌» پسوند همراه هستند را به صورت درست می‌‌‌نویسد و در صورت انتخاب کاربر می‌‌‌تواند آن را با حمزه «‌‌ء‌‌» جایگزین کند‌. 6 | * فاصله گذاری نادرست پرانتز‌‌‌ها نظیر (‌‌نگار‌‌) یا دیگر علایم را به صورت صحیح تنظیم می‌‌‌کند‌. 7 | * اعداد عربی مانند «‌‌۱۲۳۴۵۶۷۸۹۰‌‌» و انگلیسی مانند «‌‌۱۲۳۴۵۶۷۸۹۰‌‌» را به معادل فارسی‌‌‌شان تبدیل می‌‌‌کند‌. 8 | * کاراکتر‌‌‌های غیر فارسی را شامل «‌، ‌؛ ٪یهک‌‌» به معادل‌‌‌های فارسی‌‌‌شان تبدیل می‌‌‌کند‌. 9 | * کلماتی که با فاصله‌ی اشتباه به صورت «‌‌می‌‌‌شود‌‌» و یا «‌‌کمک‌‌‌تان‌‌» نوشته شده‌، به صورت درست فاصله گذاری می‌‌شوند‌. 10 | * کلماتی که به اشتباه بدون فاصله به صورت «‌‌می‌‌شود‌‌»‌، یا «‌‌کمک‌‌تان‌‌» نوشته شده‌، به صورت درست فاصله گذاری می‌‌شوند‌. 11 | * از استفاده‌ی بیش از یک علامت‌؟ یا‌! جلوگیری می‌‌‌کند‌. 12 | * کلماتی که به صورت کشیده نوشته شده اند را به صورت درست می‌‌‌نویسد‌. 13 | * از فاصله گذاری بیش از حد جلوگیری می‌‌‌کند‌. -------------------------------------------------------------------------------- /tests/test_unittest.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import functools 3 | from negar.virastar import PersianEditor 4 | 5 | 6 | class Test(unittest.TestCase): 7 | @staticmethod 8 | def _assertEqual(message=""): 9 | def decorator(func): 10 | @functools.wraps(func) 11 | def wrapper(self, *args, **kwargs): 12 | func(self, *args, **kwargs) 13 | return self.assertEqual(f"{PersianEditor(self.input_)}", self.output_, message) 14 | 15 | return wrapper 16 | 17 | return decorator 18 | 19 | # @unittest.skip("") 20 | @_assertEqual("Trim Leading Trailing Whitespaces") 21 | def test_trim_leading_trailing_whitespaces(self): 22 | self.input_ = "فضا های خالی بیش از حد" 23 | self.output_ = "فضاهای خالی بیش از حد" 24 | 25 | @_assertEqual("Fix Hamzeh") 26 | def test_fix_hamzeh(self): 27 | self.input_ = "کلماتی که با 'ی' پسوند همراه هستند مانند 'همه ی ' -- و البته امکان جایگزینی آن با حمزه 'ء' ( در صورت انتخاب کاربر )" # noqa: E501 28 | self.output_ = "کلماتی که با «ی» پسوند همراه هستند مانند «همه‌ی» – و البته امکان جایگزینی آن با حمزه «ء» (در صورت انتخاب کاربر)" # noqa: E501 29 | 30 | @_assertEqual("Numbers as a Version -- Triple Dots") 31 | def test_versioning_numbers_triple(self): 32 | """There is no space between dots of version number!.""" 33 | self.input_ = "نسخه 1.2.4" 34 | self.output_ = "نسخه ۱.۲.۴" 35 | 36 | @_assertEqual("Numbers as a Version -- Double Dots") 37 | def test_versioning_numbers_double(self): 38 | """There is no space between dots of version number!.""" 39 | self.input_ = "نسخه 1.2" 40 | self.output_ = "نسخه ۱.۲" 41 | 42 | @_assertEqual("Consecutive Dashes") 43 | def test_consecutive_dashes(self): 44 | self.input_ = "خط تیره های پیاپی نظیر (--) و (---) با معادل های استاندارد شان" 45 | self.output_ = "خط تیره‌های پیاپی نظیر (–) و (—) با معادل‌های استانداردشان" 46 | 47 | @_assertEqual("Triple Dots I") 48 | def test_triple_dots_i(self): 49 | self.input_ = "سه نقطه ی پیاپی (...) با کاراکتر استانداردش در زبان فارسی" 50 | self.output_ = "سه نقطه‌ی پیاپی (…) با کاراکتر استانداردش در زبان فارسی" 51 | 52 | @_assertEqual("Triple Dots II") 53 | def test_triple_dots_ii(self): 54 | self.input_ = "پرتره ، طبیعت و غیره یا پرتره ، طبیعت و .... ؟" 55 | self.output_ = "پرتره، طبیعت و غیره یا پرتره، طبیعت و… ؟" 56 | 57 | @_assertEqual("Persian Quotations I") 58 | def test_persian_quotations_i(self): 59 | self.input_ = "علایمی نظیر کتیشن فارسی با گیومه ؛ 'نگار'" 60 | self.output_ = "علایمی نظیر کتیشن فارسی با گیومه؛ «نگار»" 61 | 62 | @_assertEqual("Persian Quotations II") 63 | def test_persian_quotations_ii(self): 64 | self.input_ = "«تاثیر نسبی داشته است. »" 65 | self.output_ = "«تاثیر نسبی داشته است.»" 66 | 67 | @_assertEqual("Persian Numbers") 68 | def test_persian_numbers(self): 69 | self.input_ = "اعداد عربی '١٢٣٤٥٦٧٨٩٠' و انگلیسی '1234567890' با معادل فارسی" 70 | self.output_ = "اعداد عربی «۱۲۳۴۵۶۷۸۹۰» و انگلیسی «۱۲۳۴۵۶۷۸۹۰» با معادل فارسی" 71 | 72 | @_assertEqual("Non-Persian Characters") 73 | def test_non_persian_characters(self): 74 | self.input_ = "کاراکتر های غیر فارسی نظیر ',;%يةك' با معادل های فارسی" 75 | self.output_ = "کاراکترهای غیر فارسی نظیر «، ؛ ٪یهک» با معادل‌های فارسی" 76 | 77 | @_assertEqual("Persian-Yeh as a Kasreh") 78 | def test_persian_yeh_as_a_kasreh(self): 79 | self.input_ = "کلماتی که با 'ی' پسوند همراه هستند مانند 'همه ی ' -- و البته امکان جایگزینی آن با حمزه 'ء' ( در صورت انتخاب کاربر )" 80 | self.output_ = "کلماتی که با «ی» پسوند همراه هستند مانند «همه‌ی» – و البته امکان جایگزینی آن با حمزه «ء» (در صورت انتخاب کاربر)" 81 | 82 | @_assertEqual("Fix Parantheses") 83 | def test_fix_parantheses(self): 84 | self.input_ = "پرانتز ها یا دیگر علایم ؛ ( نگار )" 85 | self.output_ = "پرانتزها یا دیگر علایم؛ (نگار)" 86 | 87 | @_assertEqual("Fix Punctuations") 88 | def test_fix_punctuation(self): 89 | self.input_ = "علائم نقطه‌گذاری ؛ بدون فاصله از قبل و با یک فاصله از بعد به استثنای اعداد اعشاری/نسخه نرم‌افزاری مانند 12.4/1.2.4" 90 | self.output_ = "علائم نقطه‌گذاری؛ بدون فاصله از قبل و با یک فاصله از بعد به استثنای اعداد اعشاری/نسخه نرم‌افزاری مانند ۱۲.۴/۱.۲.۴" 91 | 92 | @_assertEqual("Fix Prefix ZWNJ") 93 | def test_fix_prefix_ZWNJ(self): 94 | self.input_ = r"در پیشوند کلمات با نیم‌فاصله نظیر ' می شود '، ' میشود '، ' بی شک '، ' بیشک ' , ' خانه اش '، ' وظیفه شناس ' ، ' کمک تان ' و یا ' نمیرود '" 95 | self.output_ = "در پیشوند کلمات با نیم‌فاصله نظیر «می‌شود»، «می‌شود»، «بی‌شک»، «بی‌شک»، «خانه‌اش»، «وظیفه‌شناس»، «کمک‌تان» و یا «نمی‌رود»" 96 | 97 | @_assertEqual("Fix Prefix ZWNJ II") 98 | def test_fix_prefix_ZWNJ_ii(self): 99 | self.input_ = r"می‌ شود" 100 | self.output_ = "می‌شود" 101 | 102 | @_assertEqual("Fix Prefix ZWNJ III") 103 | def test_fix_prefix_ZWNJ_iii(self): 104 | self.input_ = r"می ‌شود" 105 | self.output_ = "می‌شود" 106 | 107 | @_assertEqual("Fix Suffix ZWNJ I") 108 | def test_fix_suffix_ZWNJ_I(self): 109 | self.input_ = r"در پسوند کلمات با نیم‌فاصله نظیر کتابها، خوشترین -- و البته امکان عدم تنظیم (در صورت انتخاب کاربر)" 110 | self.output_ = "در پسوند کلمات با نیم‌فاصله نظیر کتاب‌ها، خوش‌ترین – و البته امکان عدم تنظیم (در صورت انتخاب کاربر)" 111 | 112 | @_assertEqual("Fix Redundant Glyphs") 113 | def test_cleanup_redundant_glyphs(self): 114 | self.input_ = "استفاده ی بیش از یک علامت ؟؟؟؟ یا !!!" 115 | self.output_ = "استفاده‌ی بیش از یک علامت؟ یا!" 116 | 117 | @_assertEqual("Cleanup Kashidas") 118 | def test_cleanup_kashidas(self): 119 | self.input_ = "کشیـــــــــدگـــــــــــــــــی در کــــــــــــلمــــات" 120 | self.output_ = "کشیدگی در کلمات" 121 | 122 | @_assertEqual("Cleanup Extra Spaces") 123 | def test_cleanup_extra_spaces(self): 124 | self.input_ = "فضا های خالی بیش از حد" 125 | self.output_ = "فضاهای خالی بیش از حد" 126 | 127 | @_assertEqual("Immutable Words I") 128 | def test_immutable_words_i(self): 129 | self.input_ = "تنها ترین خدمتگزار (تنها ترین خدمتگزار)" 130 | self.output_ = "تنهاترین خدمتگزار (تنهاترین خدمتگزار)" 131 | 132 | @_assertEqual("Immutable Words II") 133 | def test_immutable_words_ii(self): 134 | self.input_ = "تنها ترین خدمتگزار (تنها ترین خدمتگزار)" 135 | self.output_ = "تنهاترین خدمتگزار (تنهاترین خدمتگزار)" 136 | 137 | @_assertEqual("Fix Suffix ZWNJ II") 138 | def test_fix_suffix_ZWNJ_II(self): 139 | self.input_ = "بیستم ماه میلادی" 140 | self.output_ = "بیستم ماه میلادی" 141 | 142 | @_assertEqual("Ignore Comment") 143 | def test_ignore_comment(self): 144 | self.input_ = "کشیـــــــــده شده اند #> می نویسد .... " 145 | self.output_ = "کشیده شده‌اند #> می نویسد .... " 146 | 147 | @_assertEqual("mix_parentheses_suffix") 148 | def test_mix_parentheses_suffix(self): 149 | self.input_ = '"دختر تنهایی " ( کهتر بمان )' 150 | self.output_ = "«دختر تنهایی» (کهتر بمان)" 151 | 152 | @_assertEqual("unchanged") 153 | def test_unchanged(self): 154 | self.input_ = "نشان‌دهنده همان‌طور" 155 | self.output_ = "نشان‌دهنده همان‌طور" 156 | 157 | 158 | if __name__ == "__main__": 159 | unittest.main() 160 | --------------------------------------------------------------------------------