TYP: Clean up annotations for undocumented elements #1563
Conversation
| class AbstractEngine(metaclass=abc.ABCMeta): | ||
| has_neg_frac: bool = ... | ||
| expr = ... | ||
| aligned_axes = ... | ||
| result_type = ... | ||
| def __init__(self, expr) -> None: ... | ||
| def convert(self) -> str: ... | ||
| def evaluate(self) -> object: ... | ||
|
|
||
| class NumExprEngine(AbstractEngine): | ||
| has_neg_frac: bool = ... | ||
|
|
||
| class PythonEngine(AbstractEngine): | ||
| has_neg_frac: bool = ... |
There was a problem hiding this comment.
These are not documented. Can they be removed?
There was a problem hiding this comment.
I tried to do the minimum to make the ANN pass, we could do a second round of cutting to drop some of the elements that are unused. Open to it
There was a problem hiding this comment.
delete this file. Nothing in here is documented.
loicdiridollou
changed the title
Dr-Irv
left a comment
Dr-Irv
left a comment
There was a problem hiding this comment.
I think most of the files in core/computation can be deleted EXCEPT class Expr in expr.pyi
That ends up being needed by read_hdf so give that a try.
| class AbstractEngine(metaclass=abc.ABCMeta): | ||
| has_neg_frac: bool = ... | ||
| expr = ... | ||
| aligned_axes = ... | ||
| result_type = ... | ||
| def __init__(self, expr) -> None: ... | ||
| def convert(self) -> str: ... | ||
| def evaluate(self) -> object: ... | ||
|
|
||
| class NumExprEngine(AbstractEngine): | ||
| has_neg_frac: bool = ... | ||
|
|
||
| class PythonEngine(AbstractEngine): | ||
| has_neg_frac: bool = ... |
There was a problem hiding this comment.
delete this file. Nothing in here is documented.
| from pandas.core.computation.ops import Term as Term | ||
| from pandas.core.computation.scope import Scope as Scope | ||
|
|
||
| class BaseExprVisitor(ast.NodeVisitor): |
There was a problem hiding this comment.
delete this class. Only referenced in pytables to create other classes that are not documented
| def visit_Compare(self, node, **kwargs: Any): ... | ||
| def visit_BoolOp(self, node, **kwargs: Any): ... | ||
|
|
||
| class Expr: |
There was a problem hiding this comment.
need to keep this one because it is superclass of PyTablesExpr which is same as Term which is arguments for read_hdf()
Now we don't document what Term is, but safer to leave it in for now
| def __init__(self, name, is_local: bool = ...) -> None: ... | ||
| class UndefinedVariableError(NameError): ... | ||
|
|
||
| class Term: |
There was a problem hiding this comment.
I tihnk Term can be deleted
| class Constant(Term): | ||
| @property | ||
| def name(self): ... | ||
| class Constant(Term): ... |
| def name(self): ... | ||
| class Constant(Term): ... | ||
|
|
||
| class Op: |
There was a problem hiding this comment.
I think that this and its subclasses can be deleted
There was a problem hiding this comment.
I think this can be deleted.
There was a problem hiding this comment.
PyTables is used in pandas/io/pytables.pyi so could not delete the file in full but dropped most of it.
There was a problem hiding this comment.
I think this file can be deleted.
There was a problem hiding this comment.
can delete this file as well
There was a problem hiding this comment.
Actually Scope is used in expr file (everything is so spread around this folder).
cmp0xff
left a comment
cmp0xff
left a comment
There was a problem hiding this comment.
I find more places that can be deleted. But if the purpose is just to remove untyped methods, I can approve.
I don't see anything removed that shouldn't be.
Thank you @loicdiridollou !
| def prune(self, klass): ... | ||
| class UnaryOp(ops.UnaryOp): ... | ||
|
|
||
| class PyTablesExprVisitor(BaseExprVisitor): |
There was a problem hiding this comment.
This one isn't referred to anywhere else.
|
|
||
| class UnaryOp(ops.UnaryOp): | ||
| def prune(self, klass): ... | ||
| class UnaryOp(ops.UnaryOp): ... |
There was a problem hiding this comment.
This one isn't referred to anywhere else.
| def format(self): ... | ||
| condition = ... | ||
|
|
||
| class JointConditionBinOp(ConditionBinOp): |
There was a problem hiding this comment.
This one isn't referred to anywhere else.
| class JointFilterBinOp(FilterBinOp): | ||
| def format(self) -> None: ... | ||
|
|
||
| class ConditionBinOp(BinOp): |
There was a problem hiding this comment.
This one isn't referred to anywhere else.
| def format(self): ... | ||
| def generate_filter_op(self, invert: bool = ...): ... | ||
|
|
||
| class JointFilterBinOp(FilterBinOp): |
There was a problem hiding this comment.
This one isn't referred to anywhere else.
| class Constant(Term): | ||
| def __init__(self, name, env: PyTablesScope, side=..., encoding=...) -> None: ... | ||
|
|
||
| class BinOp(ops.BinOp): |
There was a problem hiding this comment.
This one is referred to only in classes that are not referred to. Can also be removed, I believe.
| class Constant(Term): | ||
| @property | ||
| def name(self): ... | ||
| class Constant(Term): ... |
|
Please merge main so we can proceed. |
cmp0xff
left a comment
cmp0xff
left a comment
There was a problem hiding this comment.
I've double checked after merging main.
3 participants
assert_type()to assert the type of any return value)AGENTS.md.