Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

119 fix aliases declaration in pipeline methods #120

Merged
merged 2 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions src/monggregate/pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -314,8 +314,7 @@

self.stages.append(
Bucket(
by = by or group_by,

Check warning on line 317 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:317:- by = by or group_by, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:318:- boundaries = boundaries, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:319:- default = default, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:320:- output = output /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:321:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:322:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:323:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:324:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:325:- def bucket_auto(self, *, by:Any=None, group_by:Any=None, buckets:int, output:dict=None, granularity:GranularityEnum|None=None)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:326:+ by=by or group_by, boundaries=boundaries, default=default, output=output /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:327:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:328:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:329:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:330:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:331:+ def bucket_auto( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:332:+ self, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:333:+ *, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:334:+ by: Any = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:335:+ group_by: Any = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:336:+ buckets: int, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:337:+ output: dict = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:338:+ granularity: GranularityEnum | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:339:+ ) -> Self:
#group_by = group_by or by,
boundaries = boundaries,
default = default,
output = output
Expand Down Expand Up @@ -371,8 +370,7 @@

self.stages.append(
BucketAuto(
by = by or group_by,

Check warning on line 373 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:373:- by = by or group_by, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:374:- buckets = buckets, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:375:- output = output, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:376:- granularity = granularity /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:377:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:378:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:379:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:380:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:381:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:382:- def count(self, name:str)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:387:+ by=by or group_by, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:388:+ buckets=buckets, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:389:+ output=output, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:390:+ granularity=granularity, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:391:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:392:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:393:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:394:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:395:+ def count(self, name: str) -> Self:
#group_by = group_by,
buckets = buckets,
output = output,
granularity = granularity
Expand Down Expand Up @@ -437,10 +435,10 @@
"""

self.stages.append(
Unwind(

Check warning on line 438 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:438:- Unwind( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:439:- path_to_array=path_to_array or path, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:440:- include_array_index=include_array_index, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:441:- always=always or preserve_null_and_empty_arrays /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:442:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:443:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:444:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:445:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:446:- def group(self, *, by:Any|None=None, _id:Any|None=None, query:dict={})->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:451:+ Unwind( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:452:+ path_to_array=path_to_array or path, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:453:+ include_array_index=include_array_index, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:454:+ always=always or preserve_null_and_empty_arrays, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:455:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:456:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:457:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:458:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:459:+ def group( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:460:+ self, *, by: Any | None = None, _id: Any | None = None, query: dict = {} /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:461:+ ) -> Self:
path=path,
path_to_array=path_to_array or path,
include_array_index=include_array_index,
always=always
always=always or preserve_null_and_empty_arrays
)
)
return self
Expand All @@ -453,7 +451,7 @@

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[black-format] reported by reviewdog 🐶

Suggested change

Arguments:
------------------------
- by, str | list[str] | set[str] | dict | None : field or group of fields to group by
- by (_id), str | list[str] | set[str] | dict | None : field or group of fields to group by
- query, dict | None : Computed aggregated values (per group)

Online MongoDB documentation:
Expand All @@ -473,9 +471,9 @@
Source : https://www.mongodb.com/docs/manual/reference/operator/aggregation/group/#mongodb-pipeline-pipe.-group
"""

self.stages.append(

Check warning on line 474 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:474:- self.stages.append( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:475:- Group( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:476:- by=by or _id, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:477:- query=query /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:478:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:479:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:480:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:481:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:482:- def limit(self, value:int)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:489:+ self.stages.append(Group(by=by or _id, query=query)) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:490:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:491:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:492:+ def limit(self, value: int) -> Self:
Group(
by=by,
by=by or _id,
query=query
)
)
Expand Down Expand Up @@ -568,9 +566,9 @@
Lookup(
right = right,
on = on,
left_on = left_on,
right_on = right_on,
name =name
left_on = left_on or local_field,
right_on = right_on or foreign_field,
name = name
Comment on lines 567 to +571
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[black-format] reported by reviewdog 🐶

Suggested change
right = right,
on = on,
left_on = left_on,
right_on = right_on,
name =name
left_on = left_on or local_field,
right_on = right_on or foreign_field,
name = name
right=right,
on=on,
left_on=left_on or local_field,
right_on=right_on or foreign_field,
name=name,

)
)
return self
Expand Down Expand Up @@ -712,8 +710,11 @@
"""

query = query | kwargs
self.stages.append(

Check warning on line 713 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:713:- self.stages.append( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:714:- Match( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:715:- query=query, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:716:- expression=expression /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:717:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:718:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:719:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:720:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:721:- def out(self, collection:str|None=None, coll:str|None=None, *, db:str|None=None)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:725:+ self.stages.append(Match(query=query, expression=expression)) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:726:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:727:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:728:+ def out( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:729:+ self, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:730:+ collection: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:731:+ coll: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:732:+ *, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:733:+ db: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:734:+ ) -> Self:
Match(query=query, expression=expression)
Match(
query=query,
expression=expression
)
)
return self

Expand Down Expand Up @@ -797,7 +798,7 @@
-------------------------------------

- statement, dict : the statement generated during instantiation after parsing the other arguments
- path_to_new_root, str|None : the path to the embedded document to be promoted
- path_to_new_root (path), str|None : the path to the embedded document to be promoted
- document, dict|None : document being created and to be set as the new root or expression

Online MongoDB documentation:
Expand All @@ -814,7 +815,10 @@
"""

self.stages.append(
ReplaceRoot(path=path, document=document)
ReplaceRoot(

Check warning on line 818 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:818:- ReplaceRoot( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:819:- path=path or path_to_new_root, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:820:- document=document /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:821:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:822:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:823:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:824:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:825:- def replace_with(self, path:str|None=None, path_to_new_root:str|None=None, *,document:dict|None=None)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:832:+ ReplaceRoot(path=path or path_to_new_root, document=document) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:833:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:834:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:835:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:836:+ def replace_with( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:837:+ self, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:838:+ path: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:839:+ path_to_new_root: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:840:+ *, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:841:+ document: dict | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:842:+ ) -> Self:
path=path or path_to_new_root,
document=document
)
)
return self

Expand All @@ -826,7 +830,7 @@
-------------------------------------

- statement, dict : the statement generated during instantiation after parsing the other arguments
- path_to_new_root, str|None : the path to the embedded document to be promoted
- path_to_new_root (path), str|None : the path to the embedded document to be promoted
- document, dict|None : document being created and to be set as the new root or expression

Online MongoDB documentation:
Expand All @@ -843,7 +847,10 @@
"""

self.stages.append(
ReplaceRoot(path=path, document=document)
ReplaceRoot(

Check warning on line 850 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:850:- ReplaceRoot( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:851:- path=path or path_to_new_root, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:852:- document=document /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:853:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:854:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:855:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:856:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:857:- def sample(self, value:int)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:867:+ ReplaceRoot(path=path or path_to_new_root, document=document) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:868:+ ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:869:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:870:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:871:+ def sample(self, value: int) -> Self:
path=path or path_to_new_root,
document=document
)
)
return self

Expand Down Expand Up @@ -1375,8 +1382,10 @@
Source : https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith/#mongodb-pipeline-pipe.-unionWith
"""

self.stages.append(

Check warning on line 1385 in src/monggregate/pipeline.py

View workflow job for this annotation

GitHub Actions / lint-and-format-backend

[black-format] reported by reviewdog 🐶 Raw Output: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1385:- self.stages.append( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1386:- UnionWith( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1387:- collection=collection or coll, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1388:- pipeline=pipeline) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1389:- ) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1390:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1391:- return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1392:- /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1393:- def unwind(self, \ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1394:- path:str|None=None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1395:- path_to_array:str|None=None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1396:- include_array_index:str|None=None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1397:- always:bool=False, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1398:- preserve_null_and_empty_arrays:bool=False)->Self: /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1398:+ self.stages.append(UnionWith(collection=collection or coll, pipeline=pipeline)) /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1399:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1400:+ return self /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1401:+ /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1402:+ def unwind( /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1403:+ self, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1404:+ path: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1405:+ path_to_array: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1406:+ include_array_index: str | None = None, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1407:+ always: bool = False, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1408:+ preserve_null_and_empty_arrays: bool = False, /home/runner/work/monggregate/monggregate/src/monggregate/pipeline.py:1409:+ ) -> Self:
UnionWith(collection=collection, pipeline=pipeline)
UnionWith(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [mypy] reported by reviewdog 🐶
Unexpected keyword argument "collection" for "UnionWith" [call-arg]

collection=collection or coll,
pipeline=pipeline)
)

return self
Expand Down
2 changes: 1 addition & 1 deletion src/monggregate/stages/group.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ class Group(Stage):

Attributes:
-----------
- by, str | list[str] | set[str] | dict | None : field or group of fields to group by
- by (_id), str | list[str] | set[str] | dict | None : field or group of fields to group by
- query, dict | None : Computed aggregated values (per group)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[black-format] reported by reviewdog 🐶

Suggested change

Online MongoDB documentation:
Expand Down
2 changes: 1 addition & 1 deletion src/monggregate/stages/replace_root.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class ReplaceRoot(Stage):
-----------

- statement, dict : the statement generated during instantiation after parsing the other arguments
- path_to_new_root, str|None : the path to the embedded document to be promoted
- path_to_new_root (path), str|None : the path to the embedded document to be promoted
- document, dict|None : document being created and to be set as the new root or expression

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[black-format] reported by reviewdog 🐶

Suggested change

Online MongoDB documentation:
Expand Down
Loading