Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Convenience functions for filtering

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
api

Research direction

Start by reviewing the existing itersections, iterproperties, and itervalues filter functions and the examples in the issue. The proposed convenience APIs and the generic filter leave operation semantics and template search undecided; done requires an agreed design and an implemented, tested filtering interface.

Written by the indexing model from the issue text.

Description

v1.4

Currently it is possible to filter for specific odML objects using the iter-functions with a lambda function, e.g.:

odmldoc.itersections(filter_func=lambda x: x.name=="SpikeSorting" or x.type=="spikesorting")
odmldoc.iterproperties(filter_func=lambda  x:x.name=="IsSpikeSorted")
odmldoc.itervalues(filter_func=lambda x: x.dtype==odml.DType.boolean and x.parent.name=="IsSpikeSorted")

To optimize the visibility of this functionality it would be nice to have (in addition) convenience functions for filtering (cookie-cutter-filter-functions), e.g. by objects:

odmldoc.filter_sections(name="SpikeSorting", type="spikesorting", operation="or")
odmldoc.filter_properties(name="IsSpikeSorted")
odmldoc.filter_values(dtype=odml.DType.boolean, parent_name="IsSpikeSorted", operation="and")

Or by attributes, e.g.:
odmldoc.filter_by_name("SpikeSorting", exact=True)

Or we even discuss the design of a "generic" filter function, e.g.:
odmldoc.filter(objecttype=["sections", "properties"], **kwords)
The question here is how to handle operations (and vs or) within and between search attributes.

And in addition we could think about a "template"-search.

Dominant language
Python
Stars
25
Forks
30
No merged PRs in 30d

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.

More from G-Node/python-odml

All issues in G-Node/python-odml

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.