115 refactor search and enhance api (#116)

* Update __init__ file

* Expose __all__ attributes

* Clean imports

* Removed unused import in pipeline

* Update src/monggregate/search/collectors/__init__.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/search/__init__.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/search/__init__.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/search/__init__.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/search/commons/__init__.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/base.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/base.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/monggregate/stages/search/search.py

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

src/monggregate/__init__.py

@@ -4,9 +4,10 @@
 from monggregate.dollar import S, SS
 from monggregate.pipeline import Pipeline
 
+__all__ = ["Expression", "S", "SS", "Pipeline"]
 
 __version__ = "0.21.0"
 __author__ = "Vianney Mixtur"
 __contact__ = "[email protected]"
-__copyright__ = "Copyright © 2022 Vianney Mixtur"
+__copyright__ = "Copyright © 2022-2024 Vianney Mixtur"
 __license__ = "MIT"

src/monggregate/pipeline.py

@@ -10,7 +10,6 @@
 from monggregate.base import BaseModel
 from monggregate.stages import (
     AnyStage,
-    Stage,
     BucketAuto,
     GranularityEnum,
     Bucket,
@@ -35,14 +34,13 @@
     Unset,
     VectorSearch,
 )
-from monggregate.stages.search.base import SearchBase, OperatorLiteral
+from monggregate.stages.search.base import OperatorLiteral
 from monggregate.search.operators import OperatorMap
 from monggregate.search.operators.compound import Compound, ClauseType
 from monggregate.search.collectors.facet import Facet, FacetType
 from monggregate.search.commons import CountOptions, HighlightOptions
 from monggregate.operators import MergeObjects
 from monggregate.dollar import ROOT
-from monggregate.utils import StrEnum
 
 
 

src/monggregate/search/__init__.py

@@ -1 +1,61 @@
-"""Search Package"""
+"""Search Package"""
+
+from monggregate.search.commons import (
+    FuzzyOptions,
+    CountOptions,
+    HighlightOptions,
+    HightlightOutput,
+    CountResults,
+)
+from monggregate.search.collectors import (
+    Facet,
+    Facets,
+    FacetBucket,
+    FacetBuckets,
+    FacetResult,
+    StringFacet,
+    NumericFacet,
+    DateFacet,
+    FacetName,
+)
+from monggregate.search.operators import (
+    Autocomplete,
+    Compound,
+    Equals,
+    Exists,
+    MoreLikeThis,
+    Range,
+    Regex,
+    Text,
+    Wildcard,
+    AnyOperator,
+    OperatorMap,
+)
+
+__all__ = [
+    "FuzzyOptions",
+    "CountOptions",
+    "HighlightOptions",
+    "HightlightOutput",
+    "CountResults",
+    "Facet",
+    "Facets",
+    "FacetBucket",
+    "FacetBuckets",
+    "FacetResult",
+    "StringFacet",
+    "NumericFacet",
+    "DateFacet",
+    "FacetName",
+    "Autocomplete",
+    "Compound",
+    "Equals",
+    "Exists",
+    "MoreLikeThis",
+    "Range",
+    "Regex",
+    "Text",
+    "Wildcard",
+    "AnyOperator",
+    "OperatorMap",
+]

src/monggregate/search/collectors/__init__.py

@@ -22,5 +22,18 @@
     DateFacet,
     Facets,
     # String
-    FacetName, 
+    FacetName,
 )
+
+
+__all__ = [
+    "Facet",
+    "FacetBucket",
+    "FacetBuckets",
+    "FacetResult",
+    "StringFacet",
+    "NumericFacet",
+    "DateFacet",
+    "Facets",
+    "FacetName",
+]

src/monggregate/search/commons/__init__.py

@@ -3,3 +3,11 @@
 from monggregate.search.commons.count import CountOptions, CountResults
 from monggregate.search.commons.fuzzy import FuzzyOptions
 from monggregate.search.commons.highlight import HighlightOptions, HightlightOutput
+
+__all__ = [
+    "CountOptions",
+    "CountResults",
+    "FuzzyOptions",
+    "HighlightOptions",
+    "HightlightOutput",
+]

src/monggregate/stages/search/base.py

@@ -9,11 +9,10 @@
     from typing import Self
 except ImportError:
     from typing_extensions import Self
-
 from monggregate.base import pyd, BaseModel
 from monggregate.stages.stage import Stage
-from monggregate.search.collectors import Facet, Facets
-from monggregate.search.operators import(
+from monggregate.search.collectors import Facet
+from monggregate.search.operators import (
     Autocomplete,
     Compound,
     Equals,

src/monggregate/stages/search/search.py

@@ -68,37 +68,17 @@
                                                        
 """
 
-from datetime import datetime
-from typing import Any, Callable, Literal
 try:
     from typing import Self
 except ImportError:
     from typing_extensions import Self
-
-from monggregate.base import pyd
-from monggregate.stages.stage import Stage
-from monggregate.stages.search.base import SearchConfig, SearchBase
-from monggregate.search.collectors import Facet, Facets
-from monggregate.search.operators import(
-    Autocomplete,
-    Compound,
-    Equals,
-    Exists,
-    MoreLikeThis,
-    Range,
-    Regex,
-    Text,
-    Wildcard,
-    AnyOperator
-)
-from monggregate.search.operators.compound import ClauseType
-from monggregate.search.commons import FuzzyOptions
-
-
-# Classes
+from monggregate.stages.search.base import SearchBase
+
+
+# -----------------------------------------------------
 # -----------------------------------------------------
 class Search(SearchBase):
-    """"Abstraction of MongoDB $search stage that performs a full-text search on the specified field or fields.
+    """ "Abstraction of MongoDB $search stage that performs a full-text search on the specified field or fields.
 
     Attributes:
     -----------

src/monggregate/stages/search/search_meta.py

@@ -63,7 +63,7 @@
 
 """
 
-from monggregate.stages.search.base import SearchConfig, SearchBase
+from monggregate.stages.search.base import SearchBase
 
 
 class SearchMeta(SearchBase):