From ec8b96fb0c5115e6a7d656f33ae44ac2cc8fda22 Mon Sep 17 00:00:00 2001 From: CoolCat467 <52022020+CoolCat467@users.noreply.github.com> Date: Sat, 11 Mar 2023 21:34:09 -0600 Subject: [PATCH] Version 0.1.0 - Update to using pyproject.toml --- .pre-commit-config.yaml | 29 + pyproject.toml | 61 +++ requirements.txt | 0 requirements_dev.txt | 5 + setup.cfg | 4 - setup.py | 201 ------- src/idlealign.egg-info/PKG-INFO | 697 +++++++++++++++++++++++- src/idlealign.egg-info/SOURCES.txt | 3 +- src/idlealign.egg-info/entry_points.txt | 1 - src/idlealign/__init__.py | 261 ++++----- src/idlealign/py.typed | 0 tox.ini | 15 + 12 files changed, 935 insertions(+), 342 deletions(-) create mode 100644 .pre-commit-config.yaml create mode 100644 pyproject.toml create mode 100644 requirements.txt create mode 100644 requirements_dev.txt delete mode 100644 setup.cfg delete mode 100644 setup.py create mode 100644 src/idlealign/py.typed create mode 100644 tox.ini diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..822f031 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,29 @@ +repos: + - repo: https://github.com/hadialqattan/pycln + rev: v2.1.3 # must match requirements_dev.txt + hooks: + - id: pycln + args: [--config=pyproject.toml, src] + - repo: https://github.com/psf/black + rev: 23.1.0 # must match requirements_dev.txt + hooks: + - id: black + language_version: python3.11 + args: [--safe] + - repo: https://github.com/pycqa/isort + rev: 5.12.0 # must match requirements_dev.txt + hooks: + - id: isort + name: isort (python) + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v3.0.0-alpha.6 + hooks: + - id: prettier + types_or: [yaml] + +ci: + autofix_commit_msg: "[pre-commit.ci] auto fixes from pre-commit.com hooks" + autofix_prs: true + autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate" + autoupdate_schedule: quarterly + submodules: false diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..99c8033 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,61 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "idlealign" +version = "0.1.0" +authors = [ + { name="CoolCat467" }, +] +description = "Emacs Align by Regular Expression for IDLE" +readme = {file = "README.md", content-type = "text/markdown"} +license = {file = "LICENSE"} +requires-python = ">=3.8" +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3 :: Only", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Operating System :: OS Independent", + "Framework :: IDLE", + "Topic :: Utilities", + "Typing :: Typed", +] +keywords = ["align", "regex", "idle", "extension", "development"] + +[project.urls] +"Homepage" = "https://github.com/CoolCat467/idlealign" +"Source" = "https://github.com/CoolCat467/idlealign" +"Bug Tracker" = "https://github.com/CoolCat467/idlealign/issues" + +[project.scripts] +idlealign = "idlealign:check_installed" + +[tool.mypy] +mypy_path = "src" +check_untyped_defs = true +disallow_any_generics = true +disallow_untyped_calls = true +disallow_untyped_defs = true +ignore_missing_imports = true +no_implicit_optional = true +no_implicit_reexport = true +show_column_numbers = true +show_error_codes = true +strict = true +strict_equality = true +warn_redundant_casts = true +warn_return_any = true +warn_unreachable = true +warn_unused_configs = true +warn_unused_ignores = true + +[tool.black] +line-length = 79 +target-version = ['py311'] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..a55e299 --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,5 @@ +black==23.1.0 # must match .pre-commit-config.yaml +isort==5.12.0 # must match .pre-commit-config.yaml +mypy==1.0.1 +pycln==2.1.3 # must match .pre-commit-config.yaml +pre-commit diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 5838cae..0000000 --- a/setup.cfg +++ /dev/null @@ -1,4 +0,0 @@ -[metadata] -# This includes the license file(s) in the wheel. -# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file -license_files = LICENSE diff --git a/setup.py b/setup.py deleted file mode 100644 index 1b4db01..0000000 --- a/setup.py +++ /dev/null @@ -1,201 +0,0 @@ -"""A setuptools based setup module. - -See: -https://packaging.python.org/guides/distributing-packages-using-setuptools/ -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages -import pathlib - -here = pathlib.Path(__file__).parent.resolve() - -version = '0.0.1' -# Get the long description from the README file -long_description = (here / 'README.md').read_text(encoding='utf-8') -install_requires = [] - -# Arguments marked as "Required" below must be included for upload to PyPI. -# Fields marked as "Optional" may be commented out. - -setup( - # This is the name of your project. The first time you publish this - # package, this name will be registered for you. It will determine how - # users can install this project, e.g.: - # - # $ pip install sampleproject - # - # And where it will live on PyPI: https://pypi.org/project/sampleproject/ - # - # There are some restrictions on what makes a valid project name - # specification here: - # https://packaging.python.org/specifications/core-metadata/#name - name='idlealign', # Required - - # Versions should comply with PEP 440: - # https://www.python.org/dev/peps/pep-0440/ - # - # For a discussion on single-sourcing the version across setup.py and the - # project code, see - # https://packaging.python.org/en/latest/single_source_version.html - version=version, # Required - - # This is a one-line description or tagline of what your project does. This - # corresponds to the "Summary" metadata field: - # https://packaging.python.org/specifications/core-metadata/#summary - description='Emacs Align by Regular Expression for IDLE', # Optional - - # This is an optional longer description of your project that represents - # the body of text which users will see when they visit PyPI. - # - # Often, this is the same as your README, so you can just read it in from - # that file directly (as we have already done above) - # - # This field corresponds to the "Description" metadata field: - # https://packaging.python.org/specifications/core-metadata/#description-optional - long_description=long_description, # Optional - - # Denotes that our long_description is in Markdown; valid values are - # text/plain, text/x-rst, and text/markdown - # - # Optional if long_description is written in reStructuredText (rst) but - # required for plain-text or Markdown; if unspecified, "applications should - # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and - # fall back to text/plain if it is not valid rst" (see link below) - # - # This field corresponds to the "Description-Content-Type" metadata field: - # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional - long_description_content_type='text/markdown', # Optional (see note above) - - # This should be a valid link to your project's main homepage. - # - # This field corresponds to the "Home-Page" metadata field: - # https://packaging.python.org/specifications/core-metadata/#home-page-optional - url='https://github.com/CoolCat467/idlealign', # Optional - - # This should be your name or the name of the organization which owns the - # project. - author='CoolCat467', # Optional - - # This should be a valid email address corresponding to the author listed - # above. -## author_email='author@example.com', # Optional - - # Classifiers help users find your project by categorizing it. - # - # For a list of valid classifiers, see https://pypi.org/classifiers/ - classifiers=[ # Optional - # How mature is this project? Common values are - # 3 - Alpha - # 4 - Beta - # 5 - Production/Stable - 'Development Status :: 3 - Alpha', - - # Indicate who your project is intended for - 'Intended Audience :: Developers', - 'Topic :: Software Development :: Build Tools', - - # Pick your license as you wish - 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', - - # Specify the Python versions you support here. In particular, ensure - # that you indicate you support Python 3. These classifiers are *not* - # checked by 'pip install'. See instead 'python_requires' below. - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Programming Language :: Python :: 3 :: Only', - ], - - # This field adds keywords for your project which will appear on the - # project page. What does your project relate to? - # - # Note that this is a list of additional keywords, separated - # by commas, to be used to assist searching for the distribution in a - # larger catalog. - keywords='align, regex, idle, extension, development', # Optional - - # When your source code is in a subdirectory under the project root, e.g. - # `src/`, it is necessary to specify the `package_dir` argument. - package_dir={'': 'src'}, # Optional - - # You can just specify package directories manually here if your project is - # simple. Or you can use find_packages(). - # - # Alternatively, if you just want to distribute a single Python file, use - # the `py_modules` argument instead as follows, which will expect a file - # called `my_module.py` to exist: - # - # py_modules=["my_module"], - # - packages=find_packages(where='src'), # Required - - # Specify which Python versions you support. In contrast to the - # 'Programming Language' classifiers above, 'pip install' will check this - # and refuse to install the project if the version does not match. See - # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires - python_requires='>=3.8, <4', - - # This field lists other packages that your project depends on to run. - # Any package you put here will be installed by pip when your project is - # installed, so they must be valid existing projects. - # - # For an analysis of "install_requires" vs pip's requirements files see: - # https://packaging.python.org/en/latest/requirements.html - install_requires=install_requires, # Optional - - # List additional groups of dependencies here (e.g. development - # dependencies). Users will be able to install these using the "extras" - # syntax, for example: - # - # $ pip install sampleproject[dev] - # - # Similar to `install_requires` above, these must be valid existing - # projects. -## extras_require={ # Optional -## 'dev': ['check-manifest'], -## 'test': ['coverage'], -## }, - - # If there are data files included in your packages that need to be - # installed, specify them here. -## package_data={ # Optional -## 'sample': ['package_data.dat'], -## }, - - # Although 'package_data' is the preferred approach, in some case you may - # need to place data files outside of your packages. See: - # http://docs.python.org/distutils/setupscript.html#installing-additional-files - # - # In this case, 'data_file' will be installed into '/my_data' -## data_files=[('my_data', ['data/data_file'])], # Optional - - # To provide executable scripts, use entry points in preference to the - # "scripts" keyword. Entry points provide cross-platform support and allow - # `pip` to create the appropriate form of executable for the target - # platform. - # - # For example, the following would provide a command called `sample` which - # executes the function `main` from this package when invoked: - entry_points={ # Optional - 'console_scripts': [ - 'idlealign=idlealign:check_installed', - ], - }, - - # List additional URLs that are relevant to your project as a dict. - # - # This field corresponds to the "Project-URL" metadata fields: - # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use - # - # Examples listed include a pattern for specifying where the package tracks - # issues, where the source is hosted, where to say thanks to the package - # maintainers, and where to support the project financially. The key is - # what's used to render the link text on PyPI. - project_urls={ # Optional - 'Bug Reports': 'https://github.com/CoolCat467/idlealign/issues', - 'Source': 'https://github.com/CoolCat467/idlealign' - }, -) diff --git a/src/idlealign.egg-info/PKG-INFO b/src/idlealign.egg-info/PKG-INFO index e239fbf..5b431b7 100644 --- a/src/idlealign.egg-info/PKG-INFO +++ b/src/idlealign.egg-info/PKG-INFO @@ -1,24 +1,701 @@ Metadata-Version: 2.1 Name: idlealign -Version: 0.0.1 +Version: 0.1.0 Summary: Emacs Align by Regular Expression for IDLE -Home-page: https://github.com/CoolCat467/idlealign Author: CoolCat467 -License: UNKNOWN -Project-URL: Bug Reports, https://github.com/CoolCat467/idlealign/issues +License: GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for + software and other kinds of works. + + The licenses for most software and other practical works are designed + to take away your freedom to share and change the works. By contrast, + the GNU General Public License is 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. We, the Free Software Foundation, use the + GNU General Public License for most of our software; it applies also to + any other work released this way by its authors. You can apply it to + your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you + these rights or asking you to surrender the rights. Therefore, you have + certain responsibilities if you distribute copies of the software, or if + you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must pass on to the recipients the same + freedoms that you received. You must make sure that they, too, receive + or can get the source code. And you must show them these terms so they + know their rights. + + Developers that use the GNU GPL protect your rights with two steps: + (1) assert copyright on the software, and (2) offer you this License + giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains + that there is no warranty for this free software. For both users' and + authors' sake, the GPL requires that modified versions be marked as + changed, so that their problems will not be attributed erroneously to + authors of previous versions. + + Some devices are designed to deny users access to install or run + modified versions of the software inside them, although the manufacturer + can do so. This is fundamentally incompatible with the aim of + protecting users' freedom to change the software. The systematic + pattern of such abuse occurs in the area of products for individuals to + use, which is precisely where it is most unacceptable. Therefore, we + have designed this version of the GPL to prohibit the practice for those + products. If such problems arise substantially in other domains, we + stand ready to extend this provision to those domains in future versions + of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. + States should not allow patents to restrict development and use of + software on general-purpose computers, but in those that do, we wish to + avoid the special danger that patents applied to a free program could + make it effectively proprietary. To prevent this, the GPL assures that + patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, + section 13, concerning interaction through a network will apply to the + combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of + the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + + Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short + notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + + The hypothetical commands `show w' and `show c' should show the appropriate + parts of the General Public License. Of course, your program's commands + might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see + . + + The GNU General Public License does not permit incorporating your program + into proprietary programs. If your program is a subroutine library, you + may consider it more useful to permit linking proprietary applications with + the library. If this is what you want to do, use the GNU Lesser General + Public License instead of this License. But first, please read + . + +Project-URL: Homepage, https://github.com/CoolCat467/idlealign Project-URL: Source, https://github.com/CoolCat467/idlealign +Project-URL: Bug Tracker, https://github.com/CoolCat467/idlealign/issues Keywords: align,regex,idle,extension,development -Platform: UNKNOWN -Classifier: Development Status :: 3 - Alpha +Classifier: Development Status :: 4 - Beta Classifier: Intended Audience :: Developers -Classifier: Topic :: Software Development :: Build Tools -Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 +Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3 :: Only -Requires-Python: >=3.8, <4 +Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) +Classifier: Operating System :: OS Independent +Classifier: Framework :: IDLE +Classifier: Topic :: Utilities +Classifier: Typing :: Typed +Requires-Python: >=3.8 Description-Content-Type: text/markdown License-File: LICENSE @@ -36,5 +713,3 @@ output: `Config should be good!`. If everything went well, alongside `ZzDummy` there should be and option called `idlealign`. This is where you can configure if idlealign is enabled or not. - - diff --git a/src/idlealign.egg-info/SOURCES.txt b/src/idlealign.egg-info/SOURCES.txt index 108499d..ea54661 100644 --- a/src/idlealign.egg-info/SOURCES.txt +++ b/src/idlealign.egg-info/SOURCES.txt @@ -1,7 +1,6 @@ LICENSE README.md -setup.cfg -setup.py +pyproject.toml src/idlealign/__init__.py src/idlealign.egg-info/PKG-INFO src/idlealign.egg-info/SOURCES.txt diff --git a/src/idlealign.egg-info/entry_points.txt b/src/idlealign.egg-info/entry_points.txt index 4d3a0cd..968077f 100644 --- a/src/idlealign.egg-info/entry_points.txt +++ b/src/idlealign.egg-info/entry_points.txt @@ -1,3 +1,2 @@ [console_scripts] idlealign = idlealign:check_installed - diff --git a/src/idlealign/__init__.py b/src/idlealign/__init__.py index 0ba8ac7..f62a62e 100644 --- a/src/idlealign/__init__.py +++ b/src/idlealign/__init__.py @@ -8,116 +8,136 @@ from __future__ import annotations -__title__ = 'idlealign' -__author__ = 'CoolCat467' -__license__ = 'GPLv3' -__version__ = '0.1.0' +__title__ = "idlealign" +__author__ = "CoolCat467" +__license__ = "GPLv3" +__version__ = "0.1.0" __ver_major__ = 0 __ver_minor__ = 1 __ver_patch__ = 0 -from typing import Any, Optional, cast - import sys +from idlelib import searchengine +from idlelib.config import idleConf +from idlelib.pyshell import PyShellEditorWindow +from idlelib.searchbase import SearchDialogBase from re import Pattern +from tkinter import BooleanVar, Event, TclError, Text, Tk +from tkinter.ttk import Checkbutton, Frame, Label, Radiobutton +from typing import Any, cast -from tkinter import BooleanVar, Event, TclError, Tk, Widget -from tkinter.ttk import Checkbutton, Frame, Label, Radiobutton - -from idlelib import searchengine -from idlelib.config import idleConf -from idlelib.pyshell import PyShellEditorWindow -from idlelib.searchbase import SearchDialogBase def check_installed() -> bool: "Make sure extension installed." # Get list of system extensions - extensions = list(idleConf.defaultCfg['extensions']) + extensions = list(idleConf.defaultCfg["extensions"]) # If this extension not in there, if __title__ not in extensions: # Tell user how to add it to system list. - print(f'{__title__} not in system registered extensions!') - print(f'Please run the following command to add {__title__} to system extensions list.\n') - ex_defaults = idleConf.defaultCfg['extensions'].file + print(f"{__title__} not in system registered extensions!") + print( + f"Please run the following command to add {__title__} to system extensions list.\n" + ) + ex_defaults = idleConf.defaultCfg["extensions"].file # Import this extension (this file), try: module = __import__(__title__) except ModuleNotFoundError: - print(f'{__title__} is not installed!') + print(f"{__title__} is not installed!") return False # Get extension class if hasattr(module, __title__): cls = getattr(module, __title__) # Get extension class keybinding defaults - add_data = '' - if hasattr(cls, 'values'): + add_data = "" + if hasattr(cls, "values"): # Get configuration defaults - values = '\n'.join(f'{key} = {default}' for key, default in cls.values.items()) + values = "\n".join( + f"{key} = {default}" for key, default in cls.values.items() + ) # Add to add_data add_data += f"\n[{__title__}]\n{values}" - if hasattr(cls, 'bind_defaults'): + if hasattr(cls, "bind_defaults"): # Get keybindings data - values = '\n'.join(f'{event} = {key}' for event, key in cls.bind_defaults.items()) + values = "\n".join( + f"{event} = {key}" + for event, key in cls.bind_defaults.items() + ) # Add to add_data add_data += f"\n[{__title__}_cfgBindings]\n{values}" # Make sure line-breaks will go properly in terminal - add_data = add_data.replace('\n', '\\n') + add_data = add_data.replace("\n", "\\n") # Tell them command print(f"echo -e '{add_data}' | sudo tee -a {ex_defaults}") print() else: - print(f'ERROR: Somehow, {__title__} was installed improperly, no {__title__} class '\ - 'found in module. Please report this on github.', file=sys.stderr) + print( + f"ERROR: Somehow, {__title__} was installed improperly, no {__title__} class " + "found in module. Please report this on github.", + file=sys.stderr, + ) sys.exit(1) else: - print(f'Configuration should be good! (v{__version__})') + print(f"Configuration should be good! (v{__version__})") return True return False + def ensure_section_exists(section: str) -> bool: "Ensure section exists in user extensions configuration. Return True if created." - if not section in idleConf.GetSectionList('user', 'extensions'): - idleConf.userCfg['extensions'].AddSection(section) + if not section in idleConf.GetSectionList("user", "extensions"): + idleConf.userCfg["extensions"].AddSection(section) return True return False -def ensure_values_exist_in_section(section: str, values: dict[str, str]) -> bool: - "For each key in values, make sure key exists. If not, create and set to value. "\ - "Return True if created any defaults." + +def ensure_values_exist_in_section( + section: str, values: dict[str, str] +) -> bool: + "For each key in values, make sure key exists. If not, create and set to value. " "Return True if created any defaults." need_save = False for key, default in values.items(): - value = idleConf.GetOption('extensions', section, key, - warn_on_default=False) + value = idleConf.GetOption( + "extensions", section, key, warn_on_default=False + ) if value is None: - idleConf.SetOption('extensions', section, key, default) + idleConf.SetOption("extensions", section, key, default) need_save = True return need_save -def get_search_engine_params(engine: searchengine.SearchEngine) -> dict[str, str | bool]: + +def get_search_engine_params( + engine: searchengine.SearchEngine, +) -> dict[str, str | bool]: "Get current search engine parameters" return { - name: getattr(engine, f'{name}var').get() - for name in ('pat', 're', 'case', 'word', 'wrap', 'back') + name: getattr(engine, f"{name}var").get() + for name in ("pat", "re", "case", "word", "wrap", "back") } -def set_search_engine_params(engine: searchengine.SearchEngine, - data: dict[str, str | bool]) -> None: + +def set_search_engine_params( + engine: searchengine.SearchEngine, data: dict[str, str | bool] +) -> None: "Get current search engine parameters" - for name in ('pat', 're', 'case', 'word', 'wrap', 'back'): + for name in ("pat", "re", "case", "word", "wrap", "back"): if name in data: - getattr(engine, f'{name}var').set(data[name]) + getattr(engine, f"{name}var").set(data[name]) + -class AlignDialog(SearchDialogBase): +class AlignDialog(SearchDialogBase): # type: ignore[misc] "Dialog for aligning by a pattern in text." - title = 'Align Dialog' - icon = 'Align' + title = "Align Dialog" + icon = "Align" needwrapbutton = False - def __init__(self, - root: Tk, - engine: searchengine.SearchEngine, - extension: 'idlealign') -> None: + def __init__( + self, + root: Tk, + engine: searchengine.SearchEngine, + extension: "idlealign", + ) -> None: """Create search dialog for aligning text Uses SearchDialogBase as the basis for the GUI and a @@ -130,17 +150,19 @@ def __init__(self, prev_search_params: Dictionary of search parameters before opening window """ super().__init__(root, engine) - self.insert_tags: Optional[str] = None + self.insert_tags: str | list[str] | tuple[str, ...] = () - self.space_wrap_var = BooleanVar(root, True) # Space wrap alignment pattern? - self.align_side_var = BooleanVar(root, False) # Alignment side var + self.space_wrap_var = BooleanVar( + root, True + ) # Space wrap alignment pattern? + self.align_side_var = BooleanVar(root, False) # Alignment side var self.extension = extension self.global_search_params: dict[str, str | bool] self.search_params: dict[str, str | bool] = { - 'wrap': False, - 'back': False + "wrap": False, + "back": False, } def load_prefs(self) -> None: @@ -153,9 +175,11 @@ def store_prefs(self) -> None: self.search_params = get_search_engine_params(self.engine) set_search_engine_params(self.engine, self.global_search_params) - def open(self, # type: ignore[override] - searchphrase: Optional[str] = None, - insert_tags : Optional[str] = None) -> None: + def open( + self, + searchphrase: str | None = None, + insert_tags: str | list[str] | tuple[str, ...] = (), + ) -> None: """Make dialog visible on top of others and ready to use. Also, highlight the currently selected text. @@ -178,18 +202,13 @@ def open(self, # type: ignore[override] first = first or text.index("insert") last = last or first - if first is None or last is None: - self.bell() - self.store_prefs() - return - super().open(text, searchphrase) self.extension.show_hit(first, last) self.insert_tags = insert_tags - def close(self, event: Event[Any] | None=None) -> None: + def close(self, event: Event[Any] | None = None) -> None: "Close the dialog and remove hit tags." super().close(event) @@ -197,16 +216,16 @@ def close(self, event: Event[Any] | None=None) -> None: self.store_prefs() self.extension.hide_hit() - self.insert_tags = None + self.insert_tags = () - def create_option_buttons(self) -> tuple[Frame, list[tuple[BooleanVar, str]]]: + def create_option_buttons( + self, + ) -> tuple[Frame, list[tuple[BooleanVar, str]]]: "Create option buttons." frame: Frame base_options: list[tuple[BooleanVar, str]] frame, base_options = super().create_option_buttons() - options = [ - (self.space_wrap_var, "Space wrap") - ] + options = [(self.space_wrap_var, "Space wrap")] for var, label in options: btn = Checkbutton(frame, variable=var, text=label) btn.pack(side="left", fill="both") @@ -215,9 +234,9 @@ def create_option_buttons(self) -> tuple[Frame, list[tuple[BooleanVar, str]]]: def create_other_buttons(self) -> tuple[Frame, list[tuple[bool, str]]]: "Override so Search Direction is instead Alignment Side" - frame = self.make_frame('Alignment Side')[0] + frame = self.make_frame("Alignment Side")[0] var = self.align_side_var - others = [(False, 'Left'), (True, 'Right')] + others = [(False, "Left"), (True, "Right")] for val, label in others: btn = Radiobutton(frame, variable=var, value=val, text=label) btn.pack(side="left", fill="both") @@ -253,47 +272,43 @@ def default_command(self, event: Event[Any] | None = None) -> bool: self.bell() return close + def get_whole_line(selection: str, add: int = 0) -> str: "Get whole line of selection (set column to zero) and add to line number" line = searchengine.get_line_col(selection)[0] - return f'{line + add}.0' + return f"{line + add}.0" + # Important weird: If event handler function returns 'break', # then it prevents other bindings of same event type from running. # If returns None, normal and others are also run. -class idlealign:# pylint: disable=invalid-name + +class idlealign: # pylint: disable=invalid-name "Add comments from mypy to an open program." - __slots__ = ( - 'editwin', - 'text' - ) + __slots__ = ("editwin", "text") # Extend the file and format menus. - menudefs = [ - ('format', [ - ('Align Selection', '<>') - ] ) - ] + menudefs = [("format", [("Align Selection", "<>")])] # Default values for configuration file values = { - 'enable' : 'True', - 'enable_editor': 'True', - 'enable_shell' : 'False', + "enable": "True", + "enable_editor": "True", + "enable_shell": "False", } # Default key binds for configuration file bind_defaults = { - 'align-selection': '', + "align-selection": "", } def __init__(self, editwin: PyShellEditorWindow) -> None: "Initialize the settings for this extension." - self.editwin = editwin - self.text: Widget = editwin.text + self.editwin = editwin + self.text: Text = editwin.text - for attrname in (a for a in dir(self) if not a.startswith('_')): - if attrname.endswith('_event'): - bind_name = '_'.join(attrname.split('_')[:-1]).lower() - self.text.bind(f'<<{bind_name}>>', getattr(self, attrname)) + for attrname in (a for a in dir(self) if not a.startswith("_")): + if attrname.endswith("_event"): + bind_name = "_".join(attrname.split("_")[:-1]).lower() + self.text.bind(f"<<{bind_name}>>", getattr(self, attrname)) @property def window(self) -> AlignDialog: @@ -304,7 +319,7 @@ def window(self) -> AlignDialog: def ensure_bindings_exist(cls) -> bool: "Ensure key bindings exist in user extensions configuration. Return True if need to save." need_save = False - section = f'{cls.__name__}_cfgBindings' + section = f"{cls.__name__}_cfgBindings" if ensure_section_exists(section): need_save = True if ensure_values_exist_in_section(section, cls.bind_defaults): @@ -324,30 +339,27 @@ def ensure_config_exists(cls) -> bool: @classmethod def reload(cls) -> None: "Load class variables from the extension settings." -## # Ensure file default values exist so they appear in settings menu -## save = cls.ensure_config_exists() -## if cls.ensure_bindings_exist() or save: -## idleConf.SaveUserCfgFiles() + # # Ensure file default values exist so they appear in settings menu + # save = cls.ensure_config_exists() + # if cls.ensure_bindings_exist() or save: + # idleConf.SaveUserCfgFiles() # For all possible configuration values for key, default in cls.values.items(): # Set attribute of key name to key value from configuration file - if not key in {'enable', 'enable_editor', 'enable_shell'}: + if not key in {"enable", "enable_editor", "enable_shell"}: value = idleConf.GetOption( - 'extensions', - cls.__name__, - key, - default=default + "extensions", cls.__name__, key, default=default ) setattr(cls, key, value) def create_window(self) -> AlignDialog: "Create window" root: Tk - root = self.text._root() + root = self.text._root() # type: ignore[attr-defined] engine: searchengine.SearchEngine = searchengine.get(root) - if not hasattr(engine, '_aligndialog'): + if not hasattr(engine, "_aligndialog"): engine._aligndialog = AlignDialog(root, engine, self) return cast(AlignDialog, engine._aligndialog) @@ -378,18 +390,20 @@ def hide_hit(self) -> None: "Hide hit after show_hit" self.text.tag_remove("hit", "1.0", "end") - def align_selected(self, - pattern: Pattern[str], - space_wrap: bool = True, - align_side: bool = False, - tags: Optional[str] = None) -> bool: + def align_selected( + self, + pattern: Pattern[str], + space_wrap: bool = True, + align_side: bool = False, + tags: str | list[str] | tuple[str, ...] = (), + ) -> bool: "Align selected text by pattern. Side False == left. Return True if should close window." # Get start and end from selection, both are strings of {line}.{col} select_start, select_end = searchengine.get_selection(self.text) # Get full first line till one past end line from selection select_start = get_whole_line(select_start) - grab_end = get_whole_line(select_end, 1) + grab_end = get_whole_line(select_end, 1) # Get the characters from full line selection chars: str = self.text.get(select_start, grab_end) @@ -405,7 +419,7 @@ def align_selected(self, # Regular expression match match = pattern.search(line) - if match is None:# If align pattern not in line, skip line + if match is None: # If align pattern not in line, skip line continue # Get the where alignment pattern starts and ends at @@ -417,19 +431,19 @@ def align_selected(self, # If space wrap is set, wrap alignment text with spaces if space_wrap: - align = f' {align} ' + align = f" {align} " - if not align_side: # If align to left side + if not align_side: # If align to left side # Strip trailing spaces before align but keep indent prefix = prefix.rstrip() - suffix = align + suffix.strip() # Strip extra spaces - else: # If align to right side + suffix = align + suffix.strip() # Strip extra spaces + else: # If align to right side prefix += align.lstrip() suffix = suffix.lstrip() - line_data[idx] = (prefix, suffix) # Remember after we get max + line_data[idx] = (prefix, suffix) # Remember after we get max - sec_start = max(sec_start, len(prefix)) # Update max + sec_start = max(sec_start, len(prefix)) # Update max if not line_data: # There are no lines with selected pattern so stop @@ -452,18 +466,18 @@ def align_selected(self, return False # Add extra blank line because of how insert works - lines.append('') + lines.append("") # Re-get characters to set - chars = '\n'.join(lines) + chars = "\n".join(lines) # This is all one operation - self.text.undo_block_start() + self.text.undo_block_start() # type: ignore[attr-defined] # Replace old text with new aligned text self.text.delete(select_start, grab_end) self.text.insert(select_start, chars, tags) - self.text.undo_block_stop() + self.text.undo_block_stop() # type: ignore[attr-defined] # Select modified area self.show_hit(select_start, select_end) @@ -475,10 +489,11 @@ def align_selection_event(self, event: Event[Any] | None) -> str: self.reload() self.window.open() - return 'break' + return "break" + idlealign.reload() -if __name__ == '__main__': - print(f'{__title__} v{__version__}\nProgrammed by {__author__}.\n') +if __name__ == "__main__": + print(f"{__title__} v{__version__}\nProgrammed by {__author__}.\n") check_installed() diff --git a/src/idlealign/py.typed b/src/idlealign/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..2c23f66 --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +minversion = 3.11.0 +envlist = mypy +isolated_build = true + +[gh-actions] +python = + 3.11: mypy + +[testenv:mypy] +basepython = python3.11 +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements_dev.txt +commands = mypy src