Raphtory icon indicating copy to clipboard operation
Raphtory copied to clipboard

Stubsgen: identify python types of filter operators

Open jbaross-pometry opened this issue 3 months ago • 1 comments

For operators a lot of the python return types are unclear, this includes many of the entries that were previously 'value'

ERROR:raphtory.filter.PropertyFilterOps.contains:Invalid return type 'FilterExpr': Unknown type FilterExpr
WARNING:raphtory.filter.PropertyFilterOps.contains:missing parameter value in docs.
ERROR:raphtory.filter.PropertyFilterOps.contains:parameter PropValue appears in documentation but does not exist.
ERROR:raphtory.filter.PropertyFilterOps.fuzzy_search:Invalid annotation 'usize' for parameter levenshtein_distance: Unknown type usize
ERROR:raphtory.filter.PropertyFilterOps.fuzzy_search:Invalid return type 'FilterExpr': Unknown type FilterExpr
ERROR:raphtory.filter.PropertyFilterOps.is_in:Invalid return type 'FilterExpr': Unknown type FilterExpr
WARNING:raphtory.filter.PropertyFilterOps.is_in:missing parameter values in docs.
ERROR:raphtory.filter.PropertyFilterOps.is_in:parameter list[PropValue] appears in documentation but does not exist.
ERROR:raphtory.filter.PropertyFilterOps.is_none:Invalid return type 'FilterExpr': Unknown type FilterExpr
ERROR:raphtory.filter.PropertyFilterOps.is_not_in:Invalid return type 'FilterExpr': Unknown type FilterExpr
WARNING:raphtory.filter.PropertyFilterOps.is_not_in:missing parameter values in docs.
ERROR:raphtory.filter.PropertyFilterOps.is_not_in:parameter list[PropValue] appears in documentation but does not exist.
ERROR:raphtory.filter.PropertyFilterOps.is_some:Invalid return type 'FilterExpr': Unknown type FilterExpr
ERROR:raphtory.filter.PropertyFilterOps.not_contains:Invalid return type 'FilterExpr': Unknown type FilterExpr
WARNING:raphtory.filter.PropertyFilterOps.not_contains:missing parameter value in docs.
ERROR:raphtory.filter.PropertyFilterOps.not_contains:parameter PropValue appears in documentation but does not exist.
WARNING:raphtory.filter.NodeFilterBuilder.contains:Missing return type annotation
WARNING:raphtory.filter.NodeFilterBuilder.contains:missing parameter value in docs.
ERROR:raphtory.filter.NodeFilterBuilder.contains:parameter str appears in documentation but does not exist.
WARNING:raphtory.filter.NodeFilterBuilder.fuzzy_search:Missing return type annotation
WARNING:raphtory.filter.NodeFilterBuilder.fuzzy_search:missing parameter value in docs.
ERROR:raphtory.filter.NodeFilterBuilder.fuzzy_search:parameter str appears in documentation but does not exist.
WARNING:raphtory.filter.NodeFilterBuilder.is_in:Missing return type annotation
WARNING:raphtory.filter.NodeFilterBuilder.is_in:missing parameter values in docs.
ERROR:raphtory.filter.NodeFilterBuilder.is_in:parameter list[str] appears in documentation but does not exist.
WARNING:raphtory.filter.NodeFilterBuilder.is_not_in:Missing return type annotation
WARNING:raphtory.filter.NodeFilterBuilder.is_not_in:missing parameter values in docs.
ERROR:raphtory.filter.NodeFilterBuilder.is_not_in:parameter list[str] appears in documentation but does not exist.
WARNING:raphtory.filter.NodeFilterBuilder.not_contains:Missing return type annotation
WARNING:raphtory.filter.NodeFilterBuilder.not_contains:missing parameter value in docs.
ERROR:raphtory.filter.NodeFilterBuilder.not_contains:parameter str appears in documentation but does not exist.
ERROR:raphtory.filter.Node.name:Invalid return type 'NodeFilterBuilder': Unknown type NodeFilterBuilder
ERROR:raphtory.filter.Node.node_type:Invalid return type 'NodeFilterBuilder': Unknown type NodeFilterBuilder
WARNING:raphtory.filter.EdgeFilterOp.contains:Missing return type annotation
WARNING:raphtory.filter.EdgeFilterOp.contains:missing parameter value in docs.
ERROR:raphtory.filter.EdgeFilterOp.fuzzy_search:Invalid annotation 'usize' for parameter levenshtein_distance: Unknown type usize
ERROR:raphtory.filter.EdgeFilterOp.fuzzy_search:Invalid return type 'FilterExpr': Unknown type FilterExpr
WARNING:raphtory.filter.EdgeFilterOp.fuzzy_search:missing parameter value in docs.
ERROR:raphtory.filter.EdgeFilterOp.fuzzy_search:parameter prop_value appears in documentation but does not exist.
WARNING:raphtory.filter.EdgeFilterOp.is_in:Missing return type annotation
WARNING:raphtory.filter.EdgeFilterOp.is_in:missing parameter values in docs.
WARNING:raphtory.filter.EdgeFilterOp.is_not_in:Missing return type annotation
WARNING:raphtory.filter.EdgeFilterOp.is_not_in:missing parameter values in docs.
WARNING:raphtory.filter.EdgeFilterOp.not_contains:Missing return type annotation
WARNING:raphtory.filter.EdgeFilterOp.not_contains:missing parameter value in docs.
WARNING:raphtory.filter.EdgeEndpoint.name:Missing documentation
WARNING:raphtory.filter.Edge.dst:Missing documentation
WARNING:raphtory.filter.Edge.src:Missing documentation
WARNING:raphtory.filter.Property.temporal:Missing documentation
WARNING:raphtory.filter.TemporalPropertyFilterBuilder.any:Missing documentation
WARNING:raphtory.filter.TemporalPropertyFilterBuilder.latest:Missing documentation

jbaross-pometry avatar Sep 30 '25 13:09 jbaross-pometry

Note that things in the filter module have to be annotated with filter.Class due to the way the imports are set up in the stubs generation. The reason for this is to avoid clashes between the filter classes that have the same name as the normal classes (such as Node, Edge, etc.). So, to fix the invalid return type FilterExpr problems, replace the return annotation with filter.FilterExpr.

ljeub-pometry avatar Oct 13 '25 07:10 ljeub-pometry