TYPING: more type hints for io.formats.printing #27765
Conversation
simonjayhawkins
added
2/3 Compat
Typing
pandas/io/formats/printing.py
Outdated
| result = str(thing).decode("utf-8", "replace") | ||
|
|
||
| def as_escaped_string( | ||
| thing: object, escape_chars: Optional[EscapeChars] = escape_chars |
There was a problem hiding this comment.
Can you use Any instead of object? Won't change output since this is all green but would be more idiomatic
There was a problem hiding this comment.
Contrast the behavior of Any with the behavior of object. Similar to Any, every type is a subtype of object. However, unlike Any, the reverse is not true: object is not a subtype of every other type.
That means when the type of a value is object, a type checker will reject almost all operations on it, and assigning it to a variable (or using it as a return value) of a more specialized type is a type error.
Use object to indicate that a value could be any type in a typesafe manner. Use Any to indicate that a value is dynamically typed.
https://docs.python.org/3/library/typing.html#the-any-type
object is used here to indicate that a value could be any type in a typesafe manner and reject almost all operations on it.
There was a problem hiding this comment.
In the outer function, thing should be Any since it is dynamically typed. we used hasattr and isinstance introspection. But following previous discussions, refraining from using Any and just leaving untyped.
|
@simonjayhawkins can you merge master? |
done. |
|
Thanks! |
* master: (40 commits) DOC: Fix GL01 and GL02 errors in the docstrings (pandas-dev#27988) Remove Encoding of values in char** For Labels (pandas-dev#27618) TYPING: more type hints for io.formats.printing (pandas-dev#27765) TST: fix compression tests when run without virtualenv/condaenv (pandas-dev#28051) DOC: Start 0.25.2 (pandas-dev#28111) DOC: Fix docstrings lack of punctuation (pandas-dev#28031) DOC: Remove alias for numpy.random.randn from the docs (pandas-dev#28082) DOC: update GroupBy.head()/tail() documentation (pandas-dev#27844) BUG: timedelta merge asof with tolerance (pandas-dev#27650) BUG: Series.rename raises error on values accepted by Series construc… (pandas-dev#27814) Preserve index when setting new column on empty dataframe. (pandas-dev#26471) BUG: Fixed groupby quantile for listlike q (pandas-dev#27827) BUG: iter with readonly values, closes pandas-dev#28055 (pandas-dev#28074) TST: non-strict xfail for period test (pandas-dev#28072) DOC: Update whatsnew (pandas-dev#28073) CI: disable codecov (pandas-dev#28065) CI: Set SHA for codecov upload (pandas-dev#28067) BUG: Correct the previous bug fixing on xlim for plotting (pandas-dev#28059) CI: Add pip dependence explicitly (pandas-dev#28008) DOC: Change document code prun in a row (pandas-dev#28029) ...
xref #27568