Skip to content

APOD

Bases: GroupCog

Source code in src\cogs\apod.py 
 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
class APOD(commands.GroupCog, name="apod"):
    # Creates the time object for the daily post.
    time = datetime.time(
        hour=int(Config().get_unique_item("hour")),
        minute=int(Config().get_unique_item("minute")),
        tzinfo=datetime.timezone.utc
    )

    def __init__(self, bot: commands.Bot):
        """
        Creates an instance of the APOD class.

        Args:
            bot (discord.ext.commands.Bot): The bot that the cog is being
                                            added to.
        """
        try:
            config = Config()
            self.channel = config.get_unique_item("apod_channel")
            self.endpoint = config.get_unique_item("apod_url")
        except Exception as e:
            nasa_bot_logger.exception(e)
        self.post_daily_image.start()
        self.bot = bot
        self.temp_dir = tempfile.TemporaryDirectory(prefix="apod-images-cache-")
        self.temp_file_name = self.temp_dir.name
        self.apod_image_file = (f"{self.temp_file_name}/"
                                f"apod-{datetime.date.today()}.jpg")

    @app_commands.command(name="daily_image",
                          description="Posts the Astronomy picture of the day.")
    async def daily_image(self, interaction: discord.Interaction) -> None:
        """
        Posts the daily APOD image to discord.

        Args:
            interaction (discord.Interaction): Represents the interaction
                                               with discord.
        """

        await interaction.response.defer()
        apod = Apod(self.endpoint)
        if apod.is_video():
            try:
                await interaction.response.send_message(apod.url)
            except Exception as e:
                nasa_bot_logger.exception(e)
        else:
            image_description = apod.explanation
            image_url = apod.url

            # Download the image to a temporary file
            if not os.path.exists(self.apod_image_file):
                apod.download_image(self.apod_image_file)

            filename = os.path.basename(self.apod_image_file)
            image_file = discord.File(self.apod_image_file, filename=filename)
            try:
                apod_copyright = apod.copyright
            except nasa_api_errors.NasaApiDataNotFoundError:
                apod_copyright = "Copyright: NASA"
            color = discord.Color.dark_blue()
            embed = discord.Embed(
                title="Astronomy Picture of the Day",
                url=image_url,
                color=color,
                description=image_description
            )
            embed.set_image(url=f"attachment://{filename}")
            embed.set_footer(text=apod_copyright)
            try:
                await interaction.followup.send(embed=embed, file=image_file)
            except Exception as e:
                nasa_bot_logger.exception(e)


    @tasks.loop(time=time)
    async def post_daily_image(self) -> None:
        """
        Post the APOD daily to discord.
        """
        channel = self.bot.get_channel(int(self.channel))
        apod = Apod(self.endpoint)
        if apod.is_video():
            try:
                await channel.send(apod.url)
            except Exception as e:
                nasa_bot_logger.exception(e)
        else:
            image_description = apod.explanation
            image_url = apod.url

            # Download the image to a temporary file
            if not os.path.exists(self.apod_image_file):
                apod.download_image(self.apod_image_file)

            filename = os.path.basename(self.apod_image_file)
            image_file = discord.File(self.apod_image_file, filename=filename)
            try:
                apod_copyright = apod.copyright
            except nasa_api_errors.NasaApiDataNotFoundError:
                apod_copyright = "Copyright: NASA"
            color = discord.Color.dark_blue()
            embed = discord.Embed(
                title="Astronomy Picture of the Day",
                url=image_url,
                color=color,
                description=image_description
            )
            embed.set_image(url=f"attachment://{filename}")
            embed.set_footer(text=apod_copyright)
            try:
                await channel.send(embed=embed, file=image_file)

                # Wipe the cache each day to prevent excessive disk usage.
                self.clean_up_cache()
            except Exception as e:
                nasa_bot_logger.exception(e)

    def clean_up_cache(self) -> None:
        """
        Removes all images that are currently in the apod image cache.

        Returns: None

        Raises:
            FileNotFoundError: If the image file does not exist in the cache.

        Notes:
            This method is different from a call to the temporary directory's
            cleanup method as it only removes the images that are currently
            in the cache, rather than removing the directory itself.
        """
        try:
            for _ in os.listdir(self.temp_dir.name):
                os.remove(self.apod_image_file)
        except FileNotFoundError as exception:
            nasa_bot_logger.exception(f"Error cleaning up cache: {exception}")

__init__(bot)

Creates an instance of the APOD class.

Parameters:

Name Type Description Default
bot Bot

The bot that the cog is being added to.

 required
