blackify; README.rst -> README.md

Author: cs01

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,38 @@
+# A browser-based frontend for GDB
+
+[![](https://github.com/cs01/gdbgui/raw/master/screenshots/gdbgui_animation.gif)](https://github.com/cs01/gdbgui/raw/master/screenshots/gdbgui_animation.gif)
+
+[![image](https://travis-ci.org/cs01/gdbgui.svg?branch=master)](https://travis-ci.org/cs01/gdbgui)
+[![image](https://img.shields.io/badge/pypi-0.11.3.1-blue.svg)](https://pypi.python.org/pypi/gdbgui/)
+![image](https://img.shields.io/badge/python-2.7,3.4,3.5,3.6,pypy-blue.svg)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+[![image](https://github.com/cs01/gdbgui/raw/master/images/gdbgui_banner.png)](https://gdbgui.com)
+
+A modern, browser-based frontend to gdb (gnu debugger). Add breakpoints, view stack traces, and more in C, C++, Go, and Rust! Simply run `gdbgui` from the terminal and a new tab will open in your browser.
+
+## Download
+
+Visit [gdbgui.com](https://gdbgui.com) to download, view documentation, installation instructions, screenshots and more.
+
+## License
+
+GNU GPLv3
+
+For alternate licensing schemes, contact <[email protected]> for more information.
+
+[gdbgui.com](https://gdbgui.com), [https://github.com/cs01/gdbgui](https://github.com/cs01/gdbgui), and [PyPI](https://pypi.python.org/pypi/gdbgui/) are the only official sources of gdbgui.
+
+## Support gdbgui
+
+You can support the project by [donating](https://www.paypal.me/grassfedcode/20), spreading the word, and reporting issues.
+## Contributing
+
+To add a feature or fix a bug, see [CONTRIBUTING](https://github.com/cs01/gdbgui/blob/master/CONTRIBUTING.md).
+
+## Authors
+
+`gdbgui` is primarily authored by Chad Smith, with [help from the community](https://github.com/cs01/gdbgui/graphs/contributors). Large contributions were made by @bobthekingofegyp, who added initial autocomplete functionality for the gdb terminal.
+
+## Contact
+
+<[email protected]>

README.md

@@ -12,7 +12,9 @@
 class SSLify(object):
     """Secures your Flask App."""
 
-    def __init__(self, app=None, age=YEAR_IN_SECS, subdomains=False, permanent=False, skips=None):
+    def __init__(
+        self, app=None, age=YEAR_IN_SECS, subdomains=False, permanent=False, skips=None
+    ):
         self.app = app
         self.hsts_age = age
 
@@ -25,24 +27,26 @@ def __init__(self, app=None, age=YEAR_IN_SECS, subdomains=False, permanent=False
 
     def init_app(self, app):
         """Configures the specified Flask app to enforce SSL."""
-        app.config.setdefault('SSLIFY_SUBDOMAINS', False)
-        app.config.setdefault('SSLIFY_PERMANENT', False)
-        app.config.setdefault('SSLIFY_SKIPS', None)
+        app.config.setdefault("SSLIFY_SUBDOMAINS", False)
+        app.config.setdefault("SSLIFY_PERMANENT", False)
+        app.config.setdefault("SSLIFY_SKIPS", None)
 
-        self.hsts_include_subdomains = self.hsts_include_subdomains or app.config['SSLIFY_SUBDOMAINS']
-        self.permanent = self.permanent or self.app.config['SSLIFY_PERMANENT']
-        self.skip_list = self.skip_list or self.app.config['SSLIFY_SKIPS']
+        self.hsts_include_subdomains = (
+            self.hsts_include_subdomains or app.config["SSLIFY_SUBDOMAINS"]
+        )
+        self.permanent = self.permanent or self.app.config["SSLIFY_PERMANENT"]
+        self.skip_list = self.skip_list or self.app.config["SSLIFY_SKIPS"]
 
         app.before_request(self.redirect_to_ssl)
         app.after_request(self.set_hsts_header)
 
     @property
     def hsts_header(self):
         """Returns the proper HSTS policy."""
-        hsts_policy = 'max-age={0}'.format(self.hsts_age)
+        hsts_policy = "max-age={0}".format(self.hsts_age)
 
         if self.hsts_include_subdomains:
-            hsts_policy += '; includeSubDomains'
+            hsts_policy += "; includeSubDomains"
 
         return hsts_policy
 
@@ -52,7 +56,7 @@ def skip(self):
         # Should we skip?
         if self.skip_list and isinstance(self.skip_list, list):
             for skip in self.skip_list:
-                if request.path.startswith('/{0}'.format(skip)):
+                if request.path.startswith("/{0}".format(skip)):
                     return True
         return False
 
@@ -63,12 +67,12 @@ def redirect_to_ssl(self):
             request.is_secure,
             self.app.debug,
             self.app.testing,
-            request.headers.get('X-Forwarded-Proto', 'http') == 'https'
+            request.headers.get("X-Forwarded-Proto", "http") == "https",
         ]
 
         if not any(criteria) and not self.skip:
-            if request.url.startswith('http://'):
-                url = request.url.replace('http://', 'https://', 1)
+            if request.url.startswith("http://"):
+                url = request.url.replace("http://", "https://", 1)
                 code = 302
                 if self.permanent:
                     code = 301
@@ -79,7 +83,7 @@ def set_hsts_header(self, response):
         """Adds HSTS header to each response."""
         # Should we add STS header?
         if request.is_secure and not self.skip:
-            response.headers.setdefault('Strict-Transport-Security', self.hsts_header)
+            response.headers.setdefault("Strict-Transport-Security", self.hsts_header)
         return response
 
 
@@ -88,7 +92,12 @@ def get_ssl_context(private_key, certificate):
     The return value is used when calling Flask.
     i.e. app.run(ssl_context=get_ssl_context(,,,))
     """
-    if certificate and os.path.isfile(certificate) and private_key and os.path.isfile(private_key):
+    if (
+        certificate
+        and os.path.isfile(certificate)
+        and private_key
+        and os.path.isfile(private_key)
+    ):
         context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
         context.load_cert_chain(certificate, private_key)
         return context

README.rst

@@ -2,10 +2,14 @@
 import os
 import sys
 
-_base_dir = getattr(sys, '_MEIPASS', os.path.dirname(os.path.realpath(__file__)))
-_version = io.open(os.path.join(_base_dir, 'VERSION.txt'), 'r', encoding="utf-8").read().strip()
+_base_dir = getattr(sys, "_MEIPASS", os.path.dirname(os.path.realpath(__file__)))
+_version = (
+    io.open(os.path.join(_base_dir, "VERSION.txt"), "r", encoding="utf-8")
+    .read()
+    .strip()
+)
 
-__title__ = 'gdbgui'
+__title__ = "gdbgui"
 __version__ = _version
-__author__ = 'Chad Smith'
-__copyright__ = 'Copyright Chad Smith'
+__author__ = "Chad Smith"
+__copyright__ = "Copyright Chad Smith"

gdbgui/SSLify.py

@@ -16,7 +16,7 @@
     render_template,
     jsonify,
     redirect,
-    abort
+    abort,
 )
 from flask_socketio import SocketIO, emit
 from flask_compress import Compress
@@ -267,9 +267,10 @@ def verify_gdb_exists():
         else:
             print('try "sudo apt-get install gdb" for Linux or "brew install gdb"')
         sys.exit(1)
-    elif "lldb" in app.config["gdb_path"].lower() and "lldb-mi" not in app.config[
-        "gdb_path"
-    ].lower():
+    elif (
+        "lldb" in app.config["gdb_path"].lower()
+        and "lldb-mi" not in app.config["gdb_path"].lower()
+    ):
         pygdbmi.printcolor.print_red(
             'gdbgui cannot use the standard lldb executable. You must use an executable with "lldb-mi" in its name.'
         )
@@ -499,8 +500,11 @@ def authenticate(f):
     def wrapper(*args, **kwargs):
         if app.config.get("gdbgui_auth_user_credentials") is not None:
             auth = request.authorization
-            if not auth or not auth.username or not auth.password or not credentials_are_valid(
-                auth.username, auth.password
+            if (
+                not auth
+                or not auth.username
+                or not auth.password
+                or not credentials_are_valid(auth.username, auth.password)
             ):
                 return Response(
                     "You must log in to continue.",
@@ -531,9 +535,9 @@ def gdbgui():
         "themes": THEMES,
         "signals": SIGNAL_NAME_TO_OBJ,
         "gdbpid": gdbpid,
-        "p": pbkdf2_hex(str(app.config.get("l")), "Feo8CJol") if app.config.get(
-            "l"
-        ) else "",
+        "p": pbkdf2_hex(str(app.config.get("l")), "Feo8CJol")
+        if app.config.get("l")
+        else "",
         "project_home": app.config["project_home"],
         "csrf_token": session["csrf_token"],
         "using_windows": USING_WINDOWS,
@@ -561,12 +565,15 @@ def send_signal_to_pid():
     try:
         pid_int = int(pid_str)
     except ValueError:
-        return jsonify(
-            {
-                "message": "The pid %s cannot be converted to an integer. Signal %s was not sent."
-                % (pid_str, signal_name)
-            }
-        ), 400
+        return (
+            jsonify(
+                {
+                    "message": "The pid %s cannot be converted to an integer. Signal %s was not sent."
+                    % (pid_str, signal_name)
+                }
+            ),
+            400,
+        )
 
     os.kill(pid_int, signal_obj)
     return jsonify(
@@ -658,7 +665,9 @@ def read_file():
             raise e
 
         else:
-            highlight = True  # highlight argument was invalid for some reason, default to true
+            highlight = (
+                True
+            )  # highlight argument was invalid for some reason, default to true
 
     if path and os.path.isfile(path):
         try:
@@ -676,7 +685,7 @@ def read_file():
                     if raw_source_code_list[i] == "":
                         raw_source_code_list[i] = " "
                 raw_source_code_lines_of_interest = raw_source_code_list[
-                    (start_line - 1):(end_line)
+                    (start_line - 1) : (end_line)
                 ]
             try:
                 lexer = get_lexer_for_filename(path)
@@ -688,7 +697,9 @@ def read_file():
                 # convert string into tokens
                 tokens = lexer.get_tokens("\n".join(raw_source_code_lines_of_interest))
                 # format tokens into nice, marked up list of html
-                formatter = htmllistformatter.HtmlListFormatter()  # Don't add newlines after each line
+                formatter = (
+                    htmllistformatter.HtmlListFormatter()
+                )  # Don't add newlines after each line
                 source_code = formatter.get_marked_up_list(tokens)
             else:
                 highlighted = False

gdbgui/__init__.py

@@ -53,9 +53,9 @@ def connect_client(self, client_id, desired_gdbpid):
         if self.get_controller_from_client_id(client_id) is None:
             logger.info("new sid", client_id)
 
-            gdb_args = deepcopy(
-                self.config["initial_binary_and_args"]
-            ) + REQUIRED_GDB_FLAGS
+            gdb_args = (
+                deepcopy(self.config["initial_binary_and_args"]) + REQUIRED_GDB_FLAGS
+            )
 
             if startup_with_shell_off:
                 # macOS Sierra (and later) may have issues with gdb. This should fix it, but there might be other issues
@@ -75,7 +75,8 @@ def connect_client(self, client_id, desired_gdbpid):
 
             pid = self.get_pid_from_controller(controller)
             message += "gdbgui spawned subprocess with pid %s from executable %s." % (
-                str(pid), self.config["gdb_path"]
+                str(pid),
+                self.config["gdb_path"],
             )
 
         return {