jacobus 2.0.0.dev1__tar.gz → 2.0.2__tar.gz

jacobus-2.0.2/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include docs *.rst
+recursive-include src/jacobus *.toml

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jacobus
-Version: 2.0.0.dev1
+Version: 2.0.2
 Summary: This project normalizes whitespace.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT

jacobus-2.0.2/docs/v1.0.rst

@@ -0,0 +1,77 @@
+Overview
+--------
+
+This project normalizes whitespace.
+
+Installation
+------------
+
+To install this project, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install jacobus
+
+Typing
+------
+
+This project is strictly typed with ``mypy``.
+
+Features
+--------
+
+``jacobus.core``
+''''''''''''''''
+
+The functions in ``jacobus.core`` can also be imported from ``jacobus`` directly.
+
+``main(args: Optional[Iterable[str]] = None, /) -> None``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function is a CLI implementation of ``run``.
+
+``run(root: str, /, *, files: Iterable[str] = (), indent: Optional[int] = None) -> None``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function finds all the files in ``root`` that match one of the patterns of ``files``.
+
+Then, it removes unnecessary whitespace.
+
+Lastly, if an ``indent`` is given, the previous indentation is corrected.
+
+``jacobus.tests``
+'''''''''''''''''
+
+``test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its ``test`` function.
+
+.. code-block:: python
+
+    import jacobus.tests
+    jacobus.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/jacobus/#files
+- Index: https://pypi.org/project/jacobus/
+- Source: https://github.com/johannes-programming/jacobus/
+- Website: https://jacobus.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

jacobus-2.0.2/docs/v2.0.rst

@@ -0,0 +1,77 @@
+Overview
+--------
+
+This project normalizes whitespace.
+
+Installation
+------------
+
+To install this project, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install jacobus
+
+Typing
+------
+
+This project is strictly typed with ``mypy``.
+
+Features
+--------
+
+``jacobus.core``
+''''''''''''''''
+
+The functions in ``jacobus.core`` can also be imported from ``jacobus`` directly.
+
+``main(args: Optional[Iterable[str]] = None, /) -> None``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function is a CLI implementation of ``run``.
+
+``run(filepatterns: Iterable[str] = (), *, indent: Optional[int] = None) -> None``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This function finds all the files that match one of the ``filepatterns``.
+
+Then, it removes unnecessary whitespace.
+
+Lastly, if an ``indent`` is given, the previous indentation is corrected.
+
+``jacobus.tests``
+'''''''''''''''''
+
+``test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its ``test`` function.
+
+.. code-block:: python
+
+    import jacobus.tests
+    jacobus.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/jacobus/#files
+- Index: https://pypi.org/project/jacobus/
+- Source: https://github.com/johannes-programming/jacobus/
+- Website: https://jacobus.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/pyproject.toml

