whitespace-format 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

{whitespace_format-0.0.4.dist-info → whitespace_format-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: whitespace-format
-Version: 0.0.4
+Version: 0.0.5
 Summary: Linter and formatter for source code files and text files
 Home-page: https://github.com/DavidPal/whitespace-format
 License: MIT
@@ -14,6 +14,7 @@ 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.12
 Project-URL: Repository, https://github.com/DavidPal/whitespace-format
 Description-Content-Type: text/markdown
 
@@ -61,17 +62,18 @@ whitespace-format \
     --normalize-new-line-markers \
     foo.txt  my_project/
 ```
-The command above formats `foo.txt` and all files contained `my_project/` and
-its subdirectories. Files that contain `.git/` or `.idea/` in their (relative)
-path are excluded. For example, files in `my_project/.git/` and files in
-`my_project/.idea/` are excluded. Likewise, files ending with `*.pyc` are
-excluded.
-
-If you want only know if any changes **would be** made, add `--check-only` option:
+The command above formats `foo.txt` and all files contained in `my_project/`
+directory and its subdirectories. Files that contain `.git/` or `.idea/` in
+their (relative) path are excluded. For example, files in `my_project/.git/`
+and files in `my_project/.idea/` are excluded. Likewise, files ending with
+`*.pyc` are excluded.
+
+If you want to know only if any changes **would be** made, add `--check-only`
+option:
 ```shell
 whitespace-format \
-    --exclude ".git/|.idea/|.pyc$" \
     --check-only \
+    --exclude ".git/|.idea/|.pyc$" \
     --new-line-marker linux \
     --normalize-new-line-markers \
     foo.txt  my_project/
@@ -96,7 +98,7 @@ The regular expression is evaluated on the path of each file.
 This option is ignored when `--add-new-line-marker-at-end-of-file` is used.
 Empty lines at the end of the file are removed.
 * `--normalize-new-line-markers` -- Make new line markers consistent in each file
-by replacing `\\r\\n`, `\\n`, and `\r` with a consistent new line marker.
+by replacing `\r\n`, `\n`, and `\r` with a consistent new line marker.
 * `--remove-trailing-whitespace` -- Remove whitespace at the end of each line.
 * `--remove-trailing-empty-lines` -- Remove empty lines at the end of each file.
 * `--new-line-marker=MARKER` -- This option specifies what new line marker to use.
@@ -104,9 +106,9 @@ by replacing `\\r\\n`, `\\n`, and `\r` with a consistent new line marker.
   * `auto` -- Use new line marker that is the most common in each individual file.
   If no new line marker is present in the file, Linux `\n` is used.
   This is the default option.
-  * `linux` -- Use Linux new line marker `\\n`.
-  * `mac` -- Use Mac new line marker `\\r`.
-  * `windows` -- Use Windows new line marker `\\r\\n`.
+  * `linux` -- Use Linux new line marker `\n`.
+  * `mac` -- Use Mac new line marker `\r`.
+  * `windows` -- Use Windows new line marker `\r\n`.
 * `--encoding` -- Text encoding for both reading and writing files. Default encoding is `utf-8`.
 List of supported encodings can be found at
 https://docs.python.org/3/library/codecs.html#standard-encodings
@@ -161,7 +163,7 @@ Default value is `-1`.
 
 * `--normalize-non-standard-whitespace=MODE` -- Replace or remove
 non-standard whitespace characters (`\v` and `\f`). `MODE` must be one of the following:
-  * `ignore` -- Leave `\v` and `f` as is. This is the default option.
+  * `ignore` -- Leave `\v` and `\f` as is. This is the default option.
   * `replace` -- Replace any occurrence of `\v` or `\f` with a single space.
   * `remove` -- Remove all occurrences of `\v` and `\f`
 
@@ -181,13 +183,7 @@ MIT
     brew install poetry
     ```
 
-3) Create Python virtual environment with the correct Python version:
-   ```shell
-   make install-python
-   make create-environment
-   ```
-
-4) Add the following lines to `.zshrc` or `.bash_profile` and restart the terminal:
+3) Add the following lines to `.zshrc` or `.bash_profile` and restart the terminal:
    ```shell
    # Pyenv settings
    export PYENV_ROOT="$HOME/.pyenv"
@@ -196,6 +192,12 @@ MIT
    eval "$(pyenv virtualenv-init -)"
    ```
 
+4) Create Python virtual environment with the correct Python version:
+   ```shell
+   make install-python
+   make create-environment
+   ```
+
 5) Install all dependencies
     ```shell
     make install-dependecies

whitespace_format-0.0.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+whitespace_format.py,sha256=uqu0SZ76nyFGEDX6gMIyLZpmVv_rtJRx0IjcEC601Cs,26016
+whitespace_format-0.0.5.dist-info/LICENSE,sha256=rT6UNfWDYFQc-eo65FioDJRMAyVOndtF95wNCUhkK74,1076
+whitespace_format-0.0.5.dist-info/METADATA,sha256=Pq-GTLKbXw9u6uj7CGwItBpi15yDrOdjSyTXVzdnuVU,10233
+whitespace_format-0.0.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+whitespace_format-0.0.5.dist-info/entry_points.txt,sha256=LbXoevzUZAF5MVbI2foNC9xeDjKS_Woz7VbA1ZNF5CY,60
+whitespace_format-0.0.5.dist-info/RECORD,,

{whitespace_format-0.0.4.dist-info → whitespace_format-0.0.5.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

whitespace_format.py

@@ -22,7 +22,7 @@ from typing import Callable
 from typing import Dict
 from typing import List
 
-VERSION = "0.0.4"
+VERSION = "0.0.5"
 
 # Regular expression that does NOT match any string.
 UNMATCHABLE_REGEX = "$."
@@ -72,6 +72,14 @@ def color_print(message: str, parsed_arguments: argparse.Namespace):
     print(message)
 
 
+def string_to_hex(text: str) -> str:
+    """Converts a string into a human-readable hexadecimal representation.
+
+    This function is for debugging purposes only. It is used only during development.
+    """
+    return ":".join(f"{ord(character):02x}" for character in text)
+
+
 def die(error_code: int, message: str = ""):
     """Exits the script."""
     if message:
@@ -82,7 +90,7 @@ def die(error_code: int, message: str = ""):
 def read_file_content(file_name: str, encoding: str) -> str:
     """Reads content of a file."""
     try:
-        with open(file_name, "r", encoding=encoding) as file:
+        with open(file_name, "r", encoding=encoding, newline="") as file:
             return file.read()
     except IOError as exception:
         die(2, f"Cannot read file '{file_name}': {exception}")
@@ -123,6 +131,13 @@ class Line:
                 return Line(line[: -len(end_of_line_marker)], end_of_line_marker)
         return Line(line, "")
 
+    def to_hex(self):
+        """Returns a human-readable hexadecimal representation of the line.
+
+        This function is for debugging purposes only. It is used only during development.
+        """
+        return f"({string_to_hex(self.content)}, {string_to_hex(self.end_of_line_marker)})"
+
 
 def split_lines(text: str) -> List[Line]:
     """Splits a string into lines."""

whitespace_format-0.0.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-whitespace_format.py,sha256=cSM_YnzCNsJjPGz-b9HVINv3TT8YK8C51m5RePwPNCk,25434
-whitespace_format-0.0.4.dist-info/LICENSE,sha256=rT6UNfWDYFQc-eo65FioDJRMAyVOndtF95wNCUhkK74,1076
-whitespace_format-0.0.4.dist-info/METADATA,sha256=Dk2GpHPm2ll_EvKpMxFCP86MCyU49rkYr43wBkZ7D7Q,10172
-whitespace_format-0.0.4.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-whitespace_format-0.0.4.dist-info/entry_points.txt,sha256=LbXoevzUZAF5MVbI2foNC9xeDjKS_Woz7VbA1ZNF5CY,60
-whitespace_format-0.0.4.dist-info/RECORD,,