cpendery / asort Goto Github PK

INDEX_TEMPLATE = """ loses the whitespace on the right side of the equal sign where it is the start of a multi line string

On empty lines or lines that have multiline strings, extra whitespace is incorrectly added to the file. 1 space for newlines and many newline characters for the multiline strings; however, asort does not even report that the file has been changed. Occurring when using it as a pre-commit hook

Let's say I have the following __all__ already set:

$ cat ./__init__.py

from click import *
from cloup import *

__all__ = [
    "Argument",
    "argument",
    "BOOL",
    "Choice",
    "clear",
    "ClickException",
    "color_option",
    "ColorOption",
    ...
]

When running asort 0.1.3, I get the following results:

$ poetry run python -m pip install asort
Collecting asort
  Downloading asort-0.1.3-py3-none-any.whl (9.8 kB)
Installing collected packages: asort
Successfully installed asort-0.1.3

$ poetry run asort ./__init__.py

$ cat ./__init__.py

from click import *
from cloup import *

__all__ = [
    "Argument",
    "BOOL",
    "Choice",
    "ClickException",
    "ColorOption",
    "argument",
    "clear",
    "color_option",
    ...
]

You can see above how all title-cased and upper-cased strings bubble up at the top of the list. This is normal as it is the natural order of sorted strings in Python.

What I would like to have is a parameter or a configuration option so I can instead have the elements of the __all__ list sorted regardless of the case. I.e., in the case I presented here, I expect the __all__ to look like this:

__all__ = [
    "Argument",
    "argument",
    "BOOL",
    "Choice",
    "clear",
    "ClickException",
    "color_option",
    "ColorOption",
    ...
]

My main motivation to have this flavour of sorting is so I can visually inspect that for each of my main classe (like Argument), I have a corresponding decorator (the lower-cased argument) publicly available at the root of my library.

Given the following minimal python code:

$ cat ./asort_indention.py

class Group:

    platform_ids: frozenset[str] = field(default_factory=frozenset)
    """Set of platform IDs that belong to this group.

    Used to test platform overlaps between groups.
    """

Passing that code above to asort is introducing bad docstring indention:

$ poetry run python -m pip install asort
Collecting asort
  Downloading asort-0.1.3-py3-none-any.whl (9.8 kB)
Installing collected packages: asort
Successfully installed asort-0.1.3

$ poetry run asort ./asort_indention.py

$ cat ./asort_indention.py

class Group:

    platform_ids: frozenset[str] = field(default_factory=frozenset)
"""Set of platform IDs that belong to this group.

    Used to test platform overlaps between groups.
    """