Use black for code formatting

Author: Thibauth

cli.py

@@ -0,0 +1,107 @@
+from ConfigParser import RawConfigParser, NoSectionError, NoOptionError
+from argparse import ArgumentParser, RawDescriptionHelpFormatter
+import os
+from pushover import Pushover
+
+
+def read_config(config_path):
+    config_path = os.path.expanduser(config_path)
+    config = RawConfigParser()
+    params = {"users": {}}
+    files = config.read(config_path)
+    if not files:
+        return params
+    params["token"] = config.get("main", "token")
+    for name in config.sections():
+        if name != "main":
+            user = {}
+            user["user_key"] = config.get(name, "user_key")
+            try:
+                user["device"] = config.get(name, "device")
+            except NoOptionError:
+                user["device"] = None
+            params["users"][name] = user
+    return params
+
+
+def main():
+    parser = ArgumentParser(
+        description="Send a message to pushover.",
+        formatter_class=RawDescriptionHelpFormatter,
+        epilog="""
+For more details and bug reports, see: https://github.com/Thibauth/python-pushover""",
+    )
+    parser.add_argument("--token", help="API token")
+    parser.add_argument(
+        "--user",
+        "-u",
+        help="User key or section name in the configuration",
+        required=True,
+    )
+    parser.add_argument(
+        "-c",
+        "--config",
+        help="configuration file\
+                        (default: ~/.pushoverrc)",
+        default="~/.pushoverrc",
+    )
+    parser.add_argument("message", help="message to send")
+    parser.add_argument("--url", help="additional url")
+    parser.add_argument("--url-title", help="url title")
+    parser.add_argument("--title", "-t", help="message title")
+    parser.add_argument(
+        "--priority", "-p", help="notification priority (-1, 0, 1 or 2)", type=int
+    )
+    parser.add_argument(
+        "--retry",
+        "-r",
+        help="resend interval in seconds (required for priority 2)",
+        type=int,
+    )
+    parser.add_argument(
+        "--expire",
+        "-e",
+        help="expiration time in seconds (required for priority 2)",
+        type=int,
+    )
+    parser.add_argument(
+        "--version",
+        "-v",
+        action="version",
+        help="output version information and exit",
+        version="""
+%(prog)s 1.0
+Copyright (C) 2013-2018 Thibaut Horel <thibaut.horel@gmail.com>
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.""",
+    )
+
+    args = parser.parse_args()
+    params = read_config(args.config)
+    if args.priority == 2 and (args.retry is None or args.expire is None):
+        parser.error("priority of 2 requires expire and retry")
+    if args.user in params["users"]:
+        user_key = params["users"][args.user]["user_key"]
+        device = params["users"][args.user]["device"]
+    else:
+        user_key = args.user
+        device = None
+    token = args.token or params["token"]
+
+    Pushover(token).message(
+        user_key,
+        args.message,
+        device=device,
+        title=args.title,
+        priority=args.priority,
+        url=args.url,
+        url_title=args.url_title,
+        timestamp=True,
+        retry=args.retry,
+        expire=args.expire,
+    )
+
+
+if __name__ == "__main__":
+    main()

pushover.py

@@ -24,6 +24,7 @@
 RECEIPT_URL = BASE_URL + "receipts/"
 GLANCE_URL = BASE_URL + "glances.json"
 
+
 class RequestError(Exception):
     """Exception which is raised when Pushover's API returns an error code.
 
@@ -38,7 +39,7 @@ def __str__(self):
         return "\n==> " + "\n==> ".join(self.errors)
 
 
-class Request:
+class Request(object):
     """Base class to send a request to the Pushover server and check the return
     status code. The request is sent on instantiation and raises
     a :class:`RequestError` exception when the request is rejected.
@@ -70,9 +71,11 @@ class MessageRequest(Request):
     can poll the status of the notification with the :func:`poll` function.
     """
 
-    params = {"expired": "expires_at",
-            "called_back": "called_back_at",
-            "acknowledged": "acknowledged_at"}
+    params = {
+        "expired": "expires_at",
+        "called_back": "called_back_at",
+        "acknowledged": "acknowledged_at",
+    }
 
     def __init__(self, payload):
         Request.__init__(self, "post", MESSAGE_URL, payload)
@@ -122,18 +125,35 @@ def cancel(self):
         cancels the notification early.
         """
         if not self.status["done"]:
