Brings JPEG2000 endpoints to Facade

hvpy/api_groups/jpeg2000/get_jp2_header.py

@@ -9,6 +9,7 @@ class getJP2HeaderInputParameters(HvpyParameters):
 
     Attributes
     ----------
+    {Shared}
     id : int
         Unique JP2 image identifier.
     callback : str, optional
@@ -17,6 +18,7 @@ class getJP2HeaderInputParameters(HvpyParameters):
     References
     ----------
     * `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjp2header>`__
+    {Shared}
     """
 
     id: int

hvpy/api_groups/jpeg2000/get_jp2_image.py

@@ -10,9 +10,9 @@ class getJP2ImageInputParameters(HvpyParameters):
     """
     Handles the input parameters of the getJP2Image API.
 
-    {Shared}
     Attributes
     ----------
+    {Shared}
     date : datetime.datetime
         Desired date/time of the JP2 image.
     sourceId : int

hvpy/api_groups/jpeg2000/get_jpx.py

@@ -13,9 +13,10 @@ class getJPXInputParameters(HvpyParameters):
 
     Attributes
     ----------
-    startTime : datetime
+    {Shared}
+    startTime : datetime.datetime
         Date/Time for the beginning of the JPX movie data.
-    endTime : datetime
+    endTime : datetime.datetime
         Date/Time for the end of the JPX movie data.
     sourceId : int
         Unique image datasource identifier.
@@ -31,6 +32,7 @@ class getJPXInputParameters(HvpyParameters):
     References
     ----------
     * `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjpx>`__
+    {Shared}
     """
 
     startTime: datetime

hvpy/api_groups/jpeg2000/get_jpx_closest_to_mid_point.py

@@ -13,9 +13,10 @@ class getJPXClosestToMidPointInputParameters(HvpyParameters):
 
     Attributes
     ----------
-    startTimes : datetime
+    {Shared}
+    startTimes : datetime.datetime
         Comma separated timestamps for the beginning of the JPX movie data.
-    endTimes : datetime
+    endTimes : datetime.datetime
         Comma separated timestamps for the end of the JPX movie data.
     sourceId : int
         Unique image datasource identifier.
@@ -29,6 +30,7 @@ class getJPXClosestToMidPointInputParameters(HvpyParameters):
     References
     ----------
     * `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getjpxclosesttomidpoint>`__
+    {Shared}
     """
 
     startTimes: List[datetime]

hvpy/api_groups/jpeg2000/get_status.py

@@ -3,12 +3,13 @@
 
 class getStatusInputParameters(HvpyParameters):
     """
-    Returns information about how far behind the latest available JPEG2000
-    images.
+    handles the input parameters of the getStatus API.
 
+    {Shared}
     References
     ----------
     * `<https://api.helioviewer.org/docs/v2/api/api_groups/jpeg2000.html#getstatus>`__
+    {Shared}
     """
 
     def get_output_type(self) -> OutputType:

hvpy/api_groups/jpeg2000/tests/test_get_jp2_header.py

@@ -1,26 +1,23 @@
 import pytest
-from pydantic import ValidationError
 
+from hvpy import getJP2Header
 from hvpy.api_groups.jpeg2000.get_jp2_header import getJP2HeaderInputParameters
-from hvpy.core import execute_api_call
 
 
 def test_getJP2HeaderInputParameters():
-    params = getJP2HeaderInputParameters(id=9838343)
-    response = execute_api_call(input_parameters=params)
+    response = getJP2Header(id=9838343)
     assert isinstance(response, str)
     assert response.startswith("<?xml")
     assert response.endswith("</meta>")
 
-    params = getJP2HeaderInputParameters(id=9838343, callback="my_callback")
-    response = execute_api_call(input_parameters=params)
+    response = getJP2Header(id=9838343, callback="my_callback")
     assert isinstance(response, str)
     assert response.startswith("my_callback(")
 
 
 def test_error_handling():
-    with pytest.raises(ValidationError, match="getJP2HeaderInputParameters\nid\n  field required"):
-        getJP2HeaderInputParameters(callback="my_callback")
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'id'"):
+        getJP2Header(callback="my_callback")
 
 
 def test_url_property():

hvpy/api_groups/jpeg2000/tests/test_get_jpx.py

@@ -1,14 +1,13 @@
 from datetime import datetime
 
 import pytest
-from pydantic import ValidationError
 
+from hvpy import getJPX
 from hvpy.api_groups.jpeg2000.get_jpx import getJPXInputParameters
-from hvpy.core import execute_api_call
 
 
 def test_raw_response():
