References

Query

Source code in mongoengine_dsl/mongoengine_dsl.py

class Query:
    def __new__(
        cls, query: str, transform: Dict[str, Callable] = None
    ) -> Union[Q, QCombination]:
        """
        Proxy to build_q()

        Args:
            query: The query string
            transform: key-callable pairs for field data transform, call at build time

        Returns:
            Same as build_q()
        """
        return build_q(query=query, transform=transform)

__new__(query, transform=None)

Proxy to build_q()

Parameters:

Name	Type	Description	Default
query	str	The query string	required
transform	Dict[str, Callable]	key-callable pairs for field data transform, call at build time	None

Returns:

Type	Description
Union[Q, QCombination]	Same as build_q()

Source code in mongoengine_dsl/mongoengine_dsl.py

def __new__(
    cls, query: str, transform: Dict[str, Callable] = None
) -> Union[Q, QCombination]:
    """
    Proxy to build_q()

    Args:
        query: The query string
        transform: key-callable pairs for field data transform, call at build time

    Returns:
        Same as build_q()
    """
    return build_q(query=query, transform=transform)

build_q(query, listener_clazz=Antlr4Listener, **listener_kwargs)

Build mongoengine.Q object from DSL query string

Parameters:

Name	Type	Description	Default
query	str	The query string	required
listener_clazz		Antlr4 walker listener	Antlr4Listener
**listener_kwargs		Antlr4 walker listener params	{}

Returns:

Type	Description
Union[Q, QCombination]	Q object for mongoengine queryset filter

Source code in mongoengine_dsl/mongoengine_dsl.py

def build_q(
    query: str, listener_clazz=Antlr4Listener, **listener_kwargs
) -> Union[Q, QCombination]:
    """
    Build mongoengine.Q object from DSL query string

    Args:
        query: The query string
        listener_clazz: Antlr4 walker listener
        **listener_kwargs: Antlr4 walker listener params

    Returns:
        Q object for mongoengine queryset filter
    """
    in_stream = InputStream(query)

    lexer = MongoEngineDSLLexer(in_stream)
    stream = CommonTokenStream(lexer)
    parser = MongoEngineDSLParser(stream)
    tree = parser.process()

    listener = listener_clazz(**listener_kwargs)
    walker = ParseTreeWalker()
    walker.walk(listener, tree)

    return listener.query

mongoengine_dsl

Query

Source code in mongoengine_dsl/mongoengine_dsl.py

class Query:
    def __new__(
        cls, query: str, transform: Dict[str, Callable] = None
    ) -> Union[Q, QCombination]:
        """
        Proxy to build_q()

        Args:
            query: The query string
            transform: key-callable pairs for field data transform, call at build time

        Returns:
            Same as build_q()
        """
        return build_q(query=query, transform=transform)

__new__(query, transform=None)

Proxy to build_q()

Parameters:

Name	Type	Description	Default
query	str	The query string	required
transform	Dict[str, Callable]	key-callable pairs for field data transform, call at build time	None

Returns:

Type	Description
Union[Q, QCombination]	Same as build_q()

Source code in mongoengine_dsl/mongoengine_dsl.py

def __new__(
    cls, query: str, transform: Dict[str, Callable] = None
) -> Union[Q, QCombination]:
    """
    Proxy to build_q()

    Args:
        query: The query string
        transform: key-callable pairs for field data transform, call at build time

    Returns:
        Same as build_q()
    """
    return build_q(query=query, transform=transform)

build_q(query, listener_clazz=Antlr4Listener, **listener_kwargs)

Build mongoengine.Q object from DSL query string

Parameters:

Name	Type	Description	Default
query	str	The query string	required
listener_clazz		Antlr4 walker listener	Antlr4Listener
**listener_kwargs		Antlr4 walker listener params	{}

Returns:

Type	Description
Union[Q, QCombination]	Q object for mongoengine queryset filter

Source code in mongoengine_dsl/mongoengine_dsl.py

def build_q(
    query: str, listener_clazz=Antlr4Listener, **listener_kwargs
) -> Union[Q, QCombination]:
    """
    Build mongoengine.Q object from DSL query string

    Args:
        query: The query string
        listener_clazz: Antlr4 walker listener
        **listener_kwargs: Antlr4 walker listener params

    Returns:
        Q object for mongoengine queryset filter
    """
    in_stream = InputStream(query)

    lexer = MongoEngineDSLLexer(in_stream)
    stream = CommonTokenStream(lexer)
    parser = MongoEngineDSLParser(stream)
    tree = parser.process()

    listener = listener_clazz(**listener_kwargs)
    walker = ParseTreeWalker()
    walker.walk(listener, tree)

    return listener.query