samplepack.py

# -*- coding: utf-8 -*-

"""
The MIT License (MIT)

Copyright (c) 2024 Nortxort

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""


class SamplePack:
    """
    Sample pack data class.
    """
    def __init__(self, page_url: str, url: str, title: str):
        self._page_url = page_url
        self._url = url
        self._title = title
        self._size: int = 0
        self._file_path: str = ''
        self._content_length: int = 0

    @property
    def page_url(self) -> str:
        """ page the sample pack url was located on. """
        return self._page_url

    @property
    def url(self) -> str:
        """ url to the sample pack(zip file). """
        return self._url

    @property
    def title(self) -> str:
        """ title of the sample pack. """
        return self._title

    @property
    def file_name(self) -> str:
        """ name of the sample pack(zip file name) """
        return self._url.split('/')[-1]

    @property
    def size(self) -> int:
        """ size of the sample pack in bytes. """
        return self._size

    @property
    def path(self) -> str:
        """ location the file was saved to. """
        return self._file_path

    @property
    def content_length(self):
        """ content length of file. """
        return self._content_length

    @size.setter
    def size(self, value):
        self._size = value

    @path.setter
    def path(self, value):
        self._file_path = value

    @content_length.setter
    def content_length(self, value):
        self._content_length = value

    def __repr__(self):
        return (f'<{__class__.__name__} '
                f'page_url={self.page_url}, '
                f'url={self.url}, '
                f'title={self.title}, '
                f'file_name={self.file_name}, '
                f'size={self.size}, '
                f'path={self.path}, '
                f'content_length={self.content_length}>')