16 |
17 |
18 |
21 |
22 |
23 | {% block body %}{% endblock %} 24 |
25 | {% block after_container %}
26 | {% endblock %}
27 | {% endblock %}
28 |
29 |
--------------------------------------------------------------------------------
/birdseye/templates/call_core.html:
--------------------------------------------------------------------------------
1 |
18 |  }})
19 | birdseye
20 |
21 |
22 | 23 | {% block body %}{% endblock %} 24 |
2 |
3 |
5 | {{ func.html_body | safe }}
4 |
6 |
13 |
14 |
15 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 Alex Hall
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/tests/test_import_hook.py:
--------------------------------------------------------------------------------
1 | # coding=utf8
2 | import unittest
3 |
4 | from tests.utils import requires_python_version
5 |
6 |
7 | class TestImportHook(unittest.TestCase):
8 | @requires_python_version(3.5)
9 | def test_should_trace(self):
10 | from birdseye.import_hook import should_trace
11 | deep, trace_stmt = should_trace('import birdseye.trace_module')
12 | self.assertFalse(deep)
13 | self.assertIsNotNone(trace_stmt)
14 |
15 | deep, trace_stmt = should_trace('import birdseye.trace_module_deep')
16 | self.assertTrue(deep)
17 | self.assertIsNotNone(trace_stmt)
18 |
19 | deep, trace_stmt = should_trace('from birdseye import trace_module_deep, eye')
20 | self.assertTrue(deep)
21 | self.assertIsNotNone(trace_stmt)
22 |
23 | deep, trace_stmt = should_trace('from birdseye import trace_module, eye')
24 | self.assertFalse(deep)
25 | self.assertIsNotNone(trace_stmt)
26 |
27 | deep, trace_stmt = should_trace('from birdseye import eye')
28 | self.assertFalse(deep)
29 | self.assertIsNone(trace_stmt)
30 |
31 |
32 | if __name__ == '__main__':
33 | unittest.main()
34 |
--------------------------------------------------------------------------------
/birdseye/__init__.py:
--------------------------------------------------------------------------------
1 | import sys
2 | from importlib import import_module
3 |
4 | try:
5 | from .version import __version__
6 | except ImportError: # pragma: no cover
7 | # version.py is auto-generated with the git tag when building
8 | __version__ = "???"
9 |
10 |
11 | # birdseye has so many dependencies that simply importing them can be quite slow
12 | # Sometimes you just want to leave an import sitting around without actually using it
13 | # These proxies ensure that if you do, program startup won't be slowed down
14 | # In a nutshell:
15 | # from birdseye import eye
16 | # is a lazy version of
17 | # from birdseye.bird import eye
18 |
19 | class _SimpleProxy(object):
20 | def __init__(self, val):
21 | object.__setattr__(self, '_SimpleProxy__val', val)
22 |
23 | def __call__(self, *args, **kwargs):
24 | return self.__val()(*args, **kwargs)
25 |
26 | def __getattr__(self, item):
27 | return getattr(self.__val(), item)
28 |
29 | def __setattr__(self, key, value):
30 | setattr(self.__val(), key, value)
31 |
32 |
33 | eye = _SimpleProxy(lambda: import_module('birdseye.bird').eye)
34 | BirdsEye = _SimpleProxy(lambda: import_module('birdseye.bird').BirdsEye)
35 |
36 |
37 | def load_ipython_extension(ipython_shell):
38 | from birdseye.ipython import BirdsEyeMagics
39 | ipython_shell.register_magics(BirdsEyeMagics)
40 |
41 |
42 | if sys.version_info.major == 3:
43 | from birdseye.import_hook import BirdsEyeFinder
44 |
45 | sys.meta_path.insert(0, BirdsEyeFinder())
46 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | name = birdseye
3 | author = Alex Hall
4 | author_email = alex.mojaki@gmail.com
5 | license = MIT
6 | description = Graphical Python debugger which lets you easily view the values of all evaluated expressions
7 | url = http://github.com/alexmojaki/birdseye
8 | long_description = file: README.rst
9 | long_description_content_type = text/x-rst
10 | classifiers =
11 | Intended Audience :: Developers
12 | Programming Language :: Python
13 | Programming Language :: Python :: 3
14 | Programming Language :: Python :: 3.8
15 | Programming Language :: Python :: 3.9
16 | Programming Language :: Python :: 3.10
17 | Programming Language :: Python :: 3.11
18 | Programming Language :: Python :: 3.12
19 | Programming Language :: Python :: 3.13
20 | License :: OSI Approved :: MIT License
21 | Operating System :: OS Independent
22 | Topic :: Software Development :: Debuggers
23 |
24 | [options]
25 | packages = birdseye
26 | install_requires =
27 | Flask
28 | flask-humanize
29 | sqlalchemy
30 | asttokens
31 | littleutils>=0.2
32 | cheap_repr
33 | outdated
34 | cached_property
35 |
36 | setup_requires = setuptools>=44; wheel; setuptools_scm[toml]>=3.4.3
37 | python_requires = >=3.8
38 | include_package_data = True
39 |
40 | test_suite = tests
41 |
42 | [options.extras_require]
43 | tests =
44 | bs4
45 | selenium
46 | pytest
47 | numpy
48 | pandas
49 | gunicorn
50 | twine
51 | build
52 | django
53 | IPython
54 |
55 | [options.entry_points]
56 | console_scripts =
57 | birdseye = birdseye.server:main
58 |
--------------------------------------------------------------------------------
/docs/limitations.rst:
--------------------------------------------------------------------------------
1 | Performance and limitations
2 | --------------------------------------------
3 |
4 | Every function call is recorded, and every nontrivial expression is
5 | traced. This means that:
6 |
7 | - Programs are greatly slowed down, and you should be wary of tracing
8 | functions that are called many times or that run through many loop
9 | iterations. Note that function calls are not visible in the interface
10 | until they have been completed.
11 | - A large amount of data may be collected for every function call,
12 | especially for functions with many loop iterations and large nested
13 | objects and data structures. This may be a problem for memory both
14 | when running the program and viewing results in your browser.
15 | - To limit the amount of data saved, only a sample is stored.
16 | Specifically:
17 |
18 | - The first and last 3 iterations of loops, except if an expression
19 | or statement is only evaluated at some point in the middle of a
20 | loop, in which case up to two iterations where it was evaluated
21 | will also be included (see :ref:`middle-of-loop`).
22 | - A limited version of the ``repr()`` of values is used, provided by
23 | the `cheap_repr`_ package.
24 | - Nested data structures and objects can only be expanded by up to 3
25 | levels. Inside loops this is decreased, except when all current loops
26 | are in their first iteration.
27 | - Only pieces of objects are recorded - see :ref:`collecting-data`.
28 |
29 | In IPython shells and notebooks, ``shell.ast_transformers`` is ignored
30 | in decorated functions.
31 |
32 | .. _cheap_repr: https://github.com/alexmojaki/cheap_repr
33 |
--------------------------------------------------------------------------------
/birdseye/templates/file.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block body %}
3 | {% if is_ipython %}
4 |
9 |
10 |
11 |
12 | {{ short_path }}
5 | {% else %} 6 |File: {{ short_path }}
7 |Full path: {{ full_path }}
8 | {% endif %} 9 | 10 | {% from 'info_panel.html' import info_panel %} 11 | 12 | {% call info_panel() %} 13 |Click on a function name to view calls to that function.
14 |Click on the icon 15 | to view the most recent call to that function.
16 | {% endcall %} 17 | 18 |19 | 20 | {% if funcs.module %} 21 | {% set func = funcs.module[0] %} 22 | 23 | 24 | 25 | 27 | Execution of module 28 | 29 | {% endif %} 30 | 31 | {% if funcs.function %} 32 |
Functions:
33 |-
34 | {% for func in funcs.function %}
35 |
- 36 | {% if func.id %} 37 | 38 | 39 | 40 | {% endif %} 41 | 43 | {{ func.name }} 44 | 45 | 46 | {% endfor %} 47 |
Click on a file to view all the functions in that file (some of which may not be listed here).
9 |Click on a function name to view calls to that function.
10 |Click on the icon 11 | to view the most recent call to that function.
12 | {% else %} 13 |You haven't traced any functions! Decorate a function with @eye to get started:
15 | from birdseye import eye 16 | 17 | @eye 18 | def foo():19 |
Read more documentation 20 | here. 21 |
22 | 23 | 24 | 27 | {% endif %} 28 | {% endcall %} 29 | 30 |-
31 | {% for full, calls in files.items() %}
32 |
-
33 |
34 |
35 | {{ short(full) }}
36 |
37 | {% if calls %}
38 |
-
39 | {% for (func_name, row) in calls.items() %}
40 |
- 41 | 42 | 43 | 44 | 45 | {% if row.type == 'function' %} 46 | {{ func_name }} 47 | {% elif row.type == 'class' %} 48 | class {{ func_name }} 49 | {% else %} 50 | Execution of module 51 | {% endif %} 52 | 53 | 54 | {% endfor %} 55 |
58 | {% endfor %}
59 |
19 | {% if typ == 'module' %} 20 | Executions of module: 21 | {% else %} 22 | Function: 23 | {% endif %} 24 | 25 | 26 | {% if typ == 'module' %} 27 | {{ short_path }} 28 | {% else %} 29 | {{ func.name }} 30 | {% endif %} 31 | 32 |
33 | 34 |Full file path: {{ func.file }}
35 | 36 | {% if typ == 'function' %} 37 | {# if there are no calls then this may not be the most recent function object #} 38 | {% if calls %} 39 |Line: {{ func.lineno }}
40 | {% endif %} 41 | 42 |Calls:
43 | {% endif %} 44 | 45 | {% if calls %} 46 || 50 | | Start time | 51 | {% if typ == 'function' %} 52 |Arguments | 53 | {% endif %} 54 |Result | 55 |
|---|---|---|---|
| 61 | {{ call.state_icon }} 62 | | 63 |64 | {{ call.pretty_start_time }} 65 | | 66 | 67 | {% if typ == 'function' %} 68 |
69 | {% if call.arguments_list %}
70 |
|
81 | {% endif %}
82 |
83 | 84 | {{ call.result }} 85 | | 86 |
No calls yet. Is the function still running?
93 | {% endif %} 94 | {% endblock %} -------------------------------------------------------------------------------- /docs/tips.rst: -------------------------------------------------------------------------------- 1 | Tips 2 | ==== 3 | 4 | Debugging an entire file 5 | ------------------------- 6 | 7 | Instead of decorating individual functions with ``@eye``, you may want to debug *all* the functions in a module, or you may want to debug the top-level execution of the module itself without wrapping it in a function. 8 | 9 | To trace every function in the file, as well as the module execution itself, add the line:: 10 | 11 | import birdseye.trace_module_deep 12 | 13 | To trace only the module execution but none of the functions (to reduce the performance impact), leave out the ``_deep``, i.e.:: 14 | 15 | import birdseye.trace_module 16 | 17 | There are some caveats to note: 18 | 19 | #. These import statements must be unindented, not inside a block such as ``if`` or ``try``. 20 | #. If the module being traced is not the module that is being run directly, i.e. it's being imported by another module, then: 21 | #. The module will not be traced in Python 2. 22 | #. ``birdseye`` must be imported somewhere before importing the traced module. 23 | #. The execution of the entire module will be traced, not just the part after the import statement as when the traced module is run directly. 24 | 25 | Debugging functions without importing 26 | ------------------------------------- 27 | 28 | If you're working on a project with many files and you're tired of writing ``from birdseye import eye`` every time you want to debug a function, add code such as this to the entrypoint of your project:: 29 | 30 | from birdseye import eye 31 | 32 | # If you don't need Python 2/3 compatibility, 33 | # just one of these lines will do 34 | try: 35 | import __builtin__ as builtins # Python 2 36 | except ImportError: 37 | import builtins # Python 3 38 | 39 | builtins.eye = eye 40 | # or builtins.7 | {% if typ == 'module' %} 8 | Execution of module: 9 | {% else %} 10 | Call to function: 11 | {% endif %} 12 | 13 | 15 | {% if typ == 'module' %} 16 | {{ short_path }} 17 | {% else %} 18 | {{ func.name }} 19 | {% endif %} 20 | 21 |
22 | 23 | {% if typ == 'function' %} 24 |Line: {{ func.lineno }}
25 | {% endif %} 26 | 27 |Full file path: {{ func.file }}
28 | 29 | {% if typ == 'function' %} 30 | {% if call.arguments_list %} 31 |Arguments:
32 || {{ k }} | 36 |{{ v }} | 37 |
No arguments
42 | {% endif %} 43 | {% endif %} 44 | 45 |46 | Start time: {{ call.pretty_start_time }} 47 |
48 |Result: 49 | {% if call.success %} 50 | {{ call.result }}
51 | {% else %} 52 | 53 |{{ call.traceback }}
54 | {% endif %}
55 | Code:
56 | 57 | {% from 'info_panel.html' import info_panel %} 58 | 59 |
60 | {% call info_panel() %}
61 |
62 | Go to newest call
63 |
64 | {% endcall %}
65 |
66 |
67 |
105 | {% endblock %}
106 | {% block after_container %}
107 | {% include "call_core.html" %}
108 | {% endblock %}
--------------------------------------------------------------------------------
/birdseye/import_hook.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import sys
4 | from importlib.machinery import ModuleSpec
5 | from importlib.util import spec_from_loader
6 | import ast
7 | from types import ModuleType
8 | from typing import Sequence, Iterator, cast
9 |
10 |
11 | class BirdsEyeLoader:
12 | def __init__(self, spec, source, deep):
13 | self._spec = spec
14 | self.source = source
15 | self.deep = deep
16 |
17 | def create_module(self, spec):
18 | pass
19 |
20 | def exec_module(self, module):
21 | from birdseye.bird import eye
22 | eye.exec_string(
23 | source=self.source,
24 | filename=self._spec.origin,
25 | globs=module.__dict__,
26 | locs=module.__dict__,
27 | deep=self.deep,
28 | )
29 |
30 | def get_filename(self, fullname):
31 | return self._spec.loader.get_filename(fullname)
32 |
33 | def is_package(self, fullname):
34 | return self._spec.loader.is_package(fullname)
35 |
36 |
37 | class BirdsEyeFinder:
38 | """Loads a module and looks for tracing inside, only providing a loader
39 | if it finds some.
40 | """
41 |
42 | def _find_plain_specs(
43 | self, fullname: str, path: Sequence[str] | None, target: ModuleType | None
44 | ) -> Iterator[ModuleSpec]:
45 | """Yield module specs returned by other finders on `sys.meta_path`."""
46 | for finder in sys.meta_path:
47 | # Skip this finder or any like it to avoid infinite recursion.
48 | if isinstance(finder, BirdsEyeFinder):
49 | continue
50 |
51 | try:
52 | plain_spec = finder.find_spec(fullname, path, target)
53 | except Exception: # pragma: no cover
54 | continue
55 |
56 | if plain_spec:
57 | yield plain_spec
58 |
59 | def find_spec(
60 | self, fullname: str, path: Sequence[str] | None, target: ModuleType | None = None
61 | ) -> ModuleSpec | None:
62 | """This is the method that is called by the import system.
63 |
64 | It uses the other existing meta path finders to do most of the standard work,
65 | particularly finding the module's source code.
66 | If it finds a module spec, it returns a new spec that uses the BirdsEyeLoader.
67 | """
68 | for plain_spec in self._find_plain_specs(fullname, path, target):
69 | # Not all loaders have get_source, but it's an abstract method of the standard ABC InspectLoader.
70 | # In particular it's implemented by `importlib.machinery.SourceFileLoader`
71 | # which is provided by default.
72 | get_source = getattr(plain_spec.loader, 'get_source', None)
73 | if not callable(get_source): # pragma: no cover
74 | continue
75 |
76 | try:
77 | source = cast(str, get_source(fullname))
78 | except Exception: # pragma: no cover
79 | continue
80 |
81 | if not source:
82 | continue
83 |
84 | if "birdseye" not in source:
85 | return None
86 |
87 | deep, trace_stmt = should_trace(source)
88 |
89 | if not trace_stmt:
90 | return None
91 |
92 | loader = BirdsEyeLoader(plain_spec, source, deep)
93 | return spec_from_loader(fullname, loader)
94 |
95 |
96 | def should_trace(source):
97 | trace_stmt = None
98 | deep = False
99 | for stmt in ast.parse(source).body:
100 | if isinstance(stmt, ast.Import):
101 | for alias in stmt.names:
102 | if alias.name.startswith('birdseye.trace_module'):
103 | trace_stmt = stmt
104 | if alias.name.endswith('deep'):
105 | deep = True
106 |
107 | if isinstance(stmt, ast.ImportFrom) and stmt.module == 'birdseye':
108 | for alias in stmt.names:
109 | if alias.name.startswith('trace_module'):
110 | trace_stmt = stmt
111 | if alias.name.endswith('deep'):
112 | deep = True
113 | return deep, trace_stmt
114 |
--------------------------------------------------------------------------------
/birdseye/ipython.py:
--------------------------------------------------------------------------------
1 | import inspect
2 | import socket
3 | import sys
4 | from io import BytesIO, StringIO
5 | from threading import currentThread, Thread
6 | from uuid import uuid4
7 |
8 | from IPython.core.display import HTML, display
9 | from IPython.core.magic import Magics, cell_magic, magics_class
10 | from jinja2 import Environment, PackageLoader, select_autoescape
11 | from traitlets import Unicode, Int, Bool
12 | from werkzeug.local import LocalProxy
13 |
14 | from birdseye.bird import PY2, Database
15 | from birdseye import server, eye
16 |
17 | try:
18 | from werkzeug.serving import ThreadingMixIn
19 | except ImportError:
20 | from socketserver import ThreadingMixIn
21 |
22 | fake_stream = BytesIO if PY2 else StringIO
23 |
24 | thread_proxies = {}
25 |
26 |
27 | def stream_proxy(original):
28 | def p():
29 | frame = inspect.currentframe()
30 | while frame:
31 | if frame.f_code == ThreadingMixIn.process_request_thread.__code__:
32 | return fake_stream()
33 | frame = frame.f_back
34 | return thread_proxies.get(currentThread().ident,
35 | original)
36 |
37 | return LocalProxy(p)
38 |
39 |
40 | sys.stderr = stream_proxy(sys.stderr)
41 | sys.stdout = stream_proxy(sys.stdout)
42 |
43 |
44 | def run_server(port, bind_host, show_server_output):
45 | if not show_server_output:
46 | thread_proxies[currentThread().ident] = fake_stream()
47 | try:
48 | server.app.run(
49 | debug=True,
50 | port=port,
51 | host=bind_host,
52 | use_reloader=False,
53 | )
54 | except socket.error:
55 | pass
56 |
57 |
58 | templates_env = Environment(
59 | loader=PackageLoader('birdseye', 'templates'),
60 | autoescape=select_autoescape(['html', 'xml'])
61 | )
62 |
63 |
64 | @magics_class
65 | class BirdsEyeMagics(Magics):
66 | server_url = Unicode(
67 | u'', config=True,
68 | help='If set, a server will not be automatically started by %%eye. '
69 | 'The iframe containing birdseye output will use this value as the base '
70 | 'of its URL.'
71 | )
72 |
73 | port = Int(
74 | 7777, config=True,
75 | help='Port number for the server started by %%eye.'
76 | )
77 |
78 | bind_host = Unicode(
79 | '127.0.0.1', config=True,
80 | help='Host that the server started by %%eye listens on. '
81 | 'Set to 0.0.0.0 to make it accessible anywhere.'
82 | )
83 |
84 | show_server_output = Bool(
85 | False, config=True,
86 | help='Set to True to show stdout and stderr from the server started by %%eye.'
87 | )
88 |
89 | db_url = Unicode(
90 | u'', config=True,
91 | help='The database URL that the server started by %%eye reads from. '
92 | 'Equivalent to the environment variable BIRDSEYE_DB.'
93 | )
94 |
95 | @cell_magic
96 | def eye(self, _line, cell):
97 | if not self.server_url:
98 | server.db = Database(self.db_url)
99 | server.Function = server.db.Function
100 | server.Call = server.db.Call
101 | server.Session = server.db.Session
102 | Thread(
103 | target=run_server,
104 | args=(
105 | self.port,
106 | self.bind_host,
107 | self.show_server_output,
108 | ),
109 | ).start()
110 |
111 | eye.db = Database(self.db_url)
112 |
113 | def callback(call_id):
114 | """
115 | Always executes after the cell, whether or not an exception is raised
116 | in the user code.
117 | """
118 | if call_id is None: # probably means a bug
119 | return
120 |
121 | html = HTML(templates_env.get_template('ipython_iframe.html').render(
122 | call_id=call_id,
123 | url=self.server_url.rstrip('/'),
124 | port=self.port,
125 | container_id=uuid4().hex,
126 | ))
127 |
128 | # noinspection PyTypeChecker
129 | display(html)
130 |
131 | value = eye.exec_ipython_cell(cell, callback)
132 | # Display the value as would happen if the %eye magic wasn't there
133 | return value
134 |
--------------------------------------------------------------------------------
/misc/mypy_ignore.txt:
--------------------------------------------------------------------------------
1 | error: "AST" has no attribute "_depth"
2 | error: "AST" has no attribute "_loops"
3 | error: "AST" has no attribute "_tree_index"
4 | error: "AST" has no attribute "first_token"
5 | error: "AST" has no attribute "parent"
6 | error: "FrameInfo" has no attribute "arguments"
7 | error: "FrameInfo" has no attribute "call_id"
8 | error: "FrameInfo" has no attribute "inner_call"
9 | error: "FrameInfo" has no attribute "iteration"
10 | error: "FrameInfo" has no attribute "start_time"
11 | error: "FunctionType" has no attribute "traced_file"
12 | error: "TracedFile" has no attribute "tokens"
13 | error: "Type[Base]" has no attribute "metadata"
14 | error: "comprehension" has no attribute "first_token"
15 | error: "comprehension" has no attribute "parent"
16 | error: "expr" has no attribute "_is_interesting_expression"
17 | error: "expr" has no attribute "_loops"
18 | error: "expr" has no attribute "ctx"
19 | error: "expr" has no attribute "parent"
20 | error: "generic_visit" of "NodeTransformer" does not return a value
21 | error: "stmt" has no attribute "_loops"
22 | error: "stmt" has no attribute "parent"
23 | error: Argument 1 to "partial" has incompatible type "function"; expected "Callable[...,
38 |
39 |
40 |
41 |
42 |
81 |
82 |
83 |
84 |
--------------------------------------------------------------------------------
/birdseye/static/css/main.css:
--------------------------------------------------------------------------------
1 | .box {
2 | position: relative;
3 | display: inline-block;
4 | padding: 3px 8px;
5 | border: 1px solid lightgrey;
6 | border-radius: 4px;
7 | }
8 |
9 | .box.has-inner {
10 | padding-right: 12px;
11 | }
12 |
13 | .box.has_value {
14 | border-color: grey;
15 | }
16 |
17 | .box.selected {
18 | padding: 1px 6px;
19 | border: 3px solid #ccc;
20 | }
21 |
22 | .box.selected.has_value {
23 | border-color: #2822ab;
24 | }
25 |
26 | .box.has_value.value_none {
27 | border-style: dashed;
28 | }
29 |
30 | .box.has_value.exception_node, .box.has_value.selected.exception_node {
31 | padding: 1px 6px;
32 | border: 3px solid red;
33 | }
34 |
35 | .box.hovering {
36 | background-color: #c1fdff;
37 | }
38 |
39 | #bottom_panel {
40 | position: fixed !important;
41 | bottom: 0 !important;
42 | margin: 0;
43 | width: 100%;
44 | }
45 |
46 | #box_value, #inspector {
47 | border: 1px solid lightgrey;
48 | margin: 0;
49 | padding: 10px;
50 | border-radius: 0;
51 | background: white;
52 | }
53 |
54 | #inspector {
55 | height: 12em;
56 | overflow: auto;
57 | }
58 |
59 | #resize-handle {
60 | background-color: lightgrey;
61 | height: 10px;
62 | width: 100%;
63 | cursor: ns-resize;
64 | background-repeat: no-repeat;
65 | background-position: center;
66 | }
67 |
68 | #box_value {
69 | max-height: 5.7em;
70 | overflow: hidden;
71 | }
72 |
73 | .flex-container {
74 | display: flex;
75 | width: 100%;
76 | }
77 |
78 | #arrows-holder {
79 | width: 100px;
80 | height: 100px;
81 | display: inline-block;
82 | position: relative;
83 | }
84 |
85 | #code {
86 | flex-grow: 1;
87 | display: inline-block;
88 | margin-bottom: 40em;
89 | overflow: visible;
90 | }
91 |
92 | .code-font, #inspector ul li.jstree-node {
93 | font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
94 | }
95 |
96 | .call-row a {
97 | display: block;
98 | }
99 |
100 | .args-table tr td:first-child {
101 | max-width: 20em;
102 | }
103 |
104 | .loop-label {
105 | pointer-events: none;
106 | }
107 |
108 | .loop-navigator > button, .loop-navigator > .btn-group {
109 | float: none !important;
110 | }
111 |
112 | .jstree-proton .jstree-icon.jstree-themeicon-custom {
113 | margin-right: 8px;
114 | }
115 |
116 | #code span span.stmt_uncovered,
117 | #code span span.stmt_uncovered span[class^="hljs-"] {
118 | color: #b3b3b3;
119 | font-weight: normal;
120 | }
121 |
122 | .inner-call {
123 | position: absolute;
124 | right: 0;
125 | }
126 |
127 | .inner-call .glyphicon {
128 | transform: rotate(45deg);
129 | }
130 |
131 | body > .container {
132 | margin-left: 100px;
133 | }
134 |
135 | .jstree-anchor .inspector-value {
136 | display: inline-block;
137 | white-space: pre;
138 | vertical-align: top;
139 | }
140 |
141 | #inspector .jstree-anchor {
142 | height: auto;
143 | }
144 |
145 | table.dataframe.table {
146 | width: auto;
147 | font-size: 9pt;
148 | margin: 5px;
149 | border: 2px solid black;
150 | }
151 |
152 | table.dataframe td.numeric {
153 | text-align: right;
154 | }
155 |
156 | .table-striped > tbody > tr:nth-of-type(odd) {
157 | background-color: #f5f5f5;
158 | }
159 |
160 | .table-striped.table-hover > tbody > tr:hover {
161 | background-color: rgba(66, 165, 245, 0.2);
162 | }
163 |
164 | /* Based on https://bootsnipp.com/snippets/949K6 */
165 | .panel.panel-info {
166 | position: relative;
167 | /*
168 | Shrink to fit text:
169 | https://stackoverflow.com/a/3917059/2482744
170 | */
171 | display: inline-block;
172 | }
173 |
174 | .panel-leftheading {
175 | width: 34px;
176 | text-align: center;
177 | border-right: 1px solid transparent;
178 | border-bottom: 1px solid transparent;
179 | float: left;
180 | height: 100%;
181 | position: absolute;
182 | /*
183 | Center text vertically:
184 | https://stackoverflow.com/a/13515693/2482744
185 | */
186 | display: flex;
187 | justify-content: center;
188 | align-content: center;
189 | flex-direction: column;
190 | }
191 |
192 | .panel-leftheading > .glyphicon {
193 | font-size: 160%;
194 | }
195 |
196 | .panel-rightbody {
197 | float: left;
198 | margin-left: 45px;
199 | padding: 15px;
200 | }
201 |
202 | .panel-info > .panel-leftheading {
203 | color: #31708f;
204 | background-color: #d9edf7;
205 | border-color: #bce8f1;
206 | }
207 |
208 | .no-bullet {
209 | list-style-type: none;
210 | }
211 |
212 | #new-call {
213 | display: none;
214 | position: fixed;
215 | top: 0;
216 | right: 0;
217 | transform-origin: top right;
218 | transform: scale(1);
219 | }
220 |
221 | #new-call.animate {
222 | animation: size-bounce 0.5s;
223 | }
224 |
225 | @keyframes size-bounce {
226 | 0% {
227 | transform: scale(1);
228 | }
229 | 50% {
230 | transform: scale(1.2);
231 | }
232 | 100% {
233 | transform: scale(1);
234 | }
235 | }
--------------------------------------------------------------------------------
/birdseye/utils.py:
--------------------------------------------------------------------------------
1 | import ast
2 | import json
3 | import linecache
4 | import ntpath
5 | import os
6 | import sys
7 | import token
8 |
9 | from littleutils import strip_required_prefix
10 |
11 | from typing import Union, List, Any, Iterator, Tuple, Iterable
12 |
13 |
14 | PYPY = 'pypy' in sys.version.lower()
15 | IPYTHON_FILE_PATH = 'IPython notebook or shell'
16 | FILE_SENTINEL_NAME = '$$__FILE__$$'
17 |
18 |
19 | def path_leaf(path):
20 | # type: (str) -> str
21 | # http://stackoverflow.com/a/8384788/2482744
22 | head, tail = ntpath.split(path)
23 | return tail or ntpath.basename(head)
24 |
25 |
26 | def common_ancestor(paths):
27 | # type: (List[str]) -> str
28 | """
29 | Returns a path to a directory that contains all the given absolute paths
30 | """
31 | prefix = os.path.commonprefix(paths)
32 |
33 | # Ensure that the prefix doesn't end in part of the name of a file/directory
34 | prefix = ntpath.split(prefix)[0]
35 |
36 | # Ensure that it ends with a slash
37 | first_char_after = paths[0][len(prefix)]
38 | if first_char_after in r'\/':
39 | prefix += first_char_after
40 |
41 | return prefix
42 |
43 |
44 | def short_path(path, all_paths):
45 | # type: (str, List[str]) -> str
46 | if path == IPYTHON_FILE_PATH:
47 | return path
48 |
49 | all_paths = [f for f in all_paths
50 | if f != IPYTHON_FILE_PATH]
51 | prefix = common_ancestor(all_paths)
52 | if prefix in r'\/':
53 | prefix = ''
54 | return strip_required_prefix(path, prefix) or path_leaf(path)
55 |
56 |
57 | def fix_abs_path(path):
58 | if path == IPYTHON_FILE_PATH:
59 | return path
60 | if os.path.sep == '/' and not path.startswith('/'):
61 | path = '/' + path
62 | return path
63 |
64 |
65 | def of_type(type_or_tuple, iterable):
66 | # type: (Union[type, Tuple[Union[type, tuple], ...]], Iterable[Any]) -> Iterator[Any]
67 | return (x for x in iterable if isinstance(x, type_or_tuple))
68 |
69 |
70 | def one_or_none(expression):
71 | """Performs a one_or_none on a sqlalchemy expression."""
72 | if hasattr(expression, 'one_or_none'):
73 | return expression.one_or_none()
74 | result = expression.all()
75 | if len(result) == 0:
76 | return None
77 | elif len(result) == 1:
78 | return result[0]
79 | else:
80 | raise Exception("There is more than one item returned for the supplied filter")
81 |
82 |
83 | def flatten_list(lst):
84 | result = []
85 | for x in lst:
86 | if isinstance(x, list):
87 | result.extend(flatten_list(x))
88 | else:
89 | result.append(x)
90 | return result
91 |
92 |
93 | def is_lambda(f):
94 | try:
95 | code = f.__code__
96 | except AttributeError:
97 | return False
98 | return code.co_name == (lambda: 0).__code__.co_name
99 |
100 |
101 | class ProtocolEncoder(json.JSONEncoder):
102 | def default(self, o):
103 | try:
104 | method = o.as_json
105 | except AttributeError:
106 | return super(ProtocolEncoder, self).default(o)
107 | else:
108 | return method()
109 |
110 |
111 | def read_source_file(filename):
112 | lines = linecache.getlines(filename)
113 | return ''.join(lines)
114 |
115 |
116 | def source_without_decorators(tokens, function_node):
117 | def_token = tokens.find_token(function_node.first_token, token.NAME, 'def')
118 | startpos = def_token.startpos
119 | source = tokens.text[startpos:function_node.last_token.endpos].rstrip()
120 | assert source.startswith('def')
121 |
122 | return startpos, source
123 |
124 |
125 | def prn(*args):
126 | for arg in args:
127 | print(arg)
128 | if len(args) == 1:
129 | return args[0]
130 | return args
131 |
132 |
133 | def is_ipython_cell(filename):
134 | return filename.startswith('":I.tabReplace?n.replace(/\t/g,I.tabReplace):""}):e}function h(e,n,t){var r=n?L[n]:t,a=[e.trim()];return e.match(/\bhljs\b/)||a.push("hljs"),-1===e.indexOf(r)&&a.push(r),a.join(" ").trim()}function d(e){var n,t,r,o,l,s=i(e);a(s)||(I.useBR?(n=document.createElementNS("http://www.w3.org/1999/xhtml","div"),n.innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
' + _.escape(val[0]) + '
';
62 | var type_index = val[1];
63 | var type_name = call_data.type_names[type_index];
64 | var is_special = type_index < call_data.num_special_types;
65 |
66 | function special(name) {
67 | return is_special && type_name === name;
68 | }
69 |
70 | var text = _.escape(prefix) + (type_index < 0 ? ' : ' : ' = ');
71 | if (type_index === -2) {
72 | text += '' + normal_stmt_value + '';
73 | } else {
74 | if (special('NoneType')) {
75 | text += 'None';
76 | } else if (type_index === -1) { // exception
77 | text += '' + val_repr + '';
78 | } else if (val[2].dataframe && val[3] && (val[3][1].length > 4)) {
79 | var table = dataframeTable(val);
80 | text += table[0].outerHTML
81 | } else {
82 | text += '' + _.escape(type_name) + ': ' + val_repr;
83 | }
84 | }
85 |
86 | var icon;
87 | if (special('bool')) {
88 | icon = 'glyphicon glyphicon-' + (val[0] === 'True' ? 'ok' : 'remove');
89 | } else if (type_index === -1) {
90 | icon = 'glyphicon glyphicon-warning-sign';
91 | } else if (type_index === -2) {
92 | icon = 'glyphicon glyphicon-ok';
93 | } else {
94 | icon = static_url + 'img/type_icons/';
95 | if (is_special) {
96 | if ('str NoneType complex float int list tuple dict set'.indexOf(type_name) > -1) {
97 | icon += type_name;
98 | } else {
99 | icon += {
100 | unicode: 'str',
101 | bytes: 'str',
102 | frozenset: 'set',
103 | long: 'int',
104 | }[type_name];
105 | }
106 | } else {
107 | icon += 'object';
108 | }
109 | icon += '.png';
110 | }
111 |
112 | var result = {
113 | text: text,
114 | icon: icon,
115 | path: path,
116 | $node: $node,
117 | state: {
118 | opened: _.deepContains(open_paths, path),
119 | }
120 | };
121 |
122 | var children = [];
123 | var len = val[2].len;
124 | if (len !== undefined && !(len === 0 && is_special)) {
125 | children.push({
126 | icon: false,
127 | text: 'len() = ' + len,
128 | });
129 | }
130 |
131 | $.merge(children, val.slice(3).map(function (child) {
132 | return make_jstree_nodes(child[0], path.concat([child[0]]), child[1]);
133 | }));
134 |
135 | if (children.length) {
136 | result.children = children;
137 | }
138 |
139 | return result;
140 | }
141 |
142 | function dataframeTable(val) {
143 | var meta = val[2].dataframe;
144 | var numCols = val.length - 3;
145 | var numRows = val[3][1].length - 4;
146 | var i, j, value, column;
147 | var table = $('| ')); 150 | table.append(header); 151 | var rows = []; 152 | for (i = 0; i < numRows; i++) { 153 | var row; 154 | if (i === meta.row_break) { 155 | row = $(' | ||||
|---|---|---|---|---|
| ') 158 | .text('...') 159 | .css({'text-align': 'center'})); 160 | } 161 | table.append(row); 162 | } 163 | row = $(' | ||||
| ').text(label)); 169 | } 170 | for (i = 0; i < numCols; i++) { 171 | if (i === meta.col_break) { 172 | header.append($(' | ').text('...')); 173 | } 174 | column = val[3 + i]; 175 | header.append($(' | ').text(column[0])); 176 | var values = []; 177 | var isNumeric = true; 178 | var maxDecimals = 1; 179 | for (j = 0; j < numRows; j++) { 180 | value = column[1][4 + j][1][0]; 181 | values.push(value); 182 | isNumeric &= !isNaN(parseFloat(value)) || value.toLowerCase() === 'nan'; 183 | var decimals = value.split(".")[1]; 184 | if (decimals) { 185 | maxDecimals = Math.max(maxDecimals, decimals.length); 186 | } 187 | } 188 | for (j = 0; j < numRows; j++) { 189 | if (i === meta.col_break) { 190 | rows[j].append($(' | ').text('...')); 191 | } 192 | value = values[j]; 193 | if (isNumeric) { 194 | value = parseFloat(value).toFixed(Math.min(maxDecimals, 6)); 195 | } 196 | rows[j].append($(' | ').text(value).toggleClass('numeric', isNumeric));
197 | }
198 | }
199 | return table;
200 | }
201 |
202 | var open_paths = [];
203 |
204 | $('#inspector').jstree({
205 | core: {
206 | themes: {
207 | name: 'proton',
208 | responsive: true
209 | }
210 | },
211 | }).on("hover_node.jstree dehover_node.jstree", function (e, data) {
212 | var $node = data.node.original.$node;
213 | if (!$node) {
214 | return;
215 | }
216 | var hovering = e.type === 'hover_node';
217 | $node.toggleClass('hovering', hovering);
218 | }).on("open_node.jstree", function (e, data) {
219 | var path = data.node.original.path;
220 | if (!_(open_paths).deepContains(path)) {
221 | open_paths.push(path);
222 | }
223 | }).on("close_node.jstree", function (e, data) {
224 | var path = data.node.original.path;
225 | while (_(open_paths).deepContains(path)) {
226 | var index = _.findIndex(open_paths, _.partial(_.isEqual, path));
227 | open_paths.splice(index, 1);
228 | }
229 | });
230 |
231 | $code.find('span[data-index]').each(function () {
232 | var $this = $(this);
233 | var tree_index = this.dataset.index;
234 | var json = JSON.stringify(node_values[tree_index]) || '';
235 | $this.toggleClass('box', tree_index in node_values && !(
236 | // This is a statement/comprehension node that never encounters an exception,
237 | // or has any metadata, so it never has a 'value' worth checking.
238 | ($this.hasClass('stmt') || $this.hasClass('loop')) &&
239 | -1 === json.indexOf('-1') &&
240 | -1 === json.indexOf('inner_call')));
241 | $this.toggleClass(
242 | 'has-inner',
243 | json.indexOf('"inner_calls":["') !== -1);
244 | $this.click(function () {
245 | if ($this.hasClass('hovering')) {
246 | $this.toggleClass('selected');
247 | selected_boxes = _.toggle(selected_boxes, tree_index);
248 | }
249 | render();
250 | });
251 | index_to_node[tree_index] = this;
252 | });
253 |
254 | function render() {
255 |
256 | $('#inspector, #resize-handle').css({display: selected_boxes.length ? 'block' : 'none'});
257 |
258 | var loop_indices = {};
259 |
260 | function findRanges(iters) {
261 | if (!iters) {
262 | return;
263 | }
264 | Object.keys(iters).forEach(function (key) {
265 | var value = iters[key];
266 | loop_indices[key] = _.pluck(value, 'index');
267 | findRanges(value[current_iteration(key)].loops);
268 | });
269 | }
270 |
271 | function current_iteration(i) {
272 | if (!(i in loop_indices)) {
273 | return -1;
274 | }
275 | return Math.min(_current_iteration[i], loop_indices[i].length - 1);
276 | }
277 |
278 | findRanges(loop_iterations);
279 |
280 | function get_value(tree_index) {
281 | var value = node_values[tree_index];
282 | var loops = node_loops[tree_index] || [];
283 | loops.forEach(function (loopIndex) {
284 | if (value) {
285 | value = value[current_iteration(loopIndex)];
286 | }
287 | });
288 | return value;
289 | }
290 |
291 | $code.find('span[data-index]').each(
292 | function () {
293 | var value;
294 | var $this = $(this);
295 | var tree_index = this.dataset.index;
296 | if (tree_index in node_values) {
297 | value = get_value(tree_index);
298 | }
299 | $this.toggleClass('has_value', Boolean(value));
300 | $this.toggleClass('stmt_uncovered', $this.hasClass('stmt') && !value);
301 |
302 | if (value && $this.hasClass('box')) {
303 | $this.on('mouseover mouseout', function (e) {
304 | var hovering = e.type === 'mouseover';
305 | $this.toggleClass('hovering', hovering);
306 | if (hovering) {
307 | if (value[1] === -2) {
308 | value[0] = normal_stmt_value;
309 | }
310 | $('#box_value').text(value[0]);
311 | }
312 | e.stopPropagation();
313 | });
314 | $this.toggleClass('exception_node', value[1] === -1);
315 | $this.toggleClass('value_none', value[1] === 0 || value[1] === -2);
316 | $this.children('a.inner-call').remove();
317 |
318 | var inner_calls = value[2].inner_calls || [];
319 | var place_link = function (inner_call, css) {
320 | var link = $('' +
321 | '' +
322 | '')
323 | .css(css);
324 | $this.append(link);
325 | };
326 | if (inner_calls.length === 1) {
327 | place_link(inner_calls[0], {bottom: '-4px'});
328 | } else if (inner_calls.length >= 2) {
329 | place_link(inner_calls[0], {top: 0});
330 | place_link(inner_calls[inner_calls.length - 1], {bottom: '-4px'});
331 | }
332 | } else {
333 | $this.off('mouseover mouseout');
334 | }
335 | }
336 | );
337 |
338 | var inspector = $('#inspector');
339 | inspector.jstree(true).settings.core.data = selected_boxes.map(function (tree_index) {
340 | var node = index_to_node[tree_index];
341 | var $node = $(node);
342 | var value = get_value(tree_index);
343 | return make_jstree_nodes($node.text(), [tree_index], value, $node);
344 | });
345 | inspector.jstree(true).refresh();
346 |
347 | $('.loop-navigator').remove();
348 |
349 | $code.find('.loop').each(function (_, loop_span) {
350 |
351 | var loopIndex = loop_span.dataset.index;
352 |
353 | var buttonGroup = $(' ', {
354 | class: "btn-group loop-navigator",
355 | role: "group",
356 | }).css({
357 | position: 'absolute',
358 | top: $(loop_span).offset().top - $code.offset().top,
359 | right: '5px',
360 | });
361 |
362 | function mkButton(cls, disabled, html, onclick) {
363 | var attrs = {
364 | type: 'button',
365 | class: 'btn btn-default btn-xs ' + cls,
366 | html: html,
367 | };
368 | if (disabled) {
369 | attrs.disabled = 'disabled';
370 | }
371 | if (cls === 'dropdown-toggle') {
372 | attrs['data-toggle'] = 'dropdown';
373 | }
374 | var button = $(' |