preparse 1.0.13__tar.gz → 1.0.13.post1.dev0__tar.gz

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/LICENSE.txt

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

preparse-1.0.13.post1.dev0/MANIFEST.in

@@ -0,0 +1 @@
+include src/preparse/tests/*.toml

preparse-1.0.13.post1.dev0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: preparse
+Version: 1.0.13.post1.dev0
+Summary: This project preparses args for further parsing later on.
+Author-email: Johannes <johannes.programming@gmail.com>
+License-Expression: MIT
+Project-URL: Download, https://pypi.org/project/preparse/#files
+Project-URL: Index, https://pypi.org/project/preparse/
+Project-URL: Source, https://github.com/johannes-programming/preparse/
+Project-URL: Website, https://preparse.johannes-programming.online/
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: click<9,>=8.2
+Requires-Dist: cmp3<2,>=1.0
+Requires-Dist: copyable<2,>=1.0
+Requires-Dist: datahold<4,>=3.0
+Requires-Dist: datarepr<2,>=1.1
+Requires-Dist: frozendict<3,>=2.4.7
+Requires-Dist: overloadable<2,>=1.1
+Requires-Dist: setdoc<2,>=1.2.10
+Requires-Dist: tofunc<2,>=1.0
+Dynamic: license-file
+
+========
+preparse
+========
+
+Visit the website `https://preparse.johannes-programming.online/ <https://preparse.johannes-programming.online/>`_ for more information.

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/README.rst

@@ -2,4 +2,4 @@
 preparse
 ========
 
-Visit the website `https://preparse.johannes-programming.online/ <https://preparse.johannes-programming.online/>`_ for more information.
+Visit the website `https://preparse.johannes-programming.online/ <https://preparse.johannes-programming.online/>`_ for more information.

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/docs/v1.0.rst

@@ -1,17 +1,9 @@
 Overview
 --------
 
-The preparse project allows to preparse arguments before the main parsing. 
+The preparse project allows to preparse arguments before the main parsing.
 Its ability to deabbreviate options is especially useful for use with ``click``.
 
-Links
------
-
-- Download: https://pypi.org/project/preparse/#files
-- Index: https://pypi.org/project/preparse/
-- Source: https://github.com/johannes-programming/preparse/
-- Website: https://preparse.johannes-programming.online/
-
 Installation
 ------------
 
@@ -64,8 +56,8 @@ Features
 The PreParser class
 ~~~~~~~~~~~~~~~~~~~
 
-``class preparse.PreParser(*, allowslong: Any = True, allowsshort: Any = True, bundling: Any = Tuning.MAINTAIN, expandsabbr: Any = True, expectsabbr: Any = True, expectsposix: Any = False, optdict: Any = (), prog: Any = None, reconcilesorders: Any = True, special: Any = preparse.Tuning.MAINTAIN, warn: Callable = str)``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``class preparse.PreParser(*, allowslong: Any = True, allowsshort: Any = True, bundling: Any = Tuning.MAINTAIN, expandsabbr: Any = True, expectsabbr: Any = True, expectsposix: Any = False, optdict: Any = (), prog: Any = None, reconcilesorders: Any = True, special: Any = preparse.Tuning.MAINTAIN, warn: Callable[..., Any] = str)``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This class is the centerpiece of the preparse. Its behaviour follows the principles of getopt from C.
 
@@ -112,43 +104,43 @@ This boolean property determines whether the order of arguments to conform to th
 ``optdict: preparse.Optdict``
 """""""""""""""""""""""""""""
 
-This property holds a dict-like object. 
-Its keys are the options. 
-Its values specify ``preparse.Nargs``. 
-Options not found within the dictionary 
-cause a ``preparse.PreparseInvalidOptionWarning`` 
+This property holds a dict-like object.
+Its keys are the options.
+Its values specify ``preparse.Nargs``.
+Options not found within the dictionary
+cause a ``preparse.PreparseInvalidOptionWarning``
 and are then assumed to have no arguments.
 
-``parse_args(args: Optional[Iterable] = None) -> list[str]``
-""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+``parse_args(args: Iterable[Any] | None = None) -> list[str]``
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
-This method is at the core of the class. 
-It returns a preparsed list of arguments. 
-If ``None`` is passed as args then ``sys.argv[1:]`` is used. 
+This method is at the core of the class.
+It returns a preparsed list of arguments.
+If ``None`` is passed as args then ``sys.argv[1:]`` is used.
 If the method is applied repeatedly to a list there will be no changes after the first run.
 
 ``prog: str``
 """""""""""""
 
-This ``str`` property represents the name of the program. 
+This ``str`` property represents the name of the program.
 If the value passed to the property is ``None`` then ``str(sys.argv[0])`` is saved.
 
 ``reconcilesorders: bool``
 """"""""""""""""""""""""""
 
-This boolean property determines whether compatibility with both orders, 
+This boolean property determines whether compatibility with both orders,
 POSIX and the interleaving of options with positonal arguments, should be enforced.
 
 ``reflectClickCommand(cmd: click.Command) -> None``
 """""""""""""""""""""""""""""""""""""""""""""""""""
 
-This method alters the current instance to reflect a ``click.Command`` object. 
+This method alters the current instance to reflect a ``click.Command`` object.
 Concretely the optdict property is changed.
 
 ``reflectClickContext(ctx: click.Context) -> None``
 """""""""""""""""""""""""""""""""""""""""""""""""""
 
-This method alters the current instance to reflect a ``click.Context`` object. 
+This method alters the current instance to reflect a ``click.Context`` object.
 Concretely the prog property is changed.
 
 ``special: preparse.Tuning``
@@ -156,18 +148,18 @@ Concretely the prog property is changed.
 
 This ``preparse.Tuning`` property determines the approach to the special argument ``'--'``.
 
-``todict() -> dict``
-""""""""""""""""""""
+``todict() -> dict[str, Any]``
+""""""""""""""""""""""""""""""
 
 This method a dict representing the current instance.
 
 ``warn: types.FunctionType``
 """"""""""""""""""""""""""""
 
-This property holds a function that is called whenever ``parse_args`` encounters a warning. 
-The warning is given as the only positional arguments. 
-No keyword arguments are given. 
-Its return value is discarded. 
+This property holds a function that is called whenever ``parse_args`` encounters a warning.
+The warning is given as the only positional arguments.
+No keyword arguments are given.
+Its return value is discarded.
 Therefore, ``str`` is used to discard the warnings.
 
 The Click class
@@ -215,7 +207,7 @@ It is designed for ``preparse.PreParser.optdict``.
 The Enums
 ~~~~~~~~~
 
-These classes are subclasses of ``enum.IntEnum``. 
+These classes are subclasses of ``enum.IntEnum``.
 Any value different from ``0`` (meaning no) and ``1`` (meaning yes) is interpreted as ``2`` (meaning intermediate).
 
 ``class preparse.Tuning``
@@ -277,21 +269,29 @@ This class warns about unallowed arguments. This can only happen for long option
 The Tests
 ~~~~~~~~~
 
-``preparse.test() -> unittest.TextTestResult``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``preparse.tests.test() -> unittest.TextTestResult``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This project can be tested through its test function.
 
 .. code-block:: python
 
-    import preparse
-    preparse.test()
+    import preparse.tests
+    preparse.tests.test()
 
 License
 -------
 
 This project is licensed under the MIT License.
 
+Links
+-----
+
+- Download: https://pypi.org/project/preparse/#files
+- Index: https://pypi.org/project/preparse/
+- Source: https://github.com/johannes-programming/preparse/
+- Website: https://preparse.johannes-programming.online/
+
 Impressum
 ---------
 
@@ -300,4 +300,4 @@ Impressum
 - Name: Johannes
 - Email: johannes.programming@gmail.com
 - Homepage: https://www.johannes-programming.online/
-- Gravatar: https://www.johannes-programming.fyi/
+- Gravatar: https://www.johannes-programming.fyi/

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [
-    "setuptools>=64.0",
+    "setuptools>=77.0",
 ]
 
 [project]
@@ -10,7 +10,6 @@ authors = [
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
@@ -31,16 +30,24 @@ dependencies = [
 ]
 description = "This project preparses args for further parsing later on."
 keywords = []
+license = "MIT"
+license-files = [
+    "LICENSE.txt",
+]
 name = "preparse"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.0.13"
-
-[project.license]
-file = "LICENSE.txt"
+version = "1.0.13.post1.dev0"
 
 [project.urls]
 Download = "https://pypi.org/project/preparse/#files"
 Index = "https://pypi.org/project/preparse/"
 Source = "https://github.com/johannes-programming/preparse/"
 Website = "https://preparse.johannes-programming.online/"
+
+[tool.mypy]
+files = [
+    ".",
+]
+python_version = "3.11"
+strict = true

preparse-1.0.13.post1.dev0/src/preparse/__init__.py

@@ -0,0 +1,33 @@
+__all__: list[str] = [
+    "Click",
+    "Nargs",
+    "Optdict",
+    "PreParser",
+    "PreparseAmbiguousOptionWarning",
+    "PreparseInvalidOptionWarning",
+    "PreparseRequiredArgumentWarning",
+    "PreparseUnallowedArgumentWarning",
+    "PreparseWarning",
+    "Tuning",
+    "core",
+    "enums",
+    "test",
+    "tests",
+    "warnings",
+]
+
+from preparse.core import (
+    Click,
+    Nargs,
+    Optdict,
+    PreparseAmbiguousOptionWarning,
+    PreparseInvalidOptionWarning,
+    PreParser,
+    PreparseRequiredArgumentWarning,
+    PreparseUnallowedArgumentWarning,
+    PreparseWarning,
+    Tuning,
+    enums,
+    warnings,
+)
+from preparse.tests import test

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Bundle.py

@@ -1,13 +1,13 @@
-from typing import *
+__all__: list[str] = ["Bundle"]
+
+from typing import Any, Self
 
 import setdoc
 
 from preparse._items.Item import Item
 from preparse._items.Option import Option
 from preparse._utils.dataprop import dataprop
-from preparse.core.enums import *
-
-__all__ = ["Bundle"]
+from preparse.core.enums import Nargs, Tuning
 
 
 class Bundle(Option):
@@ -15,7 +15,7 @@ class Bundle(Option):
     chars: str
     joined: bool
     nargs: Nargs
-    right: Optional[str]
+    right: str | None
 
     __slots__ = ()
 
@@ -25,14 +25,14 @@ class Bundle(Option):
         *,
         chars: str,
         joined: bool = False,
-        right: Optional[str] = None,
+        right: str | None = None,
     ) -> None:
         self.chars = chars
         self.joined = joined
         self.right = right
 
     @classmethod
-    def _split_allowslong(cls: type, chars: str) -> list[str]:
+    def _split_allowslong(cls: type[Self], chars: str) -> list[str]:
         ans: list[str]
         x: str
         ans = list()
@@ -44,7 +44,7 @@ class Bundle(Option):
         return ans
 
     @classmethod
-    def _split_shortonly(cls: type, chars: str) -> list[str]:
+    def _split_shortonly(cls: type[Self], chars: str) -> list[str]:
         ans: list[str]
         x: str
         ans = list()

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Item.py

@@ -1,12 +1,12 @@
+__all__: list[str] = ["Item"]
+
 import abc
-from typing import *
+from typing import Any, Self
 
 import setdoc
 from copyable import Copyable
 
-from preparse.core.enums import *
-
-__all__ = ["Item"]
+from preparse.core.enums import Nargs, Tuning
 
 
 class Item(Copyable):
@@ -21,11 +21,11 @@ class Item(Copyable):
 
     @classmethod
     @abc.abstractmethod
-    def sortkey(cls: type) -> int: ...
+    def sortkey(cls: type[Self]) -> int: ...
 
-    def todict(self: Self) -> dict:
+    def todict(self: Self) -> dict[str, Any]:
         "This method returns a dict representing the current instance."
-        ans: dict
+        ans: dict[str, Any]
         try:
             ans = self._data
         except AttributeError:

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Long.py

@@ -1,23 +1,23 @@
+__all__: list[str] = ["Long"]
+
 import operator
-from typing import *
+from typing import Any, Self, SupportsIndex
 
 import setdoc
 
 from preparse._items.Option import Option
 from preparse._utils.dataprop import dataprop
-from preparse.core.enums import *
-
-__all__ = ["Long"]
+from preparse.core.enums import Nargs, Tuning
 
 
 class Long(Option):
 
     abbr: str
-    abbrlen: Optional[int]
+    abbrlen: int | None
     fullkey: str
     joined: bool
     nargs: Nargs
-    right: Optional[str]
+    right: str | None
 
     __slots__ = ()
 
@@ -25,10 +25,10 @@ class Long(Option):
     def __init__(
         self: Self,
         *,
+        abbrlen: int | None = None,
         fullkey: str,
-        abbrlen: Optional[int] = None,
         joined: bool | str = False,
-        right: Optional[str] = None,
+        right: str | None = None,
     ) -> None:
         self.fullkey = fullkey
         self.abbrlen = abbrlen
@@ -40,7 +40,7 @@ class Long(Option):
         return self.fullkey[: self.abbrlen]
 
     @dataprop
-    def abbrlen(self: Self, x: Optional[SupportsIndex]) -> Optional[int]:
+    def abbrlen(self: Self, x: SupportsIndex | None) -> int | None:
         if x is not None:
             return operator.index(x)
 

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Option.py

@@ -1,18 +1,18 @@
+__all__: list[str] = ["Option"]
+
 import operator
-from typing import *
+from typing import Any, Self, SupportsIndex
 
 from preparse._items.Item import Item
 from preparse._utils.dataprop import dataprop
-from preparse.core.enums import *
-
-__all__ = ["Option"]
+from preparse.core.enums import Nargs, Tuning
 
 
 class Option(Item):
 
     joined: bool
     nargs: Nargs
-    right: Optional[str]
+    right: str | None
 
     __slots__ = ()
 
@@ -28,10 +28,10 @@ class Option(Item):
         return Nargs(x)
 
     @dataprop
-    def right(self: Self, x: Any) -> Optional[str]:
+    def right(self: Self, x: Any) -> str | None:
         if x is not None:
             return str(x)
 
     @classmethod
-    def sortkey(cls: type) -> int:
+    def sortkey(cls: type[Self]) -> int:
         return 0

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Positional.py

@@ -1,12 +1,12 @@
-from typing import *
+__all__: list[str] = ["Positional"]
+
+from typing import Any, Self
 
 import setdoc
 
 from preparse._items.Item import Item
 from preparse._utils.dataprop import dataprop
-from preparse.core.enums import *
-
-__all__ = ["Positional"]
+from preparse.core.enums import Nargs, Tuning
 
 
 class Positional(Item):
@@ -26,7 +26,7 @@ class Positional(Item):
         return self.value == "-" or not self.value.startswith("-")
 
     @classmethod
-    def sortkey(cls: type) -> int:
+    def sortkey(cls: type[Self]) -> int:
         return 2
 
     @dataprop

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/Special.py

@@ -1,9 +1,9 @@
-from typing import *
+__all__: list[str] = ["Special"]
 
-from preparse._items.Item import Item
-from preparse.core.enums import *
+from typing import Self
 
-__all__ = ["Special"]
+from preparse._items.Item import Item
+from preparse.core.enums import Nargs, Tuning
 
 
 class Special(Item):
@@ -14,5 +14,5 @@ class Special(Item):
         return ["--"]
 
     @classmethod
-    def sortkey(cls: type) -> int:
+    def sortkey(cls: type[Self]) -> int:
         return 1

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_items/__init__.py

@@ -1,3 +1,12 @@
+__all__: list[str] = [
+    "Bundle",
+    "Item",
+    "Long",
+    "Option",
+    "Positional",
+    "Special",
+]
+
 from preparse._items.Bundle import Bundle
 from preparse._items.Item import Item
 from preparse._items.Long import Long

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_processing/__init__.py

@@ -1,19 +1,20 @@
-from types import FunctionType
-from typing import *
+__all__: list[str] = ["process"]
 
-from preparse._items import *
-from preparse._processing.deparsing import *
-from preparse._processing.digesting import *
-from preparse._processing.parsing import *
-from preparse._processing.pulling import *
-from preparse._utils import *
-from preparse.core.enums import *
+from collections.abc import Iterable
+from types import FunctionType
+from typing import Any
 
-__all__ = ["process"]
+from preparse._items import Bundle, Item, Long, Option, Positional, Special
+from preparse._processing.deparsing import deparse
+from preparse._processing.digesting import digest
+from preparse._processing.parsing import parse
+from preparse._processing.pulling import pull
+from preparse._utils import dataprop
+from preparse.core.enums import Nargs, Tuning
 
 
 def process(
-    args: Optional[Iterable] = None,
+    args: Iterable[Any] | None = None,
     *,
     allowslong: bool,
     allowsshort: bool,
@@ -21,7 +22,7 @@ def process(
     expandsabbr: bool,
     expectsabbr: bool,
     expectsposix: bool,
-    optdict: dict,
+    optdict: dict[str, Nargs],
     prog: str,
     reconcilesorders: bool,
     special: Tuning,

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_processing/deparsing.py

@@ -1,9 +1,7 @@
-from typing import *
+__all__: list[str] = ["deparse"]
 
 from preparse._items.Item import Item
 
-__all__ = ["deparse"]
-
 
 def deparse(items: list[Item]) -> list[str]:
     ans: list[str]

{preparse-1.0.13 → preparse-1.0.13.post1.dev0}/src/preparse/_processing/digesting.py

@@ -1,4 +1,6 @@
-from typing import *
+__all__: list[str] = ["digest"]
+
+from typing import Any
 
 from preparse._items.Bundle import Bundle
 from preparse._items.Item import Item
@@ -6,10 +8,14 @@ from preparse._items.Long import Long
 from preparse._items.Option import Option
 from preparse._items.Positional import Positional
 from preparse._items.Special import Special
-from preparse.core.enums import *
-from preparse.core.warnings import *
-
-__all__ = ["digest"]
+from preparse.core.enums import Nargs, Tuning
+from preparse.core.warnings import (
+    PreparseAmbiguousOptionWarning,
+    PreparseInvalidOptionWarning,
+    PreparseRequiredArgumentWarning,
+    PreparseUnallowedArgumentWarning,
+    PreparseWarning,
+)
 
 
 def digest(