Pometry / Pometry/Raphtory

Stubsgen: identify python types of filter operators

Open
#2,302 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
Rust
Stars
642
Forks
70
Avg merge
2d 13h
Merged PRs (30d)
21

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the stubsgen diagnostics for the raphtory.filter classes listed in the issue, including PropertyFilterOps, NodeFilterBuilder, EdgeFilterOp, Node, EdgeEndpoint, Edge, Property, and TemporalPropertyFilterBuilder. Inspect their Python-facing annotations and documentation; done means the reported unknown, missing, and mismatched types and documentation warnings are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.