MongoEngine / MongoEngine/mongoengine

Fields starting with underscore ignored on to_mongo or to_json call on DynamicDocument

Open
#2,668 2 comments 0 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

Hello, community.

I just realize that any field I define starting with an underscore will NOT be included in the serialization process.

I did some testing and this comes from MongoEngine since if I use the Pymongo collection, I get every field.

Is this a defined behavior? I could not find anything in the documentation about it. Please let me know if I should create an example code.

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

The issue names no source file or test. Start by reproducing serialization of underscore-prefixed fields on DynamicDocument with to_mongo and to_json, then compare the result with the PyMongo collection behavior. Done means establishing whether the omission is intentional and, if not, defining the expected serialized output and a regression check.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb, python
Domain
database
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.