Skip to content
Open
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
16 changes: 14 additions & 2 deletions cmr/queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -774,17 +774,29 @@ def entry_title(self, entry_title: str) -> Self:

return self

def platform(self, platform: str) -> Self:
def platform(
self,
platform: Union[str, Sequence[str]],
*platforms: str,
) -> Self:
"""
Filter by the satellite platform the granule came from.

:param platform: name of the satellite
:param platform: name(s) of the satellite platform
:returns: self
"""

if not platform:
raise ValueError("Please provide a value for platform")

if platforms:
if not isinstance(platform, str):
raise TypeError(
"Platform must be of type str when providing multiple "
"arguments"
)
platform = [platform, *platforms]

self.params['platform'] = platform
return self

Expand Down
16 changes: 16 additions & 0 deletions tests/test_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,22 @@ def test_platform(self):
self.assertIn("platform", query.params)
self.assertEqual(query.params["platform"], "1B")

def test_multiple_platforms(self):
query = CollectionQuery()

query.platform("Aqua", "Terra")

self.assertIn("platform", query.params)
self.assertEqual(query.params["platform"], ["Aqua", "Terra"])

def test_multiple_platforms_from_list(self):
query = CollectionQuery()

query.platform(["Aqua", "Terra"])

self.assertIn("platform", query.params)
self.assertEqual(query.params["platform"], ["Aqua", "Terra"])

def test_empty_platform(self):
query = CollectionQuery()

Expand Down
16 changes: 16 additions & 0 deletions tests/test_granule.py
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,22 @@ def test_platform(self):
self.assertIn(self.platform, query.params)
self.assertEqual(query.params[self.platform], "1B")

def test_multiple_platforms(self):
query = GranuleQuery()

query.platform("Aqua", "Terra")

self.assertIn(self.platform, query.params)
self.assertEqual(query.params[self.platform], ["Aqua", "Terra"])

def test_multiple_platforms_from_list(self):
query = GranuleQuery()

query.platform(["Aqua", "Terra"])

self.assertIn(self.platform, query.params)
self.assertEqual(query.params[self.platform], ["Aqua", "Terra"])

def test_sort_key(self):
query = GranuleQuery()
# Various sort keys using this as an example
Expand Down