-            return Request("post", self.url + "/cancel.json", {"token": self.payload["token"]})
+            return Request(
+                "post", self.url + "/cancel.json", {"token": self.payload["token"]}
+            )
+        else:
+            return None
 
 
-class Pushover:
+class Pushover(object):
     """This is the main class of the module. It represents a Pushover app and
     is tied to a unique API token.
 
     * ``token``: Pushover API token
     """
 
     _SOUNDS = None
-    message_keywords = ["title", "priority", "sound", "callback", "timestamp", "url", "url_title", "device", "retry", "expire", "html", "attachment"]
+    message_keywords = [
+        "title",
+        "priority",
+        "sound",
+        "callback",
+        "timestamp",
+        "url",
+        "url_title",
+        "device",
+        "retry",
+        "expire",
+        "html",
+        "attachment",
+    ]
     glance_keywords = ["title", "text", "subtext", "count", "percent", "device"]
 
     def __init__(self, token):
@@ -149,7 +169,6 @@ def sounds(self):
             Pushover._SOUNDS = request.answer["sounds"]
         return Pushover._SOUNDS
 
-
     def verify(self, user, device=None):
         """Verify that the `user` and optional `device` exist. Returns
         `None` when the user/device does not exist or a list of the user's
@@ -165,14 +184,13 @@ def verify(self, user, device=None):
         else:
             return request.answer["devices"]
 
-
     def message(self, user, message, **kwargs):
         """Send `message` to the user specified by `user`. It is possible
         to specify additional properties of the message by passing keyword
         arguments. The list of valid keywords is ``title, priority, sound,
         callback, timestamp, url, url_title, device, retry, expire and html``
         which are described in the Pushover API documentation.
-        
+
         For convenience, you can simply set ``timestamp=True`` to set the
         timestamp to the current timestamp.
 
@@ -187,9 +205,9 @@ def message(self, user, message, **kwargs):
             if key not in Pushover.message_keywords:
                 raise ValueError("{0}: invalid message parameter".format(key))
             elif key == "timestamp" and value is True:
-                    payload[key] = int(time.time())
+                payload[key] = int(time.time())
             elif key == "sound" and value not in self.sounds:
-                    raise ValueError("{0}: invalid sound".format(value))
+                raise ValueError("{0}: invalid sound".format(value))
             else:
                 payload[key] = value
 

setup.py

@@ -2,18 +2,22 @@
 
 from setuptools import setup
 
-setup(name='python-pushover',
-      version='1.0',
-      description="Comprehensive bindings and command line utility for the "
-                  "Pushover notification service",
-      long_description=open("README.rst").read() + "\n"
-      + open("AUTHORS.rst").read() + "\n" + open("CHANGES.rst").read(),
-      url='https://github.com/Thibauth/python-pushover',
-      author='Thibaut Horel',
-      author_email='thibaut.horel+pushover@gmail.com',
-      py_modules=['pushover', 'cli'],
-      entry_points={"console_scripts": ["pushover = cli:main"]},
-      install_requires=['requests>=1.0'],
-      use_2to3=True,
-      license='GNU GPLv3'
-      )
+setup(
+    name="python-pushover",
+    version="1.0",
+    description="Comprehensive bindings and command line utility for the "
+    "Pushover notification service",
+    long_description=open("README.rst").read()
+    + "\n"
+    + open("AUTHORS.rst").read()
+    + "\n"
+    + open("CHANGES.rst").read(),
+    url="https://github.com/Thibauth/python-pushover",
+    author="Thibaut Horel",
+    author_email="thibaut.horel+pushover@gmail.com",
+    py_modules=["pushover", "cli"],
+    entry_points={"console_scripts": ["pushover = cli:main"]},
+    install_requires=["requests>=1.0"],
+    use_2to3=True,
+    license="GNU GPLv3",
+)