BUG: remove single quotes in index names when printing #60251
Conversation
jorisvandenbossche
changed the title
…hedataninja1786/pandas into bugfix--pprint-embedded-quotes
|
pandas/io/formats/printing.py
Outdated
| def as_escaped_string( | ||
| thing: Any, escape_chars: EscapeChars | None = escape_chars | ||
| ) -> str: | ||
| translate = {"\t": r"\t", "\n": r"\n", "\r": r"\r"} | ||
| translate = {"\t": r"\t", "\n": r"\n", "\r": r"\r", "'": ""} |
There was a problem hiding this comment.
I believe this will make the output here:
df = pd.DataFrame({"'a": [1], "b": [2]}).set_index(["'a", "b"])
print(df.index.names)be ['a', 'b']. That is not correct.
There was a problem hiding this comment.
What would be the desired behavior?
There was a problem hiding this comment.
The index names must be accurate, the first being 'a. I would think ['\'a', 'b'].
| (["'test\n'", "b"], ['test\n', 'b']) # Remove quotes, preserve newline | ||
| ] | ||
|
|
||
| for input_names, expected_names in test_cases: |
There was a problem hiding this comment.
Can you use pytest.mark.parametrize instead.
There was a problem hiding this comment.
Looking good! Will need to pass pre-commit.
https://pandas.pydata.org/docs/dev/development/contributing_codebase.html#pre-commit
Also needs a line in the whatsnew for v3.0.0.
| (["'test\n'", "b"], ["\'test\n\'", "b"]) # Escape and preserve newline | ||
| ]) | ||
| def test_formatted_index_names(input_names, expected_names): | ||
| # Create DataFrame with specified index names |
There was a problem hiding this comment.
Can you remove this comment - it repeats the code verbatim and so is not needed.
In addition, can you start the test with a comment referencing the issue:
# GH#60190
There was a problem hiding this comment.
I think we are there now?
…hedataninja1786/pandas into bugfix--pprint-embedded-quotes
doc/source/whatsnew/v3.0.0.rst
Outdated
| @@ -663,9 +663,9 @@ Interval | |||
|
|
|||
| Indexing | |||
| ^^^^^^^^ | |||
| - Bug in :func:`pprint_thing` with ``quote_strings=True`` failing for strings with embedded single quotes (:issue:`60190`) | |||
There was a problem hiding this comment.
pprint_thing is an internal function, the whatsnew is for users of pandas. We need to report on the impact users will notice. Something like Bug in printing :class:`Index` names would not escape single quotes
There was a problem hiding this comment.
Changes have been made
| @@ -663,9 +663,9 @@ Interval | |||
|
|
|||
| Indexing | |||
| ^^^^^^^^ | |||
| - Bug in :class:`Index` printed names do not escape single quotes (:issue:`60190`) | |||
There was a problem hiding this comment.
I do not think :class:`Index` printed names is clear, is there an objection to what I suggested in my previous comment? In any case, perhaps this is better.
Bug in printing :attr:`Index.names` and :attr:`MultiIndex.levels` would not escape single quotes (:issue:`60190`)
I did not realize that this can impact levels previously.
pprint_thing(..., quote_strings=True)fails for strings with embedded single-quotes #60190__str__inFrozenList(frompandas/core/indexes/frozen.py) to escape single quotes and updatedpprint_thinginpandas/io/formats/printing.pyto replace single quotes with an empty string.