@@ -28,7 +28,7 @@ license-files = [
 name = "jacobus"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "2.0.0.dev1"
+version = "2.0.2"
 
 [project.urls]
 Download = "https://pypi.org/project/jacobus/#files"

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/src/jacobus/core/__init__.py

@@ -83,17 +83,16 @@ def run(
     stream: io.TextIOWrapper
     absfiles = list()
     for pattern in filepatterns:
-        for absfile in map(os.path.abspath, glob.glob(pattern)):
+        for absfile in map(
+            os.path.abspath, glob.iglob(pattern, recursive=True)
+        ):
             if absfile in absfiles:
                 continue
-            absfiles.append(absfile)
+            if os.path.isfile(absfile):
+                absfiles.append(absfile)
     for absfile in absfiles:
         with open(file=absfile, mode="r") as stream:
             lines = stream.readlines()
         lines = go(lines, indent=indent)
         with open(file=absfile, mode="w") as stream:
             stream.writelines(lines)
-
-
-if __name__ == "__main__":
-    main()

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/src/jacobus/tests/__init__.py

@@ -1,5 +1,7 @@
 import unittest
 
+__all__ = ["test"]
+
 
 def test() -> unittest.TextTestResult:
     loader = unittest.TestLoader()

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/src/jacobus/tests/test_jacobus_unittest.py

@@ -1,17 +1,23 @@
 from __future__ import annotations
 
+import os
 import tempfile
 import unittest
 from pathlib import Path
-from typing import Self
+from typing import Any, Self
 
 from jacobus.core import run
 
+__all__ = ["JacobusRunTests"]
+
 
 class JacobusRunTests(unittest.TestCase):
     def test_strips_trailing_whitespace_and_outer_blank_lines(
         self: Self,
     ) -> None:
+        root: Path
+        target: Path
+        tmp: str
         with tempfile.TemporaryDirectory() as tmp:
             root = Path(tmp)
             target = root / "sample.txt"
@@ -19,7 +25,7 @@ class JacobusRunTests(unittest.TestCase):
                 "\n\nalpha   \n\n beta\t\t\n\n", encoding="utf-8"
             )
 
-            run(str(root), files=["*.txt"])
+            run(filepatterns=[os.path.join(tmp, "*.txt")])
 
             self.assertEqual(
                 target.read_text(encoding="utf-8"), "alpha\n\n beta\n"
@@ -28,12 +34,15 @@ class JacobusRunTests(unittest.TestCase):
     def test_rescales_space_indentation_when_indent_is_given(
         self: Self,
     ) -> None:
+        root: Path
+        target: Path
+        tmp: str
         with tempfile.TemporaryDirectory() as tmp:
             root = Path(tmp)
             target = root / "sample.py"
             target.write_text("  alpha\n    beta\nplain\n", encoding="utf-8")
 
-            run(str(root), files=["*.py"], indent=4)
+            run(filepatterns=[os.path.join(tmp, "*.py")], indent=4)
 
             self.assertEqual(
                 target.read_text(encoding="utf-8"),
@@ -41,19 +50,27 @@ class JacobusRunTests(unittest.TestCase):
             )
 
     def test_unmatched_glob_does_not_touch_files(self: Self) -> None:
+        root: Path
+        tmp: str
+        target: Path
+        original: str
         with tempfile.TemporaryDirectory() as tmp:
             root = Path(tmp)
             target = root / "sample.txt"
             original = "alpha   \n"
             target.write_text(original, encoding="utf-8")
 
-            run(str(root), files=["*.py"])
+            run(filepatterns=[os.path.join(tmp, "*.py")])
 
             self.assertEqual(target.read_text(encoding="utf-8"), original)
 
     def test_binary_or_invalid_utf8_file_is_left_unchanged_on_decode_error(
         self: Self,
     ) -> None:
+        original: Any
+        root: Path
+        target: Path
+        tmp: str
         with tempfile.TemporaryDirectory() as tmp:
             root = Path(tmp)
             target = root / "bad.bin"
@@ -61,7 +78,7 @@ class JacobusRunTests(unittest.TestCase):
             target.write_bytes(original)
 
             with self.assertRaises(UnicodeDecodeError):
-                run(str(root), files=["bad.bin"])
+                run(filepatterns=[str(target)])
 
             self.assertEqual(target.read_bytes(), original)
 

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/src/jacobus.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jacobus
-Version: 2.0.0.dev1
+Version: 2.0.2
 Summary: This project normalizes whitespace.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT

{jacobus-2.0.0.dev1 → jacobus-2.0.2}/src/jacobus.egg-info/SOURCES.txt

@@ -3,6 +3,8 @@ MANIFEST.in
 README.rst
 pyproject.toml
 setup.cfg
+docs/v1.0.rst
+docs/v2.0.rst
 src/jacobus/__init__.py
 src/jacobus/__main__.py
 src/jacobus/py.typed

jacobus-2.0.0.dev1/MANIFEST.in

@@ -1 +0,0 @@
-recursive-include src *.toml