Source code for IGitt.Interfaces.Content

"""
This module contains the Content class.
"""
from typing import Optional

from IGitt.Interfaces import IGittObject



[docs]class Content(IGittObject):
    """
    Represents content on GitHub or GitLab or a bug report on bugzilla or so.
    """


[docs]    def get_content(self, ref: Optional[str]=None):
        """
        Get content
        """
        raise NotImplementedError



[docs]    def delete(self, message: str, branch: Optional[str]=None):
        """
        Deletes content

        :param message: The commit message for the deletion commit.
        :param branch:  The branch to delete this content from. Defaults to
                        `master`.
        """
        raise NotImplementedError



[docs]    def update(self, message: str, content: str, branch: Optional[str]=None):
        """
        Updates existing file in repository
        """
        raise NotImplementedError