-    params = getJPXInputParameters(
+    response = getJPX(
         startTime=datetime(2014, 1, 1, 0, 0, 0),
         endTime=datetime(2014, 1, 1, 0, 45, 0),
         sourceId=14,
@@ -17,12 +16,11 @@ def test_raw_response():
         jpip=False,
         cadence=None,
     )
-    response = execute_api_call(params)
     assert isinstance(response, bytes)
 
 
 def test_str_response():
-    params = getJPXInputParameters(
+    response = getJPX(
         startTime=datetime(2014, 1, 1, 0, 0, 0),
         endTime=datetime(2014, 1, 1, 0, 45, 0),
         sourceId=14,
@@ -31,13 +29,12 @@ def test_str_response():
         jpip=True,
         cadence=None,
     )
-    response = execute_api_call(params)
     assert isinstance(response, str)
     assert response.startswith("jpip://")
 
 
 def test_json_response():
-    params = getJPXInputParameters(
+    response = getJPX(
         startTime=datetime(2014, 1, 1, 0, 0, 0),
         endTime=datetime(2014, 1, 1, 0, 45, 0),
         sourceId=14,
@@ -46,11 +43,10 @@ def test_json_response():
         jpip=True,
         cadence=None,
     )
-    response = execute_api_call(params)
     assert isinstance(response, dict)
     assert response["uri"].startswith("jpip://")
 
-    params = getJPXInputParameters(
+    response = getJPX(
         startTime=datetime(2014, 1, 1, 0, 0, 0),
         endTime=datetime(2014, 1, 1, 0, 45, 0),
         sourceId=14,
@@ -59,20 +55,17 @@ def test_json_response():
         jpip=False,
         cadence=None,
     )
-    response = execute_api_call(params)
     assert isinstance(response, dict)
     assert response["uri"].startswith("https://")
 
 
 def test_error_handling():
-    with pytest.raises(ValidationError, match="getJPXInputParameters\nstartTime\n  field required"):
-        getJPXInputParameters(endTime=datetime(2014, 1, 1, 0, 45, 0), sourceId=14)
-
-    with pytest.raises(ValidationError, match="getJPXInputParameters\nendTime\n  field required"):
-        getJPXInputParameters(startTime=datetime(2014, 1, 1, 0, 0, 0), sourceId=14)
-
-    with pytest.raises(ValidationError, match="getJPXInputParameters\nsourceId\n  field required"):
-        getJPXInputParameters(startTime=datetime(2014, 1, 1, 0, 0, 0), endTime=datetime(2014, 1, 1, 0, 45, 0))
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'startTime'"):
+        getJPX(endTime=datetime(2014, 1, 1, 0, 45, 0), sourceId=14)
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'endTime'"):
+        getJPX(startTime=datetime(2014, 1, 1, 0, 0, 0), sourceId=14)
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'sourceId'"):
+        getJPX(startTime=datetime(2014, 1, 1, 0, 0, 0), endTime=datetime(2014, 1, 1, 0, 45, 0))
 
 
 def test_url_property():

hvpy/api_groups/jpeg2000/tests/test_get_jpx_closest_to_mid_point.py

@@ -1,57 +1,50 @@
 from datetime import datetime
 
 import pytest
-from pydantic import ValidationError
 
+from hvpy import getJPXClosestToMidPoint
 from hvpy.api_groups.jpeg2000.get_jpx_closest_to_mid_point import getJPXClosestToMidPointInputParameters
-from hvpy.core import execute_api_call
 
 startTimes = [datetime(2014, 1, 1, 0, 0, 0), datetime(2014, 1, 1, 2, 3, 3), datetime(2014, 1, 1, 4, 5, 5)]
 endTimes = [datetime(2014, 1, 1, 0, 45, 0), datetime(2014, 1, 1, 2, 33, 3), datetime(2014, 1, 1, 4, 54, 5)]
 
 
 def test_raw_response():
-    params = getJPXClosestToMidPointInputParameters(
+    response = getJPXClosestToMidPoint(
         startTimes=startTimes, endTimes=endTimes, sourceId=14, linked=False, verbose=False, jpip=False
     )
-    response = execute_api_call(input_parameters=params)
     assert isinstance(response, bytes)
 
 
 def test_str_response():
-    params = getJPXClosestToMidPointInputParameters(
+    response = getJPXClosestToMidPoint(
         startTimes=startTimes, endTimes=endTimes, sourceId=14, linked=False, verbose=False, jpip=True
     )
-    response = execute_api_call(input_parameters=params)
     assert isinstance(response, str)
     assert response.startswith("jpip://")
 
 
 def test_json_response():
-    params = getJPXClosestToMidPointInputParameters(
+    response = getJPXClosestToMidPoint(
         startTimes=startTimes, endTimes=endTimes, sourceId=14, linked=False, verbose=True, jpip=True
     )
-    response = execute_api_call(input_parameters=params)
     assert isinstance(response, dict)
     assert response["uri"].startswith("jpip://")
 
-    params = getJPXClosestToMidPointInputParameters(
+    response = getJPXClosestToMidPoint(
         startTimes=startTimes, endTimes=endTimes, sourceId=14, linked=False, verbose=True, jpip=False
     )
-    response = execute_api_call(input_parameters=params)
     assert isinstance(response, dict)
     assert response["uri"].startswith("https://")
 
 
 def test_error_handling():
-    with pytest.raises(ValidationError, match="getJPXClosestToMidPointInputParameters\nstartTimes\n  field required"):
-        getJPXClosestToMidPointInputParameters(endTimes=endTimes, sourceId=14)
-
-    with pytest.raises(ValidationError, match="getJPXClosestToMidPointInputParameters\nendTimes\n  field required"):
-        getJPXClosestToMidPointInputParameters(startTimes=startTimes, sourceId=14)
-
-    with pytest.raises(ValidationError, match="getJPXClosestToMidPointInputParameters\nsourceId\n  field required"):
-        getJPXClosestToMidPointInputParameters(startTimes=startTimes, endTimes=endTimes)
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'startTimes'"):
+        getJPXClosestToMidPoint(endTimes=endTimes, sourceId=14)
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'endTimes'"):
+        getJPXClosestToMidPoint(startTimes=startTimes, sourceId=14)
+    with pytest.raises(TypeError, match="missing 1 required positional argument: 'sourceId'"):
+        getJPXClosestToMidPoint(startTimes=startTimes, endTimes=endTimes)
 
 
 def test_url_property():

hvpy/api_groups/jpeg2000/tests/test_get_status.py

@@ -1,10 +1,9 @@
+from hvpy import getStatus
 from hvpy.api_groups.jpeg2000.get_status import getStatusInputParameters
-from hvpy.core import execute_api_call
 
 
 def test_getStatusInputParameters():
-    params = getStatusInputParameters()
-    response = execute_api_call(input_parameters=params)
+    response = getStatus()
     assert isinstance(response, dict)