diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..16a5d15 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Report a bug in Num2Fa +title: '' +labels: '' +assignees: '' + +--- +**Bug description** + + + +**How to reproduce** + + +**Environment** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0abb369 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest or encourage the addition of a new feature to Num2Fa +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..50a3d89 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,68 @@ +# This script can be tested locally with act: +# +# act --secret GITHUB_TOKEN=... --job release +# +# https://github.com/nektos/act/ +# To generate a token: https://github.com/settings/tokens (add r/w permissions for "Contents") +name: Release + +on: + push: + tags: + - '*' + workflow_dispatch: + +jobs: + release: + runs-on: ${{ matrix.os }} + strategy: + matrix: + include: + # https://github.com/actions/runner-images#available-images + - os: ubuntu-20.04 + locale: C.UTF-8 + env: + LC_ALL: ${{ matrix.locale }} + LANG: ${{ matrix.locale }} + steps: + ##### Setup environment + # https://github.com/actions/checkout + - uses: actions/checkout@v3 + - name: Set up Python + # https://github.com/actions/setup-python + uses: actions/setup-python@v3 + with: + python-version: 3.8 + cache: 'pip' + cache-dependency-path: requirements/dev.txt + - name: Upgrade pip and setuptools + # https://pypi.org/project/pip/ + # https://pypi.org/project/setuptools/ + # https://pypi.org/project/wheel/ + run: python -m pip install --upgrade pip setuptools==65.6.3 wheel + - name: Print info about the current python installation + run: make ci-info + - name: Install requirements + run: make bootstrap-dev + - name: Check or download gh utility + run: | + if ! which gh; then + echo "Downloading 'gh' utility" + if [ "$(uname -s)" = "Linux" ]; then + curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_linux_amd64.tar.gz + tar xzf gh.tar.gz + mv ./gh_2.28.0_linux_amd64/bin/gh /usr/local/bin/gh + else + curl -L -o gh.zip https://github.com/cli/cli/releases/download/v2.28.0/gh_2.28.0_macOS_amd64.zip + unzip xzf gh.zip + mv ./gh_2.28.0_macOS_amd64/bin/gh /usr/local/bin/gh + fi + which gh + fi + + ##### Create release on GitHub + - name: Create or update GitHub release + run: scriv github-release --repo=codewithemad/num2fa + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..3c9415a --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,25 @@ +name: Run tests + +on: + push: + branches: [ master, main, nightly ] + pull_request: + branches: [ master, main, nightly ] + +jobs: + tests: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: 3.8 + cache: 'pip' + cache-dependency-path: requirements/dev.txt + - name: Upgrade pip + run: python -m pip install --upgrade pip setuptools + - name: Install dependencies + run: pip install -r requirements/dev.txt + - name: Run all tests + run: make test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..90f8fbb --- /dev/null +++ b/.gitignore @@ -0,0 +1,176 @@ +# Created by https://www.toptal.com/developers/gitignore/api/python +# Edit at https://www.toptal.com/developers/gitignore?templates=python + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +# End of https://www.toptal.com/developers/gitignore/api/python \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..736b991 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ + + +## v2.0.1 (2023-12-29) + +- Num2Fa was born. (by @CodeWithEmad) diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..bae94e1 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..9a912b7 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include requirements/base.txt +include requirements/dev.txt diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..adaf4bd --- /dev/null +++ b/Makefile @@ -0,0 +1,78 @@ +.DEFAULT_GOAL := help +.PHONY: docs +SRC_DIRS = ./num2fa ./tests ./docs +BLACK_OPTS = --exclude templates ${SRC_DIRS} + +###### Development + +compile-requirements: ## Compile requirements files + pip-compile requirements/base.in + pip-compile requirements/dev.in + +upgrade-requirements: ## Upgrade requirements files + pip-compile --upgrade requirements/base.in + pip-compile --upgrade requirements/dev.in + +build-pythonpackage: build-pythonpackage-num2fa ## Build Python packages ready to upload to pypi + +build-pythonpackage-num2fa: ## Build the "num2fa" python package for upload to pypi + python setup.py sdist + +push-pythonpackage: ## Push python package to pypi + twine upload --skip-existing dist/num2fa-$(shell make version).tar.gz + +test: test-lint test-pytest test-format test-pythonpackage ## Run all tests by decreasing order of priority + +test-static: test-lint test-types test-format ## Run only static tests + +test-format: ## Run code formatting tests + black --check --diff $(BLACK_OPTS) + +test-lint: ## Run code linting tests + pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS} + +test-pytest: ## Run tests + pytest + +test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi + twine check dist/num2fa-$(shell make version).tar.gz + +format: ## Format code automatically + black $(BLACK_OPTS) + +isort: ## Sort imports. This target is not mandatory because the output may be incompatible with black formatting. Provided for convenience purposes. + isort --skip=templates ${SRC_DIRS} + +changelog-entry: ## Create a new changelog entry + scriv create + +changelog: ## Collect changelog entries in the CHANGELOG.md file + scriv collect + +###### Continuous integration tasks + +bootstrap-dev: ## Install dev requirements + pip install .[dev] + +pull-base-images: # Manually pull base images + docker image pull docker.io/ubuntu:20.04 + +ci-info: ## Print info about environment + python --version + pip --version + +ci-test-bundle: ## Run basic tests on bundle + ls -lh ./dist/num2fa + ./dist/num2fa --version + + +###### Additional commands + +version: ## Print the current num2fa version + @python -c 'import io, os; about = {}; exec(io.open(os.path.join("num2fa", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])' + +ESCAPE =  +help: ## Print this help + @grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \ + | sed 's/######* \(.*\)/@ $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \ + | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}' diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc92934 --- /dev/null +++ b/README.md @@ -0,0 +1,129 @@ +# Num2Fa + +[![PyPI releases](https://img.shields.io/pypi/v/num2fa?logo=python&logoColor=white)](https://pypi.python.org/pypi/num2fa) +[![MIT License](https://img.shields.io/github/license/codewithemad/num2fa.svg?style=flat-square)](https://opensource.org/license/agpl-v3/) + +`num2fa` is a versatile solution that enables the conversion of numbers (integers, floats, decimals, fractions, or strings) into their corresponding number or word form in Persian. + +This repo is built upon the foundation of [num2faword](https://github.com/5j9/num2fawords), and I would like to express my gratitude to the [original developer](https://github.com/5j9) for their contributions. + +## Installation + +```bash +pip install num2fa +``` + +That's it! + +## Usage + +You can use `numbers`, `words`, and `ordinal_words` to convert numbers to their respective Persian forms, whether that be in numeric, word, or ordinal form. + +```python +>>> from num2fa import numbers, words, ordinal_words +>>> numbers(1984) +'۱۹۸۴' +>>> numbers('1984') +'۱۹۸۴' +>>> numbers('1.1e-4') +>>> words(1984) +'یک هزار و نهصد و هشتاد و چهار' +>>> ordinal_words(1232) +'یک هزار و دویست و سی و دوم' +>>> ordinal_words(123) +'یکصد و بیست و سوم' +>>> words(1.1e-9) +'یک و یک دهم در ده به توان منفی نه' +``` + +`numbers` and `words` also accepts other common standard types: + +```python + +>>> from decimal import Decimal +>>> from fractions import Fraction + +>>> numbers(Decimal('1.1')) +'۱٫۱' +>>> numbers(Fraction(-2, 5)) +'-۲/۵' +>>> words(Decimal('1.1')) +'یک و یک دهم' +>>> words(Fraction(-2, 5)) +'منفی دو پنجم' +>>> ordinal_words(123) +'یکصد و بیست و سوم' +``` + +## Customization + +The default decimal separator for `numbers` is `٫` and for `words` is `و`. it can be changed to any other strings with `decimal_separator`: + +```python +>>> numbers(19.75, decimal_separator='/') +'۱۹/۷۵' +>>> words(19.75, decimal_separator=' ممیز ') +'نوزده ممیز هفتاد و پنج صدم' +``` + +If you wanted to use different number characters for example `٦` instead of `۶`, you can just: + +```python +from num2fa.constants import PERSIAN_DIGITS + +PERSIAN_DIGITS.update({'6': '٦'}) +numbers(19.66, decimal_separator='/') +'۱۹/٦٦' +``` + +Some people prefer, for example, "صد و هفتاد" over its other form "یکصد و هفتاد". This package uses the second form by default which is also used on official Iranian banknotes. But it can be changed: + +```python +>>> from num2fa.constants import HUNDREDS +>>> words(170) +'یکصد و هفتاد' +>>> HUNDREDS[1] = 'صد' +>>> words(170) +'صد و هفتاد' +``` + +other customizations in `words`: + +```python +>>> words(7, positive='مثبت ') +'مثبت هفت' +>>> words(-2, negative='منهای ') +'منهای دو' +>>> words('۱/۲') +'یک دوم' +>>> words('1/2', fraction_separator=' تقسیم بر ', ordinal_denominator=False) +'یک تقسیم بر دو' +>>> words(1.1e-9) +'یک و یک دهم در ده به توان منفی نه' +>>> words(1.1e-9, scientific_separator=' ضربدر ده به قوهٔ ') +'یک و یک دهم ضربدر ده به قوهٔ منفی نه' +``` + +`positive`, `negative`, `decimal_separator`, `fraction_separator` can be used in `numbers` too. + +All above arguments can be used together. If you prefer to change the default argument values once and for all, use the `change_defaults_numbers` or `change_defaults_words` function: + +```python +>>> from num2fa import change_numbers_defaults, change_words_defaults + +>>> change_numbers_defaults(fraction_separator=' بر ', decimal_separator='.') +>>> numbers('1.89/23') +>>> '۱.۸۹ بر ۲۳' + +>>> change_words_defaults(fraction_separator=' بخش بر ', ordinal_denominator=False) +>>> words('۱/۴') +'یک بخش بر چهار' +``` + +## Contributing + +We welcome contributions! To learn how you can contribute, please check the [Contributing](https://github.com/codewithemad/num2fa/blob/master/docs/Contributing.md) document. + +## License + +This work is licensed under the terms of the [GNU Affero General Public License (AGPL)](https://github.com/codewithemad/num2fa/blob/master/LICENSE.txt). diff --git a/changelog.d/scriv.ini b/changelog.d/scriv.ini new file mode 100644 index 0000000..b5f4bf7 --- /dev/null +++ b/changelog.d/scriv.ini @@ -0,0 +1,8 @@ +[scriv] +version = literal: num2fa/__about__.py: __version__ +categories = +format = md +md_header_level = 2 +new_fragment_template = file: changelog.d/scriv/new_fragment.${config:format}.j2 +entry_title_template = file: changelog.d/scriv/entry_title.${config:format}.j2 +ghrel_template = file: changelog.d/scriv/github_release.${config:format}.j2 diff --git a/changelog.d/scriv/entry_title.md.j2 b/changelog.d/scriv/entry_title.md.j2 new file mode 100644 index 0000000..7afe894 --- /dev/null +++ b/changelog.d/scriv/entry_title.md.j2 @@ -0,0 +1 @@ +{% if version %}v{{ version }} {% endif %}({{ date.strftime('%Y-%m-%d') }}) diff --git a/changelog.d/scriv/github_release.md.j2 b/changelog.d/scriv/github_release.md.j2 new file mode 100644 index 0000000..71d6dc7 --- /dev/null +++ b/changelog.d/scriv/github_release.md.j2 @@ -0,0 +1,8 @@ +Install this version from pip with: + + pip install "num2fa=={{ version.vtext[1:] }}" + + +## Changes + +{{ body }} diff --git a/changelog.d/scriv/new_fragment.md.j2 b/changelog.d/scriv/new_fragment.md.j2 new file mode 100644 index 0000000..6ced2db --- /dev/null +++ b/changelog.d/scriv/new_fragment.md.j2 @@ -0,0 +1,11 @@ + + + + diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..aaa0725 --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,7 @@ +# Contributing + +Third-party contributions are more than welcome! Just make sure to follow these guidelines: + +* Make sure that all tests pass by running `make test` (see [Development](https://github.com/codewithemad/num2fa/blob/master/docs/Development.md) docs). +* Add a changelog entry by running `make changelog-entry`. Edit the new file and follow the formatting instructions that it contains. +* Write a good Git commit title and message: explain why you are making this change, what problem you are solving and which solution you adopted. Link to the relevant conversation topics in the forums and describe your use case. We *love* long, verbose descriptions :) As for the title, [conventional commits](https://www.conventionalcommits.org/) are preferred. Check the repo history! diff --git a/docs/Development.md b/docs/Development.md new file mode 100644 index 0000000..42f04e4 --- /dev/null +++ b/docs/Development.md @@ -0,0 +1,43 @@ +# Development + +## Setting up your development environment + +Start by cloning the repository: + +```bash +git clone https://github.com/codewithemad/num2fa.git +cd num2fa/ +``` + +### Install requirements + +```bash +pip install -e ".[dev]" +``` + +This will install `num2fa` in editable mode with development dependencies. + +### Run tests + +```bash +make test +``` + +Yes, there are very few unit tests for now, but this is probably going to change. + +## Code formatting + +Num2Fa code formatting is enforced by [black](https://black.readthedocs.io/en/stable/). To check whether your code changes conform to formatting standards, run: + +make test-format +And to automatically fix formatting errors, run: + +```bash +make format +``` + +Static error detection is performed by [pylint](https://pylint.readthedocs.io/en/latest/). To detect errors, run: + +```bash +make test-lint +``` diff --git a/num2fa/__about__.py b/num2fa/__about__.py new file mode 100644 index 0000000..159d48b --- /dev/null +++ b/num2fa/__about__.py @@ -0,0 +1 @@ +__version__ = "2.0.1" diff --git a/num2fa/__init__.py b/num2fa/__init__.py new file mode 100644 index 0000000..7ac6848 --- /dev/null +++ b/num2fa/__init__.py @@ -0,0 +1,2 @@ +from .converters.number_converter import change_numbers_defaults, numbers +from .converters.word_converter import change_words_defaults, ordinal_words, words diff --git a/num2fa/cli.py b/num2fa/cli.py new file mode 100644 index 0000000..74d4615 --- /dev/null +++ b/num2fa/cli.py @@ -0,0 +1,43 @@ +import click + +from num2fa.__about__ import __version__ +from num2fa.converters.number_converter import numbers +from num2fa.converters.word_converter import ordinal_words, words + + +class NumberType(click.ParamType): + name = "number" + + def convert(self, value, param, ctx): + try: + if value.startswith("-"): + return -self.parse_number(value[1:]) + return self.parse_number(value) + except ValueError: + self.fail(f"{value} is not a valid number", param, ctx) + + def parse_number(self, value): + try: + return int(value) + except ValueError: + return float(value) + + +@click.command( + help="This command takes a NUMBER as an argument and converts it to Farsi numbers, words or ordinal form depending on the options used:" +) +@click.version_option(version=__version__) +@click.argument("number", type=NumberType()) +@click.option("--word", "-w", is_flag=True, help="Convert to Farsi words") +@click.option("--ordinal", "-o", is_flag=True, help="Convert to ordinal from") +def main(number, word, ordinal): + if ordinal: + click.echo(ordinal_words(number)) + elif word: + click.echo(words(number)) + else: + click.echo(numbers(number)) + + +if __name__ == "__main__": + main() # pylint: disable=no-value-for-parameter diff --git a/num2fa/constants.py b/num2fa/constants.py new file mode 100644 index 0000000..c6d5a7d --- /dev/null +++ b/num2fa/constants.py @@ -0,0 +1,79 @@ +"""""" + + +from itertools import chain + +PERSIAN_DIGITS = { + "0": "۰", + "1": "۱", + "2": "۲", + "3": "۳", + "4": "۴", + "5": "۵", + "6": "۶", + "7": "۷", + "8": "۸", + "9": "۹", +} + +ONES = ["", "یک", "دو", "سه", "چهار", "پنج", "شش", "هفت", "هشت", "نه"] + +TENS = ["", "", "بیست", "سی", "چهل", "پنجاه", "شصت", "هفتاد", "هشتاد", "نود"] + +TEN_TO_TWENTY = [ + "ده", + "یازده", + "دوازده", + "سیزده", + "چهارده", + "پانزده", + "شانزده", + "هفده", + "هجده", + "نوزده", +] + +HUNDREDS = [ + "", + "یکصد", + "دویست", + "سیصد", + "چهارصد", + "پانصد", + "ششصد", + "هفتصد", + "هشتصد", + "نهصد", +] + +CLASSES = [ + "", + " هزار", + " میلیون", + " میلیارد", + " بیلیون", + " بیلیارد", + " تریلیون", + " ترلیارد", + " کوآدریلیون", + " کادریلیارد", + " کوینتیلیون", + " کوانتینیارد", +] + +WORDS_NEGATIVE = "منفی " +WORDS_DECIMAL_SEPARATOR = " و " +WORDS_FRACTION_SEPARATOR = " " +NUMBERS_NEGATIVE = "-" +NUMBERS_DECIMAL_SEPARATOR = "٫" +NUMBERS_FRACTION_SEPARATOR = "/" +DEFAULT_SCIENTIFIC_SEPARATOR = " در ده به توان " +ZERO = "صفر" +DECIMAL_PLACES = ["", " دهم", " صدم"] +DECIMAL_PLACES.extend( + chain.from_iterable( + (i, " ده" + i, " صد" + i) for i in (i + "م" for i in CLASSES[1:]) + ) +) + +NORMALIZATION_TABLE = str.maketrans("E٫", "e.", "_٬,+") diff --git a/num2fa/converters/__init__.py b/num2fa/converters/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/num2fa/converters/number_converter.py b/num2fa/converters/number_converter.py new file mode 100644 index 0000000..fb54329 --- /dev/null +++ b/num2fa/converters/number_converter.py @@ -0,0 +1,142 @@ +from decimal import Decimal +from fractions import Fraction +from functools import singledispatch +from typing import Union + +from num2fa.constants import ( + NUMBERS_DECIMAL_SEPARATOR, + NUMBERS_FRACTION_SEPARATOR, + NUMBERS_NEGATIVE, + PERSIAN_DIGITS, +) +from num2fa.utils import _normalize_str + + +def _exp_numbers( + number: str, + decimal_separator: str, +) -> str: + # exponent + base, e, exponent = number.partition("e") + if exponent: + return _point_numbers(str(float(number)), decimal_separator) + return _point_numbers(base, decimal_separator) + + +def _point_numbers( + number: str, + decimal_separator: str, +) -> str: + before_p, p, after_p = number.partition(".") + + converted = _convert_to_farsi(before_p) + if after_p: + converted += decimal_separator + _convert_to_farsi(after_p) + return converted + + +def _convert_to_farsi(number: str) -> str: + """Convert a number to Persian digits.""" + return "".join(PERSIAN_DIGITS.get(digit, digit) for digit in str(number)) + + +@singledispatch +def numbers( + number: Union[int, float, str, Decimal, Fraction], + positive: str = "", + negative: str = NUMBERS_NEGATIVE, + decimal_separator: str = NUMBERS_DECIMAL_SEPARATOR, + fraction_separator: str = NUMBERS_FRACTION_SEPARATOR, +) -> str: + """Return the Persian number string representation of the input number.""" + raise TypeError("Invalid input type for numbers function.") + + +@numbers.register(str) +@numbers.register(Decimal) +def _( + number: str, + positive: str = "", + negative: str = NUMBERS_NEGATIVE, + decimal_separator: str = NUMBERS_DECIMAL_SEPARATOR, + fraction_separator: str = NUMBERS_FRACTION_SEPARATOR, +) -> str: + # Normalize the number string + number = _normalize_str(number) + + # sign + c0 = number[0] + if c0 == "-": + sign = negative + number = number[1:] + elif c0 == "0": + sign = "" + else: + sign = positive + + numerator, e, denominator = number.partition("/") + if denominator: + return ( + sign + + _point_numbers(numerator, decimal_separator) + + fraction_separator + + _point_numbers(denominator, decimal_separator) + ) + + return sign + _exp_numbers( + numerator, + decimal_separator, + ) + + +@numbers.register(int) +@numbers.register(float) +def _( + number: Union[int, float], + positive: str = "", + negative: str = NUMBERS_NEGATIVE, + decimal_separator: str = NUMBERS_DECIMAL_SEPARATOR, + fraction_separator: str = NUMBERS_FRACTION_SEPARATOR, +) -> str: + """Return the Persian number string representation of the input number.""" + return numbers( + str(number), positive, negative, decimal_separator, fraction_separator + ) + + +@numbers.register(Fraction) +def _( + number: Fraction, + positive: str = "", + negative: str = NUMBERS_NEGATIVE, + decimal_separator: str = NUMBERS_DECIMAL_SEPARATOR, + fraction_separator: str = "/", +) -> str: + numerator = number.numerator + denominator = number.denominator + return ( + numbers(numerator, positive, negative, decimal_separator, fraction_separator) + + fraction_separator + + numbers( + denominator, positive, negative, decimal_separator, fraction_separator + ) + ) + + +def change_numbers_defaults( + positive: str = "", + negative: str = NUMBERS_NEGATIVE, + decimal_separator: str = NUMBERS_DECIMAL_SEPARATOR, + fraction_separator: str = NUMBERS_FRACTION_SEPARATOR, +): + """The the default values for numbers and ordinal_numbers functions.""" + defaults = ( + positive, + negative, + decimal_separator, + fraction_separator, + ) + change_numbers_defaults.__defaults__ = defaults + for func in numbers.registry.values(): + func.__defaults__ = defaults + numbers.__defaults__ = (positive, negative) diff --git a/num2fa/converters/word_converter.py b/num2fa/converters/word_converter.py new file mode 100644 index 0000000..70c98e6 --- /dev/null +++ b/num2fa/converters/word_converter.py @@ -0,0 +1,218 @@ +"""Provide functions to convert a number to Persian words.""" + +from decimal import Decimal +from fractions import Fraction +from functools import singledispatch +from typing import Union + +from num2fa.constants import ( + DEFAULT_SCIENTIFIC_SEPARATOR, + WORDS_DECIMAL_SEPARATOR, + WORDS_FRACTION_SEPARATOR, + WORDS_NEGATIVE, + ZERO, +) +from num2fa.utils import _natural_words, _normalize_str, _point_words + + +def _exp_words( + number: str, + positive: str, + negative: str, + decimal_separator: str, + scientific_separator: str, +) -> str: + # exponent + base, e, exponent = number.partition("e") + if exponent: + return ( + _point_words(base, decimal_separator) + + scientific_separator + + words(int(exponent), positive, negative) + ) + return _point_words(base, decimal_separator) + + +@singledispatch +def words( + number: Union[int, float, str, Decimal, Fraction], + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = WORDS_FRACTION_SEPARATOR, + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +) -> str: + """Return the word form of number. + + If input is a string it should be in the form of a valid Python + representation for one of the other accepted types. The only exceptions are + that digits can be in Persian, for example words('۴۲') is valid. + + """ + raise TypeError("invalid input type for words function", number) + + +@words.register(str) +@words.register(Decimal) +def _( + number: str, + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = WORDS_FRACTION_SEPARATOR, + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +) -> str: + # Normalize the number string + number = _normalize_str(number) + + # sign + c0 = number[0] + if c0 == "-": + sign = negative + number = number[1:] + elif c0 == "0": + sign = "" + else: + sign = positive + + numerator, e, denominator = number.partition("/") + + if denominator: + if ordinal_denominator: + return ( + sign + + _natural_words(numerator) + + fraction_separator + + ordinal_words(denominator) + ) + return ( + sign + + _natural_words(numerator) + + fraction_separator + + _natural_words(denominator) + ) + return sign + _exp_words( + numerator, + positive, + negative, + decimal_separator, + scientific_separator, + ) + + +@words.register(Fraction) +def _( + number: Fraction, + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = WORDS_FRACTION_SEPARATOR, + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +) -> str: + numerator = number.numerator + if numerator < 0: + sign = negative + numerator = str(numerator)[1:] + else: + sign = positive + numerator = str(numerator) + if ordinal_denominator: + return ( + sign + + _natural_words(numerator) + + fraction_separator + + ordinal_words(number.denominator) # denominator has no sign + ) + return ( + sign + + _natural_words(numerator) + + fraction_separator + + _natural_words(str(number.denominator)) # denominator has no sign + ) + + +@words.register(int) +def _( + number: int, + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = WORDS_FRACTION_SEPARATOR, + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +) -> str: + """Return the fa-word form for the given int.""" + if number == 0: + return ZERO + if number < 0: + return negative + _natural_words(str(number)[1:]) + return positive + _natural_words(str(number)) + + +@words.register(float) +def _( + number: float, + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = WORDS_FRACTION_SEPARATOR, + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +) -> str: + """Return the fa-word form for the given float.""" + if number == 0: + return ZERO + str_num = str(number) + if number < 0: + return negative + _exp_words( + str_num[1:], + positive, + negative, + decimal_separator, + scientific_separator, + ) + return positive + _exp_words( + str_num, + positive, + negative, + decimal_separator, + scientific_separator, + ) + + +def ordinal_words( + number: Union[int, str], + positive: str = "", + negative: str = WORDS_NEGATIVE, +) -> str: + """Return the number converted to ordinal words form.""" + w = words(int(number), positive, negative) + if w[-2:] == "سه": + return w[:-2] + "سوم" + return w + "م" + + +def change_words_defaults( + positive: str = "", + negative: str = WORDS_NEGATIVE, + decimal_separator: str = WORDS_DECIMAL_SEPARATOR, + fraction_separator: str = " ", + ordinal_denominator: bool = True, + scientific_separator: str = DEFAULT_SCIENTIFIC_SEPARATOR, +): + """The the default values for words and ordinal_words functions.""" + defaults = ( + positive, + negative, + decimal_separator, + fraction_separator, + ordinal_denominator, + scientific_separator, + ) + change_words_defaults.__defaults__ = defaults + for func in words.registry.values(): + func.__defaults__ = defaults + words.__defaults__ = (positive, negative) diff --git a/num2fa/utils.py b/num2fa/utils.py new file mode 100644 index 0000000..a935308 --- /dev/null +++ b/num2fa/utils.py @@ -0,0 +1,88 @@ +from num2fa.constants import ( + CLASSES, + DECIMAL_PLACES, + HUNDREDS, + NORMALIZATION_TABLE, + ONES, + TEN_TO_TWENTY, + TENS, + WORDS_DECIMAL_SEPARATOR, + ZERO, +) + + +def _normalize_str(number: str) -> str: + """Normalize the input number string.""" + return str(number).strip().translate(NORMALIZATION_TABLE) + + +def _point_words( + number: str, + decimal_separator: str, +) -> str: + before_p, p, after_p = number.partition(".") + if after_p: + if before_p == "0": + if after_p == "0": + return ZERO + return _natural_words(after_p) + DECIMAL_PLACES[len(after_p)] + if after_p != "0": + return ( + _natural_words(before_p) + + decimal_separator + + _natural_words(after_p) + + DECIMAL_PLACES[len(after_p)] + ) + return _natural_words(before_p) + return _natural_words(before_p) + + +def _natural_words(str_num: str) -> str: + if str_num == "0": + return ZERO + length = len(str_num) + if length > len(CLASSES) * 3: + raise ValueError("out of range") + + modulo_3 = length % 3 + if modulo_3: + str_num = "0" * (3 - modulo_3) + str_num + length += 3 - modulo_3 + + groups = length // 3 + group = groups + natural_words = "" + while group > 0: + three_digit = str_num[group * 3 - 3 : group * 3] + word3 = _three_digit_words(int(three_digit)) + if word3 and group != groups: + if natural_words: + natural_words = ( + word3 + + CLASSES[groups - group] + + WORDS_DECIMAL_SEPARATOR + + natural_words + ) + else: + natural_words = word3 + CLASSES[groups - group] + else: + natural_words = word3 + natural_words + group -= 1 + + return natural_words + + +def _three_digit_words(number: int) -> str: + """Return the word representation of 0 < number < 1000.""" + h, t, o = number // 100, number % 100 // 10, number % 10 + if h == 0 or (t == o == 0): + w = HUNDREDS[h] + else: + w = HUNDREDS[h] + WORDS_DECIMAL_SEPARATOR + if t == 1: + return w + TEN_TO_TWENTY[o] + if o == 0 or t == 0: + w += TENS[t] + else: + w += TENS[t] + WORDS_DECIMAL_SEPARATOR + return w + ONES[o] diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d1e6ae6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,2 @@ +[build-system] +requires = ["setuptools", "wheel"] diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..e69de29 diff --git a/requirements/base.in b/requirements/base.in new file mode 100644 index 0000000..918b649 --- /dev/null +++ b/requirements/base.in @@ -0,0 +1 @@ +click>=8.0 # https://pypi.org/project/click/ diff --git a/requirements/base.txt b/requirements/base.txt new file mode 100644 index 0000000..ccfb7cf --- /dev/null +++ b/requirements/base.txt @@ -0,0 +1,8 @@ +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile requirements/base.in +# +click==8.1.7 + # via -r requirements/base.in diff --git a/requirements/dev.in b/requirements/dev.in new file mode 100644 index 0000000..2fe315a --- /dev/null +++ b/requirements/dev.in @@ -0,0 +1,7 @@ +-r base.txt +black +pip-tools +pylint +scriv +twine +pytest diff --git a/requirements/dev.txt b/requirements/dev.txt new file mode 100644 index 0000000..8e41a44 --- /dev/null +++ b/requirements/dev.txt @@ -0,0 +1,147 @@ +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile requirements/dev.in +# +astroid==3.0.2 + # via pylint +attrs==23.1.0 + # via scriv +black==23.12.1 + # via -r requirements/dev.in +build==1.0.3 + # via pip-tools +certifi==2023.11.17 + # via requests +cffi==1.16.0 + # via cryptography +charset-normalizer==3.3.2 + # via requests +click==8.1.7 + # via + # -r requirements/base.txt + # black + # click-log + # pip-tools + # scriv +click-log==0.4.0 + # via scriv +cryptography==41.0.7 + # via secretstorage +dill==0.3.7 + # via pylint +docutils==0.20.1 + # via readme-renderer +exceptiongroup==1.2.0 + # via pytest +idna==3.6 + # via requests +importlib-metadata==7.0.1 + # via + # keyring + # twine +iniconfig==2.0.0 + # via pytest +isort==5.13.2 + # via pylint +jaraco-classes==3.3.0 + # via keyring +jeepney==0.8.0 + # via + # keyring + # secretstorage +jinja2==3.1.2 + # via scriv +keyring==24.3.0 + # via twine +markdown-it-py==3.0.0 + # via + # rich + # scriv +markupsafe==2.1.3 + # via jinja2 +mccabe==0.7.0 + # via pylint +mdurl==0.1.2 + # via markdown-it-py +more-itertools==10.1.0 + # via jaraco-classes +mypy-extensions==1.0.0 + # via black +nh3==0.2.15 + # via readme-renderer +packaging==23.2 + # via + # black + # build + # pytest +pathspec==0.12.1 + # via black +pip-tools==7.3.0 + # via -r requirements/dev.in +pkginfo==1.9.6 + # via twine +platformdirs==4.1.0 + # via + # black + # pylint +pluggy==1.3.0 + # via pytest +pycparser==2.21 + # via cffi +pygments==2.17.2 + # via + # readme-renderer + # rich +pylint==3.0.3 + # via -r requirements/dev.in +pyproject-hooks==1.0.0 + # via build +pytest==7.4.3 + # via -r requirements/dev.in +readme-renderer==42.0 + # via twine +requests==2.31.0 + # via + # requests-toolbelt + # scriv + # twine +requests-toolbelt==1.0.0 + # via twine +rfc3986==2.0.0 + # via twine +rich==13.7.0 + # via twine +scriv==1.5.1 + # via -r requirements/dev.in +secretstorage==3.3.3 + # via keyring +tomli==2.0.1 + # via + # black + # build + # pip-tools + # pylint + # pyproject-hooks + # pytest +tomlkit==0.12.3 + # via pylint +twine==4.0.2 + # via -r requirements/dev.in +typing-extensions==4.9.0 + # via + # astroid + # black +urllib3==2.1.0 + # via + # requests + # twine +wheel==0.42.0 + # via pip-tools +zipp==3.17.0 + # via importlib-metadata + +# The following packages are considered to be unsafe in a requirements file: +# pip +# setuptools diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..52c8af7 --- /dev/null +++ b/setup.py @@ -0,0 +1,79 @@ +import io +import os +from typing import Dict, List + +from setuptools import find_packages, setup + +HERE = os.path.abspath(os.path.dirname(__file__)) + + +def load_requirements(filename: str) -> List[str]: + with io.open( + os.path.join(HERE, "requirements", filename), "rt", encoding="utf-8" + ) as f: + return [line.strip() for line in f if is_requirement(line)] + + +def load_readme() -> str: + with io.open(os.path.join(HERE, "README.md"), "rt", encoding="utf8") as f: + readme = f.read() + # Replace img src for publication on pypi + return readme.replace( + "./docs/img/", "https://github.com/codewithemad/num2fa/raw/master/docs/img/" + ) + + +def is_requirement(line: str) -> bool: + return not (line.strip() == "" or line.startswith("#")) + + +def load_about() -> Dict[str, str]: + about: Dict[str, str] = {} + with io.open( + os.path.join(HERE, "num2fa", "__about__.py"), "rt", encoding="utf-8" + ) as f: + exec(f.read(), about) # pylint: disable=exec-used + return about + + +ABOUT = load_about() + +setup( + name="num2fa", + version=ABOUT["__version__"], + project_urls={ + "Code": "https://github.com/codewithemad/num2fa", + "Issue tracker": "https://github.com/codewithemad/num2fa/issues", + }, + license="AGPLv3", + author="Emad Rad", + author_email="codewithemad@gmail.com", + description="A library to convert numbers (ints, floats, and other " + "standard numerical types) into Persian numbers or words.", + long_description=load_readme(), + long_description_content_type="text/markdown", + packages=find_packages(exclude=["tests*"]), + test_suite="tests", + include_package_data=True, + python_requires=">=3.6", + entry_points={ + "console_scripts": ["num2fa=num2fa.cli:main"], + }, + install_requires=load_requirements("base.txt"), + extras_require={ + "dev": load_requirements("dev.txt"), + }, + classifiers=[ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU Affero General Public License v3", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + ], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_numbers.py b/tests/test_numbers.py new file mode 100644 index 0000000..2a8b41b --- /dev/null +++ b/tests/test_numbers.py @@ -0,0 +1,41 @@ +from fractions import Fraction + +from num2fa import numbers + + +def test_non_negative_integer(): + assert numbers(0) == "۰" + assert numbers(123) == "۱۲۳" + assert numbers(1000) == "۱۰۰۰" + + +def test_non_negative_float(): + assert numbers(0.01) == "۰٫۰۱" + assert numbers(12.345) == "۱۲٫۳۴۵" + + +def test_negative(): + assert numbers(-1984) == "-۱۹۸۴" + assert numbers(-19.84) == "-۱۹٫۸۴" + assert numbers(-123.456, decimal_separator="/") == "-۱۲۳/۴۵۶" + assert numbers(-123.456, decimal_separator="/", negative="_") == "_۱۲۳/۴۵۶" + + +def test_decimal_separator(): + assert numbers(123.456, decimal_separator="_") == "۱۲۳_۴۵۶" + assert numbers(123.456, decimal_separator="٬") == "۱۲۳٬۴۵۶" + + +def test_fraction_separator(): + assert numbers(Fraction(1, 2), fraction_separator=":") == "۱:۲" + assert numbers(Fraction(3, 4), fraction_separator="-") == "۳-۴" + assert numbers(Fraction(5, 7), fraction_separator=".") == "۵.۷" + + +def test_exponent_numbers(): + assert numbers(1e4) == "۱۰۰۰۰٫۰" + assert numbers("1e4") == "۱۰۰۰۰٫۰" + assert numbers("1.1e4") == "۱۱۰۰۰٫۰" + assert numbers(2e-3) == "۰٫۰۰۲" + assert numbers("2e-3") == "۰٫۰۰۲" + assert numbers("2.1e-3") == "۰٫۰۰۲۱" diff --git a/tests/test_words.py b/tests/test_words.py new file mode 100644 index 0000000..fad14b1 --- /dev/null +++ b/tests/test_words.py @@ -0,0 +1,239 @@ +from decimal import Decimal +from fractions import Fraction +from math import pi + +from num2fa.converters.word_converter import Decimal, Fraction, ordinal_words, words + + +def test_non_negative(): + """Test the words function.""" + assert words(0) == "صفر" + assert words("0") == "صفر" + assert words(1) == "یک" + assert words(2) == "دو" + assert words(3) == "سه" + assert words(4) == "چهار" + assert words(5) == "پنج" + assert words(6) == "شش" + assert words(7) == "هفت" + assert words(8) == "هشت" + assert words(9) == "نه" + assert words(10) == "ده" + assert words(11) == "یازده" + assert words(12) == "دوازده" + assert words(13) == "سیزده" + assert words(14) == "چهارده" + assert words(15) == "پانزده" + assert words(16) == "شانزده" + assert words(17) == "هفده" + assert words(18) == "هجده" + assert words(19) == "نوزده" + assert words(20) == "بیست" + assert words(21) == "بیست و یک" + assert words(22) == "بیست و دو" + assert words(23) == "بیست و سه" + assert words(24) == "بیست و چهار" + assert words(29) == "بیست و نه" + assert words(30) == "سی" + assert words(35) == "سی و پنج" + assert words(44) == "چهل و چهار" + assert words(57) == "پنجاه و هفت" + assert words(61) == "شصت و یک" + assert words(78) == "هفتاد و هشت" + assert words(80) == "هشتاد" + assert words(93) == "نود و سه" + assert words(100) == "یکصد" + assert words(101) == "یکصد و یک" + assert words(1235) == "یک هزار و دویست و سی و پنج" + assert words(99999999) == "نود و نه میلیون و نهصد و نود و نه هزار و نهصد و نود و نه" + assert ( + words(999999999999999999) == "نهصد و نود و نه بیلیارد" + " و نهصد و نود و نه بیلیون" + " و نهصد و نود و نه میلیارد" + " و نهصد و نود و نه میلیون" + " و نهصد و نود و نه هزار" + " و نهصد و نود و نه" + ) + + +def test_negative_numbers(): + assert ordinal_words(-5) == "منفی پنجم" + assert words(-5) == "منفی پنج" + assert words("-5.5") == "منفی پنج و پنج دهم" + + +def test_non_negative_ordinal_words(): + """Test the ordinal_words function.""" + assert ordinal_words(0) == "صفرم" + assert ordinal_words("0") == "صفرم" + assert ordinal_words(1) == "یکم" + assert ordinal_words(2) == "دوم" + assert ordinal_words(3) == "سوم" + assert ordinal_words(4) == "چهارم" + assert ordinal_words(5) == "پنجم" + assert ordinal_words(6) == "ششم" + assert ordinal_words(7) == "هفتم" + assert ordinal_words(8) == "هشتم" + assert ordinal_words(9) == "نهم" + assert ordinal_words(10) == "دهم" + assert ordinal_words(11) == "یازدهم" + assert ordinal_words(12) == "دوازدهم" + assert ordinal_words(13) == "سیزدهم" + assert ordinal_words(14) == "چهاردهم" + assert ordinal_words(15) == "پانزدهم" + assert ordinal_words(16) == "شانزدهم" + assert ordinal_words(17) == "هفدهم" + assert ordinal_words(18) == "هجدهم" + assert ordinal_words(19) == "نوزدهم" + assert ordinal_words(20) == "بیستم" + assert ordinal_words(21) == "بیست و یکم" + assert ordinal_words(22) == "بیست و دوم" + assert ordinal_words(23) == "بیست و سوم" + assert ordinal_words(24) == "بیست و چهارم" + assert ordinal_words(111) == "یکصد و یازدهم" + assert ordinal_words(1999) == "یک هزار و نهصد و نود و نهم" + assert ordinal_words(10666) == "ده هزار و ششصد و شصت و ششم" + assert ordinal_words(999555) == "نهصد و نود و نه هزار و پانصد و پنجاه و پنجم" + + assert ordinal_words(1000000) == "یک میلیونم" + + +def test_float(): + assert words(0.0) == "صفر" + assert words("0.0") == "صفر" + assert words(1.0) == "یک" + assert words(1.1) == "یک و یک دهم" + assert words(1.100) == "یک و یک دهم" + assert words(0.001) == "یک هزارم" + assert words(0.1001) == "یک هزار و یک ده هزارم" + assert words(5.45) == "پنج و چهل و پنج صدم" + assert words(1e-3) == "یک هزارم" + assert words(1e-3) == "یک هزارم" + assert words("1e-3") == "یک در ده به توان منفی سه" + assert words("1E-3") == "یک در ده به توان منفی سه" + assert words(1e-6) == "یک در ده به توان منفی شش" + assert words(1e-6) == "یک در ده به توان منفی شش" + + assert words(0.000001) == "یک در ده به توان منفی شش" + assert words("0.000001") == "یک میلیونم" + + assert words(0.0000011) == "یک و یک دهم در ده به توان منفی شش" + assert words("0.0000011") == "یازده ده میلیونم" + + assert words(0.00000111) == "یک و یازده صدم در ده به توان منفی شش" + + assert words("0.00000111") == "یکصد و یازده صد میلیونم" + + assert words(0.000001111) == "یک و یکصد و یازده هزارم در ده به توان منفی شش" + assert words("0.000001111") == "یک هزار و یکصد و یازده میلیاردم" + + +def test_str_input(): + assert words("42") == "چهل و دو" + assert words("\t\n 42 \n\t") == "چهل و دو" + assert words("3.14") == "سه و چهارده صدم" + assert words("+1.1", positive="مثبت ") == "مثبت یک و یک دهم" + assert words("1e2") == "یک در ده به توان دو" + assert words("1E2") == "یک در ده به توان دو" + + +def test_decimal_input(): + assert words(Decimal("3.0")) == "سه" + assert words(Decimal("-3.14")) == "منفی سه و چهارده صدم" + # Let's go beyond floats + beyond_float = words(Decimal(str(pi) + "238")) + assert beyond_float != words(pi) + assert beyond_float.endswith("") + # Decimal(float('1.1')) + # == Decimal('1.100000000000000088817841970012523233890533447265625') + + +def test_fractions(): + assert words(Fraction(16, -10)) == "منفی هشت پنجم" + assert words(Fraction(Decimal("1.1"))) == "یازده دهم" + assert words("-8/4") == "منفی هشت چهارم" + assert words(Fraction(0, 1)) == "صفر یکم" + assert words("0/1") == "صفر یکم" + + +def test_persian_numbers(): + assert words("۱") == "یک" + assert words("۱٫۱") == "یک و یک دهم" + assert words("۱٬۰۰۰") == "یک هزار" + + +def test_negative_float(): + assert words(-1.1) == "منفی یک و یک دهم" + + +def test_positive(): + assert words(0, positive="مثبت ") == "صفر" + assert words(7, positive="مثبت ") == "مثبت هفت" + assert words(Fraction("1/2"), positive="مثبت ") == "مثبت یک دوم" + assert words("1.1e+9", positive="مثبت ") == "مثبت یک و یک دهم در ده به توان مثبت نه" + + assert ( + words(1.1e9, positive="مثبت ") == "مثبت یک میلیارد و یکصد میلیون" + ) # str(-1.1e+9) == 1100000000.0 + + +def test_negative(): + assert words(-2, negative="منهای ") == "منهای دو" + assert words("-2", negative="منهای ") == "منهای دو" + assert words(-1.1, negative="منهای ") == "منهای یک و یک دهم" + assert words("-1.1", negative="منهای ") == "منهای یک و یک دهم" + assert ( + words(-1.1e-06, negative="منهای ") == "منهای یک و یک دهم در ده به توان منهای شش" + ) + + assert words("-1/2", negative="منهای ") == "منهای یک دوم" + + assert words(Fraction(1, -2), negative="منهای ") == "منهای یک دوم" + + +def test_fraction_separator(): + assert ( + words( + "1/2", + fraction_separator=" تقسیم بر ", + ordinal_denominator=False, + ) + == "یک تقسیم بر دو" + ) + assert ( + words( + Fraction(4, -8), + negative="منهای ", + fraction_separator=" تقسیم بر ", + ordinal_denominator=False, + ) + == "منهای یک تقسیم بر دو" + ) + + +def test_scientific_separator(): + assert ( + words(1.1e-9, scientific_separator=" ضربدر ده به قوهٔ ") + == "یک و یک دهم ضربدر ده به قوهٔ منفی نه" + ) + + assert ( + words("1.1e-9", scientific_separator=" ضربدر ده به قوهٔ ") + == "یک و یک دهم ضربدر ده به قوهٔ منفی نه" + ) + + +def test_scientific_fraction_separator(): + assert ( + words("1/2", fraction_separator=" تقسیم بر ", ordinal_denominator=False) + == "یک تقسیم بر دو" + ) + + assert ( + words( + Fraction(1, 2), + fraction_separator=" تقسیم بر ", + ordinal_denominator=False, + ) + == "یک تقسیم بر دو" + )