Skip to content

Apod

Bases: ApiRequest

Represents a request to the APOD NASA API.

Source code in src\nasa_api\apod.py 
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
class Apod(ApiRequest):
    """
    Represents a request to the APOD NASA API.
    """

    def __init__(self, endpoint: str) -> None:
        """
        Cerates an instance of the Apod class.

        Args:
            endpoint (str): The apod endpoint.
        """
        super().__init__(endpoint)

    @property
    def copyright(self) -> str:
        """
        Copy right info for the request.

        Returns
            str: The copy right info for the request.

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not have
                                      copyright info.
        """
        try:
            return super().request_data["copyright"]
        except KeyError:
            raise NasaApiDataNotFoundError(
                "Request did not contain copyright info.")

    @property
    def date(self) -> str:
        """
        The date that corresponds to the Astronomy Picture of the Day date.

        Returns:
            str: The request APOD date.

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not have a
                                      date.
        """
        try:
            return super().request_data["date"]
        except KeyError:
            raise NasaApiDataNotFoundError("Request did not contain a date.")

    @property
    def explanation(self) -> str:
        """
        An explanation of the image/video that is in the request.

        Returns:
            str: The explanation for the image/video in the request.

        Raises:
            NasaApiDataNotFoundError: Raised when an explanation is not found
                                      in the request.
        """
        try:
            return super().request_data["explanation"]
        except KeyError:
            raise NasaApiDataNotFoundError(
                "Request did not contain an explanation.")

    @property
    def media_type(self) -> str:
        """
        The type of media that the requests contains. Should be an image or
        video.

        Returns:
            str: The type of media in the request.

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not have a
                                      media type.
        """
        try:
            return super().request_data["media_type"]
        except KeyError:
            raise NasaApiDataNotFoundError(
                "Request did not contain a media_type.")

    @property
    def service_version(self) -> str:
        """
        The version of the system that provides the API.

        Returns:
            str: The version of the service that provides the API.

        Raises:
            NasaApiDataNotFoundError: Raised when a service version is not in
                                      the response.
        """
        try:
            return super().request_data["service_version"]
        except KeyError:
            raise NasaApiDataNotFoundError("Request did not contain a service "
                                           "version.")

    @property
    def title(self) -> str:
        """
        The title of the image/video in the request.

        Returns:
            str: The title of the image/video in the request.

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not
                                      contain a title.
        """
        try:
            return super().request_data["title"]
        except KeyError:
            raise NasaApiDataNotFoundError("Request did not contain a title.")

    @property
    def url(self) -> str:
        """
        The URL that points the image/video of the day.

        Returns:
            str: The URL that points to the image/video of the day.

        Raises:
            NasaApiDataNotFoundError: Is raised when the request does not
                                      contain a URL.
        """
        try:
            return super().request_data["url"]
        except KeyError:
            raise NasaApiDataNotFoundError("Request did not contain a url.")

    @property
    def hdurl(self) -> str:
        """
        The URL that links to an HD version of the image in the request.

        Returns:
            str: The URL that links to the HD version of the image in the
                 request.

        Raises:
            NasaApiDataNotFoundError: Is raised if the request does not
                                      contain an HD URL (hdurl in request).
        """
        try:
            return super().request_data["hdurl"]
        except KeyError:
            raise NasaApiDataNotFoundError(
                "Request data did not contain an hdurl. Check if "
                "request has provided a video.")

    def is_video(self) -> bool:
        """
        Checks if the content of the request is a video.

        Returns:
            bool: Returns true if the content is a video.
        """
        return self.media_type == "video"

    def is_image(self) -> bool:
        """
        Checks if the content of the request is an image.

        Returns:
            str: Returns true of the content is an image.
        """
        return self.media_type == "image"

    def download_image(self, file_path: str) -> None:
        """
        Downloads the image from the URL to the specified file path.

        Args:
            file_path (str): The path where the image will be saved.

        Returns: None

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not return
            a status code of 200 or if the request does not contain an image.
        """
        if self.is_image():
            with open(file_path, 'wb') as file:
                response = requests.get(self.url)
                if response.status_code == 200:
                    file.write(response.content)
                else:
                    raise NasaApiDataNotFoundError(
                        f"Failed to download image. Status code: "
                        f"{response.status_code}")
        else:
            raise NasaApiDataNotFoundError("Request does not contain an image.")

    def download_hd_image(self, file_path: str) -> None:
        """
        Downloads the HD image from the URL to the specified file path.

        Args:
            file_path (str): The path where the HD image will be saved.

        Returns: None

        Raises:
            NasaApiDataNotFoundError: Raised when the request does not return
            a status code of 200 or if the request does not contain an image.
        """
        if self.is_image():
            with open(file_path, 'wb') as file:
                response = requests.get(self.hdurl)
                if response.status_code == 200:
                    file.write(response.content)
                else:
                    raise NasaApiDataNotFoundError(
                        f"Failed to download HD image. Status code: "
                        f"{response.status_code}")
        else:
            raise NasaApiDataNotFoundError("Request does not contain an image.")