Source code in src\cogs\apod.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def __init__(self, bot: commands.Bot):
    """
    Creates an instance of the APOD class.

    Args:
        bot (discord.ext.commands.Bot): The bot that the cog is being
                                        added to.
    """
    try:
        config = Config()
        self.channel = config.get_unique_item("apod_channel")
        self.endpoint = config.get_unique_item("apod_url")
    except Exception as e:
        nasa_bot_logger.exception(e)
    self.post_daily_image.start()
    self.bot = bot
    self.temp_dir = tempfile.TemporaryDirectory(prefix="apod-images-cache-")
    self.temp_file_name = self.temp_dir.name
    self.apod_image_file = (f"{self.temp_file_name}/"
                            f"apod-{datetime.date.today()}.jpg")

clean_up_cache()

Removes all images that are currently in the apod image cache.

Returns: None

Raises:

Type Description
FileNotFoundError

If the image file does not exist in the cache.
Notes

This method is different from a call to the temporary directory's cleanup method as it only removes the images that are currently in the cache, rather than removing the directory itself.

Source code in src\cogs\apod.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def clean_up_cache(self) -> None:
    """
    Removes all images that are currently in the apod image cache.

    Returns: None

    Raises:
        FileNotFoundError: If the image file does not exist in the cache.

    Notes:
        This method is different from a call to the temporary directory's
        cleanup method as it only removes the images that are currently
        in the cache, rather than removing the directory itself.
    """
    try:
        for _ in os.listdir(self.temp_dir.name):
            os.remove(self.apod_image_file)
    except FileNotFoundError as exception:
        nasa_bot_logger.exception(f"Error cleaning up cache: {exception}")

daily_image(interaction) async

Posts the daily APOD image to discord.

Parameters:

Name Type Description Default
interaction Interaction

Represents the interaction with discord.

 required
Source code in src\cogs\apod.py 
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
@app_commands.command(name="daily_image",
                      description="Posts the Astronomy picture of the day.")
async def daily_image(self, interaction: discord.Interaction) -> None:
    """
    Posts the daily APOD image to discord.

    Args:
        interaction (discord.Interaction): Represents the interaction
                                           with discord.
    """

    await interaction.response.defer()
    apod = Apod(self.endpoint)
    if apod.is_video():
        try:
            await interaction.response.send_message(apod.url)
        except Exception as e:
            nasa_bot_logger.exception(e)
    else:
        image_description = apod.explanation
        image_url = apod.url

        # Download the image to a temporary file
        if not os.path.exists(self.apod_image_file):
            apod.download_image(self.apod_image_file)

        filename = os.path.basename(self.apod_image_file)
        image_file = discord.File(self.apod_image_file, filename=filename)
        try:
            apod_copyright = apod.copyright
        except nasa_api_errors.NasaApiDataNotFoundError:
            apod_copyright = "Copyright: NASA"
        color = discord.Color.dark_blue()
        embed = discord.Embed(
            title="Astronomy Picture of the Day",
            url=image_url,
            color=color,
            description=image_description
        )
        embed.set_image(url=f"attachment://{filename}")
        embed.set_footer(text=apod_copyright)
        try:
            await interaction.followup.send(embed=embed, file=image_file)
        except Exception as e:
            nasa_bot_logger.exception(e)

post_daily_image() async

Post the APOD daily to discord.

Source code in src\cogs\apod.py 
 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
@tasks.loop(time=time)
async def post_daily_image(self) -> None:
    """
    Post the APOD daily to discord.
    """
    channel = self.bot.get_channel(int(self.channel))
    apod = Apod(self.endpoint)
    if apod.is_video():
        try:
            await channel.send(apod.url)
        except Exception as e:
            nasa_bot_logger.exception(e)
    else:
        image_description = apod.explanation
        image_url = apod.url

        # Download the image to a temporary file
        if not os.path.exists(self.apod_image_file):
            apod.download_image(self.apod_image_file)

        filename = os.path.basename(self.apod_image_file)
        image_file = discord.File(self.apod_image_file, filename=filename)
        try:
            apod_copyright = apod.copyright
        except nasa_api_errors.NasaApiDataNotFoundError:
            apod_copyright = "Copyright: NASA"
        color = discord.Color.dark_blue()
        embed = discord.Embed(
            title="Astronomy Picture of the Day",
            url=image_url,
            color=color,
            description=image_description
        )
        embed.set_image(url=f"attachment://{filename}")
        embed.set_footer(text=apod_copyright)
        try:
            await channel.send(embed=embed, file=image_file)

            # Wipe the cache each day to prevent excessive disk usage.
            self.clean_up_cache()
        except Exception as e:
            nasa_bot_logger.exception(e)