mediatechlab / tts-wrapper

TTS-Wrapper makes it easier to use text-to-speech APIs by providing a unified and easy-to-use interface.
MIT License
14 stars 9 forks source link

Class variables should be prefixed with single underscore #7

Closed gbottari closed 2 years ago

gbottari commented 2 years ago

Description

According to PEP8 we should use a single underscore in front of fields that are not part of the public API of a class.

This article does a good job of explaining why we should use this convention.

This is present in most classes, like PollyTTS:

class PollyTTS(AbstractTTS):
    def __init__(
        self,
        client: PollyClient,
        voice: Optional[str] = None,
    ) -> None:
        self.client = client  # should be changed to self._client
        self.voice = voice or "Joanna"   # should be changed to self._voice
panoramix360 commented 2 years ago

@gbottari, are you already working on this issue?

If not, I'll start to work on it.

gbottari commented 2 years ago

No, I'm not @panoramix360 . You can go ahead!

panoramix360 commented 2 years ago

@gbottari closing this issue since it was resolved on PR #13