copyright property

Copy right info for the request.

Returns str: The copy right info for the request.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not have copyright info.

date property

The date that corresponds to the Astronomy Picture of the Day date.

Returns:

Name Type Description
str str

The request APOD date.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not have a date.

explanation property

An explanation of the image/video that is in the request.

Returns:

Name Type Description
str str

The explanation for the image/video in the request.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when an explanation is not found in the request.

hdurl property

The URL that links to an HD version of the image in the request.

Returns:

Name Type Description
str str

The URL that links to the HD version of the image in the request.

Raises:

Type Description
NasaApiDataNotFoundError

Is raised if the request does not contain an HD URL (hdurl in request).

media_type property

The type of media that the requests contains. Should be an image or video.

Returns:

Name Type Description
str str

The type of media in the request.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not have a media type.

service_version property

The version of the system that provides the API.

Returns:

Name Type Description
str str

The version of the service that provides the API.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when a service version is not in the response.

title property

The title of the image/video in the request.

Returns:

Name Type Description
str str

The title of the image/video in the request.

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not contain a title.

url property

The URL that points the image/video of the day.

Returns:

Name Type Description
str str

The URL that points to the image/video of the day.

Raises:

Type Description
NasaApiDataNotFoundError

Is raised when the request does not contain a URL.

__init__(endpoint)

Cerates an instance of the Apod class.

Parameters:

Name Type Description Default
endpoint str

The apod endpoint.

 required
Source code in src\nasa_api\apod.py 
12
13
14
15
16
17
18
19
def __init__(self, endpoint: str) -> None:
    """
    Cerates an instance of the Apod class.

    Args:
        endpoint (str): The apod endpoint.
    """
    super().__init__(endpoint)

download_hd_image(file_path)

Downloads the HD image from the URL to the specified file path.

Parameters:

Name Type Description Default
file_path str

The path where the HD image will be saved.

 required

Returns: None

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not return
Source code in src\nasa_api\apod.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
def download_hd_image(self, file_path: str) -> None:
    """
    Downloads the HD image from the URL to the specified file path.

    Args:
        file_path (str): The path where the HD image will be saved.

    Returns: None

    Raises:
        NasaApiDataNotFoundError: Raised when the request does not return
        a status code of 200 or if the request does not contain an image.
    """
    if self.is_image():
        with open(file_path, 'wb') as file:
            response = requests.get(self.hdurl)
            if response.status_code == 200:
                file.write(response.content)
            else:
                raise NasaApiDataNotFoundError(
                    f"Failed to download HD image. Status code: "
                    f"{response.status_code}")
    else:
        raise NasaApiDataNotFoundError("Request does not contain an image.")

download_image(file_path)

Downloads the image from the URL to the specified file path.

Parameters:

Name Type Description Default
file_path str

The path where the image will be saved.

 required

Returns: None

Raises:

Type Description
NasaApiDataNotFoundError

Raised when the request does not return
Source code in src\nasa_api\apod.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
def download_image(self, file_path: str) -> None:
    """
    Downloads the image from the URL to the specified file path.

    Args:
        file_path (str): The path where the image will be saved.

    Returns: None

    Raises:
        NasaApiDataNotFoundError: Raised when the request does not return
        a status code of 200 or if the request does not contain an image.
    """
    if self.is_image():
        with open(file_path, 'wb') as file:
            response = requests.get(self.url)
            if response.status_code == 200:
                file.write(response.content)
            else:
                raise NasaApiDataNotFoundError(
                    f"Failed to download image. Status code: "
                    f"{response.status_code}")
    else:
        raise NasaApiDataNotFoundError("Request does not contain an image.")

is_image()

Checks if the content of the request is an image.

Returns:

Name Type Description
str bool

Returns true of the content is an image.
Source code in src\nasa_api\apod.py 
174
175
176
177
178
179
180
181
def is_image(self) -> bool:
    """
    Checks if the content of the request is an image.

    Returns:
        str: Returns true of the content is an image.
    """
    return self.media_type == "image"

is_video()

Checks if the content of the request is a video.

Returns:

Name Type Description
bool bool

Returns true if the content is a video.
Source code in src\nasa_api\apod.py 
165
166
167
168
169
170
171
172
def is_video(self) -> bool:
    """
    Checks if the content of the request is a video.

    Returns:
        bool: Returns true if the content is a video.
    """
    return self.media_type == "video"