72 expressions improvements (#117)

* Renamed statement as expression

* Renamed expression as operand

* Renamed resolve as express

* expression -> operand

* follow up

* Fixed tests

* Added mypy.ini and updated gitignore

* Replaced old dict typehints by Expression

* Follow up

* Replaced dict typehint by Expression in operators

* Follow up for search operators

* FIXME : Fix lookup, join, right join and associated tests following collection removal in pipeline

* Removed right joins

* Removed old expressions module

* Fixed test

Author: VianneyMI

.gitignore

@@ -1,5 +1,6 @@
 venv
 .venv
+.coverage
 .env
 notes.md
 **/*~

docs/index.md

@@ -127,7 +127,7 @@ import os
 
 from dotenv import load_dotenv 
 import pymongo
-from monggregate import Pipeline, S, Expression
+from monggregate import Pipeline, S
 
 # Creating connexion string securely
 load_dotenv(verbose=True)
@@ -142,8 +142,7 @@ client = pymongo.MongoClient(MONGODB_URI)
 db = client["sample_mflix"]
 
 # Using expressions
-comments_count = Expression.field("comments").size()
-
+comments_count = S.size(S.comments)
 
 # Creating the pipeline
 pipeline = Pipeline()

mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+show_column_numbers = True
+implicit_optional = False
+disallow_untyped_defs = True
+disallow_untyped_calls = True
+follow_imports = silent
+ignore_missing_imports = True
+plugins = pydantic.mypy
+explicit_package_bases = True

readme.md

@@ -127,7 +127,7 @@ import os
 
 from dotenv import load_dotenv 
 import pymongo
-from monggregate import Pipeline, S, Expression
+from monggregate import Pipeline, S
 
 # Creating connexion string securely
 load_dotenv(verbose=True)
@@ -142,8 +142,7 @@ client = pymongo.MongoClient(MONGODB_URI)
 db = client["sample_mflix"]
 
 # Using expressions
-comments_count = Expression.field("comments").size()
-
+comments_count = S.size(S.comments)
 
 # Creating the pipeline
 pipeline = Pipeline()

src/monggregate/__init__.py

@@ -1,10 +1,9 @@
 """App Package"""
 
-from monggregate.expressions import Expression
 from monggregate.dollar import S, SS
 from monggregate.pipeline import Pipeline
 
-__all__ = ["Expression", "S", "SS", "Pipeline"]
+__all__ = ["Pipeline", "S", "SS"]
 
 __version__ = "0.21.0"
 __author__ = "Vianney Mixtur"

src/monggregate/_run.py

@@ -8,14 +8,15 @@
 #----------------------------
 from abc import ABC, abstractmethod
 from typing import Any, TypeGuard
+from typing_extensions import Self
 
 
 # 3rd Party imports
 # ---------------------------
 try:
     import pydantic.v1 as pyd
 except ModuleNotFoundError:
-    import pydantic as pyd
+    import pydantic as pyd # type: ignore[no-redef]
 
 
 from humps.main import camelize
@@ -24,32 +25,39 @@ class Singleton:
     """Singleton metaclass"""
 
     _instance = None
-    def __new__(cls, *args, **kwargs):
+    def __new__(cls, *args:Any, **kwargs:Any)->Self:
         if not isinstance(cls._instance, cls):
             cls._instance = object.__new__(cls, *args, **kwargs)
         return cls._instance
+    
+Expression = dict[str, Any]
 
 class BaseModel(pyd.BaseModel, ABC):
     """Mongreggate base class"""
 
+    def to_expression(self)->Expression|list[Expression]:
+        """Converts an instance of a class inheriting from BaseModel to an expression"""
+
+        return self.express(self)
+
     @classmethod
-    def resolve(cls, obj:Any)->dict|list[dict]:
+    def express(cls, obj:Any)->Expression|list[Expression]:
         """Resolves an expression encapsulated in an object from a class inheriting from BaseModel"""
 
-        return resolve(obj)
+        return express(obj)
 
     @property
     @abstractmethod
-    def statement(self)->dict:
+    def expression(self)->Expression:
         """Stage statement absctract method"""
 
         # this is a lazy attribute
         # what is currently in generate statement should go in here
 
-    def __call__(self)->dict:
+    def __call__(self)->Expression|list[Expression]:
         """Makes an instance of any class inheriting from this class callable"""
 
-        return self.resolve(self.statement)
+        return self.to_expression()
 
     class Config(pyd.BaseConfig):
         """Base configuration for classes inheriting from this"""
@@ -65,25 +73,25 @@ def isbasemodel(instance:Any)->TypeGuard[BaseModel]:
 
     return isinstance(instance, BaseModel)
 
-def resolve(obj:Any)->dict|list[dict]:
+def express(obj:Any)->dict|list[dict]:
         """Resolves an expression encapsulated in an object from a class inheriting from BaseModel"""
 
         if isbasemodel(obj):
-            output:dict|list = obj.statement
+            output:dict|list = obj.expression
         elif isinstance(obj, list) and any(map(isbasemodel, obj)):
             output = []
             for element in obj:
                 if isinstance(element, BaseModel):
-                    output.append(element.statement)
+                    output.append(element.expression)
                 else:
                     output.append(element)
         elif isinstance(obj, dict):
             output = {}
             for key, value in obj.items():
                 if isinstance(value, BaseModel):
-                    output[key] = value.statement
+                    output[key] = value.expression
                 else:
-                    output[key] = resolve(value)
+                    output[key] = express(value)
         else:
             output = obj