python-telegram-bot · leandrotoledo · May 15, 2016 · May 15, 2016 · May 15, 2016 · May 15, 2016
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,17 @@
+-   repo: git://github.com/pre-commit/mirrors-yapf
+    sha: 'v0.7.1'
+    hooks:
+    -   id: yapf
+        args: ['-i']
+
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    sha: 'v0.5.0'
+    hooks:
+    -   id: flake8
+        args: ['telegram']
+
+-   repo: git://github.com/pre-commit/mirrors-pylint
+    sha: 'v1.5.5'
+    hooks:
+    -   id: pylint
+        args: ['--errors-only', '--disable=no-name-in-module,import-error', 'telegram']
diff --git a/.travis.yml b/.travis.yml
@@ -13,7 +13,8 @@ install:
   - pip install -r requirements-dev.txt
 script:
   - nosetests -v --with-flaky --no-flaky-report --with-coverage --cover-package=telegram/
+  - 'if [ $TRAVIS_PYTHON_VERSION != 2.6 ] && [ $TRAVIS_PYTHON_VERSION != 3.3 ] && [ $TRAVIS_PYTHON_VERSION != pypy3 ]; then yapf -r telegram; fi'
   - flake8 telegram
-  - 'if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then pylint -E telegram --disable=no-name-in-module,import-error; fi'
+  - 'if [ $TRAVIS_PYTHON_VERSION != 2.6 ]; then pylint -E telegram --disable=no-name-in-module,import-error; fi'
 after_success:
   coveralls
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -22,6 +22,11 @@ Setting things up
 
    ``$ pip install -r requirements.txt -r requirements-dev.txt``
 
+
+5. Install pre-commit hooks:
+
+   ``$ pre-commit install``
+
 Finding something to do
 -----------------------
 
@@ -68,18 +73,20 @@ Here's how to make a one-off code change.
 
    - Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
 
-   - Before making a commit ensure that all automated tests, pep8 & lint validations still pass:
+   - Before making a commit ensure that all automated tests still pass:
 
       ``$ make test``
 
-      ``$ make pep8``
+   - To actually make the commit (this will trigger tests for yapf, lint and pep8 automatically):
 
-      ``$ make lint``
+      ``$ git add your-file-changed.py``
 
-   - To actually make the commit and push it to your GitHub fork, run:
+        - yapf may change code formatting, make sure to re-add them to your commit.
 
       ``$ git commit -a -m "your-commit-message-here"``
 
+   - Finally, push it to your GitHub fork, run:
+
       ``$ git push origin your-branch-name``
 
 4. **When your feature is ready to merge, create a pull request.**

diff --git a/Makefile b/Makefile
@@ -1,10 +1,11 @@
 .DEFAULT_GOAL := help
-.PHONY: clean pep8 lint test install
+.PHONY: clean pep257 pep8 yapf lint test install
 
 PYLINT          := pylint
 NOSETESTS       := nosetests
 PEP257          := pep257
 PEP8            := flake8
+YAPF            := yapf
 PIP             := pip
 
 clean:
@@ -19,7 +20,10 @@ pep257:
 	$(PEP257) telegram
 
 pep8:
-	$(PEP8)  telegram
+	$(PEP8) telegram
+
+yapf:
+	$(YAPF) -r telegram
 
 lint:
 	$(PYLINT) -E telegram --disable=no-name-in-module,import-error
@@ -28,19 +32,21 @@ test:
 	$(NOSETESTS) -v
 
 install:
-	$(PIP)  install -r requirements.txt
+	$(PIP)  install -r requirements.txt -r requirements-dev.txt
 
 help:
 	@echo "Available targets:"
 	@echo "- clean       Clean up the source directory"
 	@echo "- pep257      Check docstring style with pep257"
 	@echo "- pep8        Check style with flake8"
 	@echo "- lint        Check style with pylint"
+	@echo "- yapf        Check style with yapf"
 	@echo "- test        Run tests"
 	@echo
 	@echo "Available variables:"
 	@echo "- PYLINT      default: $(PYLINT)"
 	@echo "- NOSETESTS   default: $(NOSETESTS)"
 	@echo "- PEP257      default: $(PEP257)"
 	@echo "- PEP8        default: $(PEP8)"
+	@echo "- YAPF        default: $(YAPF)"
 	@echo "- PIP         default: $(PIP)"
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -3,4 +3,7 @@ nose
 pep257
 pylint
 unittest2
-flaky
+flaky
+yapf
+pre-commit
+pre-commit-hooks
diff --git a/setup.cfg b/setup.cfg
@@ -11,3 +11,7 @@ upload-dir = docs/build/html
 
 [flake8]
 max-line-length = 99
+
+[yapf]
+based_on_style = google
+column_limit = 99
diff --git a/telegram/__init__.py b/telegram/__init__.py
@@ -16,7 +16,6 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-
 """A library that provides a Python interface to the Telegram Bot API"""
 
 from sys import version_info
