Source code for _clockalarm.UI.SoundSelectorWidget

# ClockAlarm is a cross-platform alarm manager
# Copyright (C) 2017  Loïc Charrière, Samuel Gauthier
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import logging
import pathlib
import shutil
from os.path import dirname, abspath, join, basename

from PyQt5.QtWidgets import QWidget, QPushButton, QLineEdit, QHBoxLayout, QFileDialog, QStyle

src_path = dirname(dirname(dirname(abspath(__file__))))


class SoundSelectorWidget(QWidget):
    """Costum widget to selected a sound

    Select a wave file and import it in the application sound folder.

    """

    def __init__(self, sound_name: str = None, parent=None):
        """SoundSelectorWidget default constructor

        Attributes:
            sound_name (str, optional): Default is None. Name of the sound file, with extension.
            parent (QWidget, optional): Default is None. Parent QWidget.

        Exceptions:
            ValueError: If the sound_name argument isn't a wave file.

        """
        super(SoundSelectorWidget, self).__init__(parent)

        if sound_name and not sound_name.endswith(('.wav', '.wave')):
            raise ValueError('Sound must be at wave format')

        self.sound_name = sound_name  # not the full path
        self.sound_edit = None
        self.sound_select_button = None

        self.init_ui()

    def init_ui(self):
        """Initialize the GUI of the QWidget

        """
        h_layout = QHBoxLayout()  # to line up the widgets

        self.sound_edit = QLineEdit()
        self.sound_select_button = QPushButton()
        self.sound_select_button.setIcon(self.style().standardIcon(QStyle.SP_DirIcon))
        if self.sound_name is not None:  # init the sound name is not None
            self.sound_edit.setText(self.sound_name)
        self.sound_select_button.released.connect(self.button_click)

        h_layout.addWidget(self.sound_edit)
        h_layout.addWidget(self.sound_select_button)
        h_layout.setContentsMargins(0, 0, 0, 0)

        self.setLayout(h_layout)

    def button_click(self):
        """Called when the sound_select_button is clicked. Get a wave sound file path from the file explorer."""
        sound_path = QFileDialog.getOpenFileName(None, "Select a sound to import", filter="wav (*.wav *.)")[0]
        if sound_path == '':  # canceled dialog
            logging.debug("abort sound import")
            return
        self.load_sound(sound_path)

    def load_sound(self, sound_path: str):
        """Load the given .wave sound file in the application folder

        If the file already exist in the sound folder of the app, nothing append.
        If a file with the same name already exist in the sound folder, he is overwritten.

        Attributes:
            sound_path: the full path of the sound file.

        Exceptions:
            ValueError: If the given sound_path isn't a valid wave sound.

        """
        if not sound_path or not sound_path.endswith((".wav", ".wave")):
            raise ValueError("Not a valid wave file")

        file_name = pathlib.PurePosixPath(sound_path).name  # shutil.copy function requires url path
        dest = pathlib.Path(join(src_path, "_clockalarm", "resources", "sounds", file_name)).as_posix()

        logging.debug("import sound src path: " + sound_path)
        logging.debug("import sound dest path: " + dest)

        try:
            shutil.copy(sound_path, dest)
        except shutil.Error:  # file already exist
            logging.debug("the sound file already exist")

        self.set_sound(basename(sound_path))  # sound_name is file name and extension

    def set_sound(self, sound: str):
        """Set a new sound

        Modify the name and update the edit field.

        Attributes:
            sound (str): The new sound basename.

        Exceptions:
            ValueError: If the sound_name argument isn't a wave file.

        """
        if not sound.endswith(('.wav', '.wave')):
            raise ValueError('Sound must be at wave format')

        self.sound_name = sound
        self.sound_edit.setText(sound)