MongoEngine / MongoEngine/mongoengine

Better error message than 'InvalidQueryError: Cannot resolve field "x"' when x contains '.'

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

Nobody has claimed this yet.

Dominant language
Python
Stars
4.3k
Forks
1.2k
Avg merge
4h 41m
Merged PRs (30d)
11

Description

Since document fields can't contain '.', and trying to query using objects(**{"a.b":"c"} is a common mistake, MongoEngine should give a more helpful error when failing to resolve a field that appears to contain a '.', informing the user of the Mongoengine form objects(a__b="c").

Actually, if MongoEngine could just auto-convert queries of the first form into the second form it would be best.

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 by tracing where InvalidQueryError is raised when a query field contains a dot, then inspect the query-resolution path and existing error tests. The issue's desired outcome is either a clearer message showing the MongoEngine form objects(a__b="c") or automatic conversion from objects(**{"a.b":"c"}); confirm which behavior is acceptable before considering the work done.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb, python
Domain
databases
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.