@@ -81,70 +80,24 @@
 from .update import Update
 from .bot import Bot
 
-
 __author__ = 'devs@python-telegram-bot.org'
 __version__ = '4.0.3'
-__all__ = ['Audio',
-           'Bot',
-           'Chat',
-           'ChatAction',
-           'ChosenInlineResult',
-           'CallbackQuery',
-           'Contact',
-           'Document',
-           'Emoji',
-           'File',
-           'ForceReply',
-           'InlineKeyboardButton',
-           'InlineKeyboardMarkup',
-           'InlineQuery',
-           'InlineQueryResult',
-           'InlineQueryResult',
-           'InlineQueryResultArticle',
-           'InlineQueryResultAudio',
-           'InlineQueryResultCachedAudio',
-           'InlineQueryResultCachedDocument',
-           'InlineQueryResultCachedGif',
-           'InlineQueryResultCachedMpeg4Gif',
-           'InlineQueryResultCachedPhoto',
-           'InlineQueryResultCachedSticker',
-           'InlineQueryResultCachedVideo',
-           'InlineQueryResultCachedVoice',
-           'InlineQueryResultContact',
-           'InlineQueryResultDocument',
-           'InlineQueryResultGif',
-           'InlineQueryResultLocation',
-           'InlineQueryResultMpeg4Gif',
-           'InlineQueryResultPhoto',
-           'InlineQueryResultVenue',
-           'InlineQueryResultVideo',
-           'InlineQueryResultVoice',
-           'InputContactMessageContent',
-           'InputFile',
-           'InputLocationMessageContent',
-           'InputMessageContent',
-           'InputTextMessageContent',
-           'InputVenueMessageContent',
-           'KeyboardButton',
-           'Location',
-           'Message',
-           'MessageEntity',
-           'NullHandler',
-           'ParseMode',
-           'PhotoSize',
-           'ReplyKeyboardHide',
-           'ReplyKeyboardMarkup',
-           'ReplyMarkup',
-           'Sticker',
-           'TelegramError',
-           'TelegramObject',
-           'Update',
-           'User',
-           'UserProfilePhotos',
-           'Venue',
-           'Video',
-           'Voice']
-
+__all__ = ['Audio', 'Bot', 'Chat', 'ChatAction', 'ChosenInlineResult', 'CallbackQuery', 'Contact',
+           'Document', 'Emoji', 'File', 'ForceReply', 'InlineKeyboardButton',
+           'InlineKeyboardMarkup', 'InlineQuery', 'InlineQueryResult', 'InlineQueryResult',
+           'InlineQueryResultArticle', 'InlineQueryResultAudio', 'InlineQueryResultCachedAudio',
+           'InlineQueryResultCachedDocument', 'InlineQueryResultCachedGif',
+           'InlineQueryResultCachedMpeg4Gif', 'InlineQueryResultCachedPhoto',
+           'InlineQueryResultCachedSticker', 'InlineQueryResultCachedVideo',
+           'InlineQueryResultCachedVoice', 'InlineQueryResultContact', 'InlineQueryResultDocument',
+           'InlineQueryResultGif', 'InlineQueryResultLocation', 'InlineQueryResultMpeg4Gif',
+           'InlineQueryResultPhoto', 'InlineQueryResultVenue', 'InlineQueryResultVideo',
+           'InlineQueryResultVoice', 'InputContactMessageContent', 'InputFile',
+           'InputLocationMessageContent', 'InputMessageContent', 'InputTextMessageContent',
+           'InputVenueMessageContent', 'KeyboardButton', 'Location', 'Message', 'MessageEntity',
+           'NullHandler', 'ParseMode', 'PhotoSize', 'ReplyKeyboardHide', 'ReplyKeyboardMarkup',
+           'ReplyMarkup', 'Sticker', 'TelegramError', 'TelegramObject', 'Update', 'User',
+           'UserProfilePhotos', 'Venue', 'Video', 'Voice']
 
 if version_info < (2, 7):
     from warnings import warn

diff --git a/telegram/audio.py b/telegram/audio.py
@@ -16,7 +16,6 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-
 """This module contains a object that represents a Telegram Audio."""
 
 from telegram import TelegramObject
@@ -45,10 +44,7 @@ class Audio(TelegramObject):
         file_size (Optional[int]):
     """
 
-    def __init__(self,
-                 file_id,
-                 duration,
-                 **kwargs):
+    def __init__(self, file_id, duration, **kwargs):
         # Required
         self.file_id = str(file_id)
         self.duration = int(duration)

diff --git a/telegram/base.py b/telegram/base.py
@@ -16,7 +16,6 @@
 #
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
-
 """Base class for Telegram Objects."""
 
 import json