PTC-W0049 · Function/method with an empty body

Function/method with an empty body PTC-W0049

Anti-pattern

Major

2 months ago — 3 years old

fixup_repo doesn't contain any code

 132        self.repo = self.clone_repo(self.tempdir)
 133        self.fixup_repo(self.repo)
 134
 135    def fixup_repo(self, repo) -> None: 136        return
 137
 138    def get_remote_repo_url(self):

merge doesn't contain any code

weblate/vcs/git.py

1595    def rebase(self, abort=False) -> None:
1596        return
1597
1598    def merge(1599        self, abort: bool = False, message: str | None = None, no_ff: bool = False
1600    ) -> None:
1601        return

update_remote doesn't contain any code

weblate/vcs/git.py

1583    def get_remote_branch_name(self, branch: str | None = None) -> str:
1584        return self.branch if branch is None else branch
1585
1586    def update_remote(self) -> None:1587        return
1588
1589    def push(self, branch) -> None:

configure_remote doesn't contain any code

weblate/vcs/git.py

1575    default_branch = "main"
1576    supports_push = False
1577
1578    def configure_remote(1579        self, pull_url: str, push_url: str, branch: str, fast: bool = True
1580    ) -> None:
1581        return

rebase doesn't contain any code

weblate/vcs/git.py

1592    def reset(self) -> None:
1593        return
1594
1595    def rebase(self, abort=False) -> None:1596        return
1597
1598    def merge(

Description

The function/method has been left empty here, without any comment or docstring. This can cause confusion later on why this was left empty.

If it is intentionally left blank, a nested comment should explain the reason why it is being done.
If this is not yet, or never will be, supported, an exception should be thrown rather than leaving it blank.

Not preferred:

def myfunc1(foo="Noncompliant"):
    pass

class MyClass:
    def mymethod1(self, foo="Noncompliant"):
        pass

Preferred:

def myfunc1():
    pass  # comment explaining why this function is empty

def myfunc2():
    raise NotImplementedError()

def myfunc3():
    '''
    Docstring explaining why this function is empty.
    '''

class MyClass:
    def mymethod1(self):
        pass  # comment explaining why this function is empty

    def mymethod2(self):
        raise NotImplementedError()

    def mymethod3(self):
        '''
        Docstring explaining why this method is empty. Note that this is not recommended for classes
        which are meant to be subclassed.
        '''

WeblateOrg / weblate

Not preferred:

Preferred: